zephyr/include/init.h

114 lines
3.4 KiB
C

/*
* Copyright (c) 2015 Intel Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef _INIT_H_
#define _INIT_H_
#include <device.h>
#include <toolchain.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* System initialization levels. The PRE_KERNEL_1 and PRE_KERNEL_2 levels are
* executed in the kernel's initialization context, which uses the interrupt
* stack. The remaining levels are executed in the kernel's main task.
*
* PRIMARY, SECONDARY, NANOKERNEL, MICROKERNEL levels are currently deprecated
* and will be removed in the future.
*/
#define _SYS_INIT_LEVEL_PRE_KERNEL_1 0
#define _SYS_INIT_LEVEL_PRE_KERNEL_2 1
#define _SYS_INIT_LEVEL_POST_KERNEL 2
#define _SYS_INIT_LEVEL_APPLICATION 3
/* Deprecated, remove eventually */
#define _SYS_INIT_LEVEL_PRIMARY 4
#define _SYS_INIT_LEVEL_SECONDARY 5
#define _SYS_INIT_LEVEL_NANOKERNEL 6
#define _SYS_INIT_LEVEL_MICROKERNEL 7
/* Counter use to avoid issues if two or more system devices are declared
* in the same C file with the same init function
*/
#define _SYS_NAME(init_fn) _CONCAT(_CONCAT(sys_init_, init_fn), __COUNTER__)
/**
* @def SYS_INIT
*
* @brief Run an initialization function at boot at specified priority
*
* @details This macro lets you run a function at system boot.
*
* @param init_fn Pointer to the boot function to run
*
* @param level The initialization level, See DEVICE_INIT for details.
*
* @param prio Priority within the selected initialization level. See
* DEVICE_INIT for details.
*/
#define SYS_INIT(init_fn, level, prio) \
DEVICE_INIT(_SYS_NAME(init_fn), "", init_fn, NULL, NULL, level, prio)
/**
* @def SYS_INIT_PM
*
* @warning This macro is deprecated and will be removed in
* a future version, superseded by SYS_DEVICE_DEFINE.
*
* @brief Run an initialization function at boot at specified priority,
* and define functions to run at suspend/resume.
*
* @copydetails SYS_INIT
* @param device_pm_ops Pointer to power management functions.
* @param drv_name Name of this system device
*/
#ifdef CONFIG_DEVICE_POWER_MANAGEMENT
#define SYS_INIT_PM(drv_name, init_fn, device_pm_ops, level, prio) \
DEVICE_INIT_PM(_SYS_NAME(init_fn), drv_name, init_fn, device_pm_ops, \
NULL, NULL, level, prio)
#else
#define SYS_INIT_PM(drv_name, init_fn, device_pm_ops, level, prio) \
DEVICE_INIT(_SYS_NAME(init_fn), "", init_fn, NULL, NULL, level, prio)
#endif
/**
* @def SYS_DEVICE_DEFINE
*
* @brief Run an initialization function at boot at specified priority,
* and define device PM control function.
*
* @copydetails SYS_INIT
* @param pm_control_fn Pointer to device_pm_control function.
* Can be empty function (device_pm_control_nop) if not implemented.
* @param drv_name Name of this system device
*/
#define SYS_DEVICE_DEFINE(drv_name, init_fn, pm_control_fn, level, prio) \
DEVICE_DEFINE(_SYS_NAME(init_fn), drv_name, init_fn, pm_control_fn, \
NULL, NULL, level, prio, NULL)
#ifdef __cplusplus
}
#endif
#endif /* _INIT_H_ */