michaelh/zephyr
1
0
Fork 0
Code Releases Activity

kernel: add note in device.h

Browse source 
DEVICE_AND_API_INIT() is preferred over DEVICE_INIT() since
DEVICE_INIT() does not set the API struct at build time.

Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
This commit is contained in:
Andrew Boie 2018-12-03 09:04:21 -08:00 • committed by Andrew Boie
commit cf268c39a2
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
include/device.h
View file

@ -36,7 +36,10 @@ extern "C" {
* @brief Create device object and set it up for boot time initialization.
*
* @details This macro defines a device object that is automatically
* configured by the kernel during system initialization.
* configured by the kernel during system initialization. Note that
* devices set up with this macro will not be accessible from user mode
* since the API is not specified; whenever possible, use DEVICE_AND_API_INIT
* instead.
*
* @param dev_name Device name. This must be less than Z_DEVICE_MAX_NAME_LEN
* characters in order to be looked up from user mode with device_get_binding().