diff --git a/include/device.h b/include/device.h index b8ca10c3daf..6a1590e0f8d 100644 --- a/include/device.h +++ b/include/device.h @@ -60,26 +60,28 @@ struct device; -/* Static device infomation (In ROM) Per driver instance */ +/** + * @brief Static device information (In ROM) Per driver instance + * @param name name of the device + * @param init init function for the driver + * @param config_info address of driver instance config information + */ struct device_config { - /** name of the device */ char *name; - /** init function for the driver */ int (*init)(struct device *device); - /** address of driver instance config information */ void *config_info; }; -/* Runtime device structure (In memory) Per driver instance */ +/** + * @brief Runtime device structure (In memory) Per driver instance + * @param device_config Build time config information + * @param driver_api pointer to structure containing the API unctions for + * the device type. This pointer is filled in by the driver at init time. + * @param driver_data river instance data. For driver use only + */ struct device { - /** Build time config information */ struct device_config *config; - /** pointer to structure containing the API functions for the - * device type. This pointer is filled in by the driver at - * init time. - */ void *driver_api; - /** Driver instance data. For driver use only*/ void *driver_data; }; diff --git a/include/init.h b/include/init.h index 1dcb18e0a3b..530d8569f5a 100644 --- a/include/init.h +++ b/include/init.h @@ -41,13 +41,13 @@ #define MICRO_LATE 4 #define APP_EARLY 5 #define APP_LATE 6 - + /** @def __define_initconfig * * @brief Define an init object * - * @details This macro declares an init object to be placed a - * given init level section in the image. This macro not should be used + * @details This macro declares an init object to be placed in a + * given init level section in the image. This macro should not be used * directly. * * @param cfg_name Name of the config object created with