diff options
50 files changed, 722 insertions, 721 deletions
diff --git a/debugger/include/checkpoint.h b/debugger/include/checkpoint.h index 865052ba..7ad2faf2 100644 --- a/debugger/include/checkpoint.h +++ b/debugger/include/checkpoint.h @@ -85,8 +85,8 @@ void checkpoint_enable_all(void); * successfully. * \param name Name or description of the function registering. Must be less * than CHECKPOINT_NAME_LEN characters in length. - * \retval FWK_SUCCESS if operation is successful. - * \retval FWK_E_NOMEM when checkpoints limit is reached. + * \retval ::FWK_SUCCESS if operation is successful. + * \retval ::FWK_E_NOMEM when checkpoints limit is reached. * */ int32_t checkpoint_register(checkpoint_st **c, char *name); @@ -124,8 +124,8 @@ void checkpoint(checkpoint_st *c, char *file, int32_t line, char *tag); * successfully. * \param name Name or description of the function registering. Must be less * than CHECKPOINT_NAME_LEN characters in length. - * \retval FWK_SUCCESS if operation is successful. - * \retval FWK_E_NOMEM when checkpoints limit is reached. + * \retval ::FWK_SUCCESS if operation is successful. + * \retval ::FWK_E_NOMEM when checkpoints limit is reached. * */ # define checkpoint_register(c, name) \ diff --git a/framework/include/fwk_arch.h b/framework/include/fwk_arch.h index 48671ef8..ae0c182c 100644 --- a/framework/include/fwk_arch.h +++ b/framework/include/fwk_arch.h @@ -35,14 +35,14 @@ struct fwk_arch_interrupt_driver { /*! * \brief Enable interrupts. * - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_SUCCESS Operation succeeded. */ int (*global_enable)(void); /*! * \brief Disable interrupts. * - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_SUCCESS Operation succeeded. */ int (*global_disable)(void); @@ -52,8 +52,8 @@ struct fwk_arch_interrupt_driver { * \param interrupt Interrupt number. * \param [out] enabled \c true if the interrupt is enabled, else \c false. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*is_enabled)(unsigned int interrupt, bool *enabled); @@ -62,8 +62,8 @@ struct fwk_arch_interrupt_driver { * * \param interrupt Interrupt number. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*enable)(unsigned int interrupt); @@ -72,8 +72,8 @@ struct fwk_arch_interrupt_driver { * * \param interrupt Interrupt number. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*disable)(unsigned int interrupt); @@ -83,8 +83,8 @@ struct fwk_arch_interrupt_driver { * \param interrupt Interrupt number. * \param [out] pending \c true if the interrupt is pending, else \c false. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*is_pending)(unsigned int interrupt, bool *pending); @@ -93,8 +93,8 @@ struct fwk_arch_interrupt_driver { * * \param interrupt Interrupt number. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*set_pending)(unsigned int interrupt); @@ -103,8 +103,8 @@ struct fwk_arch_interrupt_driver { * * \param interrupt Interrupt number. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*clear_pending)(unsigned int interrupt); @@ -114,8 +114,8 @@ struct fwk_arch_interrupt_driver { * \param interrupt Interrupt number. * \param isr Pointer to the interrupt service routine function. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*set_isr_irq)(unsigned int interrupt, void (*isr)(void)); @@ -127,8 +127,8 @@ struct fwk_arch_interrupt_driver { * \param isr Pointer to the interrupt service routine function. * \param parameter Parameter that should be passed to the isr function. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*set_isr_irq_param)(unsigned int interrupt, void (*isr)(uintptr_t param), @@ -140,8 +140,8 @@ struct fwk_arch_interrupt_driver { * * \param isr Pointer to the NMI interrupt service routine function. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*set_isr_nmi)(void (*isr)(void)); @@ -152,8 +152,8 @@ struct fwk_arch_interrupt_driver { * \param isr Pointer to the NMI interrupt service routine function. * \param parameter Parameter that should be passed to the isr function. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*set_isr_nmi_param)(void (*isr)(uintptr_t param), uintptr_t parameter); @@ -162,8 +162,8 @@ struct fwk_arch_interrupt_driver { * * \param isr Pointer to the fault interrupt service routine function. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*set_isr_fault)(void (*isr)(void)); @@ -173,9 +173,9 @@ struct fwk_arch_interrupt_driver { * * \param [out] interrupt Interrupt number. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_STATE An interrupt is not currently being serviced. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_STATE An interrupt is not currently being serviced. */ int (*get_current)(unsigned int *interrupt); }; @@ -195,9 +195,9 @@ struct fwk_arch_init_driver { * * \param [out] driver Pointer to an interrupt driver. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM The parameter received by the handler is invalid. - * \retval FWK_E_PANIC Unrecoverable initialization error. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM The parameter received by the handler is invalid. + * \retval ::FWK_E_PANIC Unrecoverable initialization error. */ int (*interrupt)(const struct fwk_arch_interrupt_driver **driver); }; @@ -208,9 +208,9 @@ struct fwk_arch_init_driver { * \param driver Pointer to an initialization driver used to perform the * initialization. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_PANIC Unrecoverable initialization error. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_PANIC Unrecoverable initialization error. */ int fwk_arch_init(const struct fwk_arch_init_driver *driver); diff --git a/framework/include/fwk_interrupt.h b/framework/include/fwk_interrupt.h index 3d9d6d8f..b050590c 100644 --- a/framework/include/fwk_interrupt.h +++ b/framework/include/fwk_interrupt.h @@ -63,24 +63,24 @@ * * \param driver Interrupt driver instance to register * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int fwk_interrupt_init(const struct fwk_arch_interrupt_driver *driver); /*! * \brief Enable interrupts. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_global_enable(void); /*! * \brief Disable interrupts. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_global_disable(void); @@ -90,9 +90,9 @@ int fwk_interrupt_global_disable(void); * \param interrupt Interrupt number. * \param [out] enabled \c true if the interrupt is enabled, else \c false. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_is_enabled(unsigned int interrupt, bool *enabled); @@ -101,9 +101,9 @@ int fwk_interrupt_is_enabled(unsigned int interrupt, bool *enabled); * * \param interrupt Interrupt number. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_enable(unsigned int interrupt); @@ -112,9 +112,9 @@ int fwk_interrupt_enable(unsigned int interrupt); * * \param interrupt Interrupt number. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_disable(unsigned int interrupt); @@ -124,9 +124,9 @@ int fwk_interrupt_disable(unsigned int interrupt); * \param interrupt Interrupt number. * \param [out] pending \c true if the interrupt is pending, else \c false. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_is_pending(unsigned int interrupt, bool *pending); @@ -135,9 +135,9 @@ int fwk_interrupt_is_pending(unsigned int interrupt, bool *pending); * * \param interrupt Interrupt number. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_set_pending(unsigned int interrupt); @@ -146,9 +146,9 @@ int fwk_interrupt_set_pending(unsigned int interrupt); * * \param interrupt Interrupt number. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_clear_pending(unsigned int interrupt); @@ -159,9 +159,9 @@ int fwk_interrupt_clear_pending(unsigned int interrupt); * an interrupt number. * \param isr Pointer to the interrupt service routine function. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_set_isr(unsigned int interrupt, void (*isr)(void)); @@ -174,9 +174,9 @@ int fwk_interrupt_set_isr(unsigned int interrupt, void (*isr)(void)); * \param isr Pointer to the interrupt service routine function. * \param param Parameter that should be passed to the isr when it is called. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_set_isr_param(unsigned int interrupt, void (*isr)(uintptr_t param), @@ -192,10 +192,10 @@ int fwk_interrupt_set_isr_param(unsigned int interrupt, * * FWK_INTERRUPT_EXCEPTION - When the current interrupt is an * exception. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_STATE An interrupt is not currently being serviced. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_STATE An interrupt is not currently being serviced. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_get_current(unsigned int *interrupt); diff --git a/framework/include/fwk_module.h b/framework/include/fwk_module.h index 399acd8b..73d136bb 100644 --- a/framework/include/fwk_module.h +++ b/framework/include/fwk_module.h @@ -118,8 +118,8 @@ struct fwk_module { * \param element_count Number of module elements. * \param data Module-specific configuration data. * - * \retval FWK_SUCCESS The module was initialized successfully. - * \retval FWK_E_NOMEM A memory allocation failed. + * \retval ::FWK_SUCCESS The module was initialized successfully. + * \retval ::FWK_E_NOMEM A memory allocation failed. * \return One of the other module-defined error codes. */ int (*init)(fwk_id_t module_id, unsigned int element_count, @@ -144,8 +144,8 @@ struct fwk_module { * \param sub_element_count Number of sub-elements. * \param data Element-specific configuration data. * - * \retval FWK_SUCCESS The element was initialized successfully. - * \retval FWK_E_NOMEM A memory allocation failed. + * \retval ::FWK_SUCCESS The element was initialized successfully. + * \retval ::FWK_E_NOMEM A memory allocation failed. * \return One of the other module-defined error codes. */ int (*element_init)(fwk_id_t element_id, unsigned int sub_element_count, @@ -165,8 +165,8 @@ struct fwk_module { * * \param module_id Identifier of the module element. * - * \retval FWK_SUCCESS The module post-initialization was successful. - * \retval FWK_E_NOMEM A memory allocation failed. + * \retval ::FWK_SUCCESS The module post-initialization was successful. + * \retval ::FWK_E_NOMEM A memory allocation failed. * \return One of the other module-defined error codes. */ int (*post_init)(fwk_id_t module_id); @@ -195,9 +195,9 @@ struct fwk_module { * \param round Current call round, \c 0 for the first round \c 1 for * the second round. * - * \retval FWK_SUCCESS The binding was successful. - * \retval FWK_E_ACCESS At least one binding request was rejected. - * \retval FWK_E_NOMEM A memory allocation failed. + * \retval ::FWK_SUCCESS The binding was successful. + * \retval ::FWK_E_ACCESS At least one binding request was rejected. + * \retval ::FWK_E_NOMEM A memory allocation failed. * \return One of the other module-defined error codes. */ int (*bind)(fwk_id_t id, unsigned int round); @@ -220,7 +220,7 @@ struct fwk_module { * * \param id Identifier of the module or element to start. * - * \retval FWK_SUCCESS The module or element was successfully started. + * \retval ::FWK_SUCCESS The module or element was successfully started. * \return One of the other module-defined error codes. */ int (*start)(fwk_id_t id); @@ -248,9 +248,9 @@ struct fwk_module { * \param [out] api Pointer to the API implementation to be used by the * requester. * - * \retval FWK_SUCCESS The binding request was accepted by the module or + * \retval ::FWK_SUCCESS The binding request was accepted by the module or * element. - * \retval FWK_E_ACCESS The binding request was rejected by the module or + * \retval ::FWK_E_ACCESS The binding request was rejected by the module or * element. * \return One of the other module-defined error codes. */ @@ -276,7 +276,7 @@ struct fwk_module { * \param [out] resp_event The response event to the provided event if * any. * - * \retval FWK_SUCCESS The event was processed successfully. + * \retval ::FWK_SUCCESS The event was processed successfully. * \return One of the other module-defined error codes. */ int (*process_event)(const struct fwk_event *event, @@ -294,7 +294,7 @@ struct fwk_module { * \param [out] resp_event The response event to the provided event, if * any. * - * \retval FWK_SUCCESS The notification was processed successfully. + * \retval ::FWK_SUCCESS The notification was processed successfully. * \return One of the other module-defined error codes. */ int (*process_notification)(const struct fwk_event *event, @@ -494,7 +494,7 @@ bool fwk_module_is_valid_notification_id(fwk_id_t id); * * \param module_id Identifier of the module. * - * \retval FWK_E_PARAM The identifier of the module is invalid. + * \retval ::FWK_E_PARAM The identifier of the module is invalid. * \return Number of module elements. */ int fwk_module_get_element_count(fwk_id_t module_id); @@ -504,7 +504,7 @@ int fwk_module_get_element_count(fwk_id_t module_id); * * \param element_id Identifier of the element. * - * \retval FWK_E_PARAM The identifier of the element is invalid. + * \retval ::FWK_E_PARAM The identifier of the element is invalid. * \return Number of sub-elements. */ int fwk_module_get_sub_element_count(fwk_id_t element_id); @@ -542,11 +542,11 @@ const void *fwk_module_get_data(fwk_id_t id); * \param api_id Identifier of the API to return an implementation of. * \param api [out] Pointer to storage for the pointer to the API. * - * \retval FWK_SUCCESS The API was returned. - * \retval FWK_E_PARAM A least one of the identifiers is invalid. - * \retval FWK_E_STATE Call outside of the pre-runtime bind stage. - * \retval FWK_E_ACCESS The access to the API was refused. - * \retval FWK_E_HANDLER The returned API pointer is invalid (NULL). + * \retval ::FWK_SUCCESS The API was returned. + * \retval ::FWK_E_PARAM A least one of the identifiers is invalid. + * \retval ::FWK_E_STATE Call outside of the pre-runtime bind stage. + * \retval ::FWK_E_ACCESS The access to the API was refused. + * \retval ::FWK_E_HANDLER The returned API pointer is invalid (NULL). */ int fwk_module_bind(fwk_id_t target_id, fwk_id_t api_id, const void *api); diff --git a/framework/include/fwk_multi_thread.h b/framework/include/fwk_multi_thread.h index e96f8a8e..39f8cd5e 100644 --- a/framework/include/fwk_multi_thread.h +++ b/framework/include/fwk_multi_thread.h @@ -39,15 +39,15 @@ * * \param id Identifier of the module or element to create the thread for. * - * \retval FWK_SUCCESS The module/element thread was created. - * \retval FWK_E_PARAM The identifier is not a valid module or element + * \retval ::FWK_SUCCESS The module/element thread was created. + * \retval ::FWK_E_PARAM The identifier is not a valid module or element * identifier. - * \retval FWK_E_INIT The thread framework component is not initialized. - * \retval FWK_E_STATE The execution has already started, or it is not possible - * to create a thread anymore, or a thread has already been created for the - * given module or element. - * \retval FWK_E_NOMEM A memory allocation failed. - * \retval FWK_E_OS Operating system error. + * \retval ::FWK_E_INIT The thread framework component is not initialized. + * \retval ::FWK_E_STATE The execution has already started, or it is not + * possible to create a thread anymore, or a thread has already been + * created for the given module or element. + * \retval ::FWK_E_NOMEM A memory allocation failed. + * \retval ::FWK_E_OS Operating system error. */ int fwk_thread_create(fwk_id_t id); @@ -74,12 +74,12 @@ int fwk_thread_create(fwk_id_t id); * \param event Event to put into the queue for processing. Must not be \c NULL. * \param[out] resp_event The response event. Must not be \c NULL. * - * \retval FWK_SUCCESS The event was successfully processed. - * \retval FWK_E_STATE The execution is not started. - * \retval FWK_E_PARAM One or more of the parameters were invalid. - * \retval FWK_E_PARAM One or more fields in the \p event parameter were + * \retval ::FWK_SUCCESS The event was successfully processed. + * \retval ::FWK_E_STATE The execution is not started. + * \retval ::FWK_E_PARAM One or more of the parameters were invalid. + * \retval ::FWK_E_PARAM One or more fields in the \p event parameter were * invalid. - * \retval FWK_E_ACCESS The API is called from an ISR, called from the common + * \retval ::FWK_E_ACCESS The API is called from an ISR, called from the common * thread, or the event targets the calling thread. */ #ifdef BUILD_HAS_MULTITHREADING diff --git a/framework/include/fwk_notification.h b/framework/include/fwk_notification.h index 1fd410bf..8c0d264c 100644 --- a/framework/include/fwk_notification.h +++ b/framework/include/fwk_notification.h @@ -44,13 +44,13 @@ * \param source_id Notification source identifier. * \param target_id Notification target identifier. * - * \retval FWK_SUCCESS The subscription was successful. - * \retval FWK_E_INIT The notification component has not been initialized. - * \retval FWK_E_HANDLER The function was called from an interrupt handler. - * \retval FWK_E_PARAM One or more identifiers were invalid. - * \retval FWK_E_STATE The entity \p target_id has already subscribed to the + * \retval ::FWK_SUCCESS The subscription was successful. + * \retval ::FWK_E_INIT The notification component has not been initialized. + * \retval ::FWK_E_HANDLER The function was called from an interrupt handler. + * \retval ::FWK_E_PARAM One or more identifiers were invalid. + * \retval ::FWK_E_STATE The entity \p target_id has already subscribed to the * notification \p notification_id from the entity \p source_id. - * \retval FWK_E_NOMEM The maximum number of subscriptions has been reached. + * \retval ::FWK_E_NOMEM The maximum number of subscriptions has been reached. */ int fwk_notification_subscribe(fwk_id_t notification_id, fwk_id_t source_id, fwk_id_t target_id); @@ -62,11 +62,11 @@ int fwk_notification_subscribe(fwk_id_t notification_id, fwk_id_t source_id, * \param source_id Notification source identifier. * \param target_id Notification target identifier. * - * \retval FWK_SUCCESS The subscription was successfully cancelled. - * \retval FWK_E_INIT The notification component has not been initialized. - * \retval FWK_E_HANDLER The function was called from an interrupt handler. - * \retval FWK_E_PARAM One or more identifiers were invalid. - * \retval FWK_E_STATE The entity \p target_id has not subscribed to the + * \retval ::FWK_SUCCESS The subscription was successfully cancelled. + * \retval ::FWK_E_INIT The notification component has not been initialized. + * \retval ::FWK_E_HANDLER The function was called from an interrupt handler. + * \retval ::FWK_E_PARAM One or more identifiers were invalid. + * \retval ::FWK_E_STATE The entity \p target_id has not subscribed to the * notification \p notification_id from the entity \p source_id. */ int fwk_notification_unsubscribe(fwk_id_t notification_id, fwk_id_t source_id, @@ -86,9 +86,9 @@ int fwk_notification_unsubscribe(fwk_id_t notification_id, fwk_id_t source_id, * \param [out] count Number of notification events that were sent. Must not be * \c NULL. * - * \retval FWK_SUCCESS All subscribers were notified successfully. - * \retval FWK_E_INIT The notification component has not been initialized. - * \retval FWK_E_PARAM One of more parameters were invalid. + * \retval ::FWK_SUCCESS All subscribers were notified successfully. + * \retval ::FWK_E_INIT The notification component has not been initialized. + * \retval ::FWK_E_PARAM One of more parameters were invalid. */ int fwk_notification_notify(struct fwk_event *notification_event, unsigned int *count); diff --git a/framework/include/internal/fwk_interrupt.h b/framework/include/internal/fwk_interrupt.h index b359ea4d..35e6f1de 100644 --- a/framework/include/internal/fwk_interrupt.h +++ b/framework/include/internal/fwk_interrupt.h @@ -27,9 +27,9 @@ * * \param isr Pointer to the fault interrupt service routine function. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_INIT The component has not been initialized. */ int fwk_interrupt_set_isr_fault(void (*isr)(void)); diff --git a/framework/include/internal/fwk_module.h b/framework/include/internal/fwk_module.h index 60480fea..7d96e995 100644 --- a/framework/include/internal/fwk_module.h +++ b/framework/include/internal/fwk_module.h @@ -113,8 +113,8 @@ struct fwk_module_ctx *fwk_module_get_ctx(fwk_id_t id); * \param id Module, element or sub-element identifier. * \param state [out] State of the module or element. * - * \retval FWK_SUCCESS The state was returned. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_SUCCESS The state was returned. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int fwk_module_get_state(fwk_id_t id, enum fwk_module_state *state); diff --git a/framework/include/internal/fwk_notification.h b/framework/include/internal/fwk_notification.h index 880b9989..6ea83a36 100644 --- a/framework/include/internal/fwk_notification.h +++ b/framework/include/internal/fwk_notification.h @@ -30,10 +30,10 @@ struct __fwk_notification_subscription { * \param notification_count The maximum number of notification subscriptions at * any time. * - * \retval FWK_SUCCESS The notification framework component was initialized. - * \retval FWK_E_PARAM The maximum number of notification subscriptions is equal - * to zero. - * \retval FWK_E_NOMEM Insufficient memory available to allocate the + * \retval ::FWK_SUCCESS The notification framework component was initialized. + * \retval ::FWK_E_PARAM The maximum number of notification subscriptions is + * equal to zero. + * \retval ::FWK_E_NOMEM Insufficient memory available to allocate the * notification subscription. */ int __fwk_notification_init(size_t notification_count); diff --git a/framework/include/internal/fwk_thread.h b/framework/include/internal/fwk_thread.h index b1f2ab03..0dc1e636 100644 --- a/framework/include/internal/fwk_thread.h +++ b/framework/include/internal/fwk_thread.h @@ -19,8 +19,8 @@ * * \param event_count The maximum number of events in all queues at all time. * - * \retval FWK_SUCCESS The thread framework component was initialized. - * \retval FWK_E_NOMEM Insufficient memory available for event queues. + * \retval ::FWK_SUCCESS The thread framework component was initialized. + * \retval ::FWK_E_NOMEM Insufficient memory available for event queues. */ int __fwk_thread_init(size_t event_count); @@ -55,9 +55,9 @@ const struct fwk_event *__fwk_thread_get_current_event(void); * * \param event Pointer to the notification event to queue. * - * \retval FWK_SUCCESS The event was queued. - * \retval FWK_E_PARAM The source identifier is not valid. - * \retval FWK_E_NOMEM No memory space to copy the event data. + * \retval ::FWK_SUCCESS The event was queued. + * \retval ::FWK_E_PARAM The source identifier is not valid. + * \retval ::FWK_E_NOMEM No memory space to copy the event data. */ int __fwk_thread_put_notification(struct fwk_event *event); diff --git a/framework/src/fwk_multi_thread.c b/framework/src/fwk_multi_thread.c index b960c4c4..ce6179ec 100644 --- a/framework/src/fwk_multi_thread.c +++ b/framework/src/fwk_multi_thread.c @@ -140,8 +140,8 @@ static struct __fwk_thread_ctx *thread_get_ctx(fwk_id_t id) * * \param event Pointer to the ISR event to queue. * - * \retval FWK_SUCCESS The event was put successfully. - * \retval FWK_E_NOMEM The free event queue is empty. + * \retval ::FWK_SUCCESS The event was put successfully. + * \retval ::FWK_E_NOMEM The free event queue is empty. */ static int put_isr_event(struct fwk_event *event) { @@ -208,8 +208,8 @@ static bool is_thread_wakeup_event(struct __fwk_thread_ctx *thread_ctx, * \param thread_ctx Pointer to the context of the thread target of the event. * \param event Pointer to the event to queue. * - * \retval FWK_SUCCESS The event was put successfully. - * \retval FWK_E_PARAM The event source is not valid. + * \retval ::FWK_SUCCESS The event was put successfully. + * \retval ::FWK_E_PARAM The event source is not valid. */ static int put_event(struct __fwk_thread_ctx *target_thread_ctx, struct fwk_event *event) diff --git a/framework/test/fwk_test.h b/framework/test/fwk_test.h index cf7fdd87..12ffe474 100644 --- a/framework/test/fwk_test.h +++ b/framework/test/fwk_test.h @@ -55,14 +55,14 @@ struct fwk_test_suite_desc { /*! Test suite name */ const char *name; - /*! + /*! * \brief Pointer to a test suite setup function. * * \details This function should be used to initialize and configure a test * fixture or to execute expensive routines that could otherwise be * done within a test case setup function. * - * \retval FWK_SUCCESS The test suite environment was successfully set up. + * \retval ::FWK_SUCCESS The test suite environment was successfully set up. * \return Any of the other error codes defined by the framework. * * \note May be NULL, in which case the test suite is considered to have no diff --git a/module/bootloader/include/mod_bootloader.h b/module/bootloader/include/mod_bootloader.h index e673a3e6..b7b56228 100644 --- a/module/bootloader/include/mod_bootloader.h +++ b/module/bootloader/include/mod_bootloader.h @@ -78,20 +78,21 @@ struct mod_bootloader_api { * \param config Pointer to an scp_bootloader_config structure containing * settings that control where the image is copied from and to. * - * \retval FWK_SUCCESS The RAM Firmware image was copied successfully. - * \retval FWK_E_ALIGN The given image offset is not properly aligned. - * \retval FWK_E_DATA The image did not pass checksum validation. - * \retval FWK_E_PARAM The config structure pointer is invalid. - * \retval FWK_E_PARAM One or more config structure fields are invalid. - * \retval FWK_E_SIZE The given image size is below the minimum possible + * \retval ::FWK_SUCCESS The RAM Firmware image was copied successfully. + * \retval ::FWK_E_ALIGN The given image offset is not properly aligned. + * \retval ::FWK_E_DATA The image did not pass checksum validation. + * \retval ::FWK_E_PARAM The config structure pointer is invalid. + * \retval ::FWK_E_PARAM One or more config structure fields are invalid. + * \retval ::FWK_E_SIZE The given image size is below the minimum possible * size. - * \retval FWK_E_SIZE The image is too large for the destination memory + * \retval ::FWK_E_SIZE The image is too large for the destination memory * area. - * \retval FWK_E_SIZE The given image offset is beyond the source memory - * area. - * \retval FWK_E_SIZE The header's size field does not match the given size. - * \retval FWK_E_SIZE Part of the image lies outside of the source memory + * \retval ::FWK_E_SIZE The given image offset is beyond the source memory * area. + * \retval ::FWK_E_SIZE The header's size field does not match the given + * size. + * \retval ::FWK_E_SIZE Part of the image lies outside of the source + * memory area. */ int (*load_image)(void); }; diff --git a/module/clock/include/mod_clock.h b/module/clock/include/mod_clock.h index d1e23a9f..4dbd52d1 100644 --- a/module/clock/include/mod_clock.h +++ b/module/clock/include/mod_clock.h @@ -255,9 +255,9 @@ struct mod_clock_drv_api { * \param round_mode The type of rounding to perform, if required, to * achieve the given rate. * - * \retval FWK_PENDING The request is pending. The driver will provide the + * \retval ::FWK_PENDING The request is pending. The driver will provide the * requested value later through the driver response API. - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*set_rate)(fwk_id_t clock_id, uint64_t rate, @@ -270,9 +270,9 @@ struct mod_clock_drv_api { * * \param[out] rate The current clock rate in Hertz. * - * \retval FWK_PENDING The request is pending. The driver will provide the + * \retval ::FWK_PENDING The request is pending. The driver will provide the * requested value later through the driver response API. - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*get_rate)(fwk_id_t clock_id, uint64_t *rate); @@ -286,7 +286,7 @@ struct mod_clock_drv_api { * * \param[out] rate The rate, in Hertz, corresponding to the index. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*get_rate_from_index)(fwk_id_t clock_id, unsigned int rate_index, @@ -299,9 +299,9 @@ struct mod_clock_drv_api { * * \param state One of the valid clock states. * - * \retval FWK_PENDING The request is pending. The driver will provide the + * \retval ::FWK_PENDING The request is pending. The driver will provide the * requested value later through the driver response API. - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*set_state)(fwk_id_t clock_id, enum mod_clock_state state); @@ -313,9 +313,9 @@ struct mod_clock_drv_api { * * \param[out] state The current clock state. * - * \retval FWK_PENDING The request is pending. The driver will provide the + * \retval ::FWK_PENDING The request is pending. The driver will provide the * requested value later through the driver response API. - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*get_state)(fwk_id_t clock_id, enum mod_clock_state *state); @@ -327,7 +327,7 @@ struct mod_clock_drv_api { * * \param[out] range The clock range structure. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*get_range)(fwk_id_t clock_id, struct mod_clock_range *range); @@ -352,7 +352,7 @@ struct mod_clock_drv_api { * \param new_state The power state that the clock's power domain will * transition to. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*process_pending_power_transition)( @@ -379,7 +379,7 @@ struct mod_clock_drv_api { * \param state The power state that the clock's power domain transitioned * to. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*process_power_transition)(fwk_id_t clock_id, unsigned int state); @@ -399,11 +399,11 @@ struct mod_clock_api { * \param round_mode The type of rounding to perform, if required, to * achieve the given rate. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_PENDING The request is pending. The result for this operation - * will be provided via a response event. - * \retval FWK_E_PARAM The clock identifier was invalid. - * \retval FWK_E_SUPPORT Deferred handling of asynchronous drivers is not + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_PENDING The request is pending. The result for this + * operation will be provided via a response event. + * \retval ::FWK_E_PARAM The clock identifier was invalid. + * \retval ::FWK_E_SUPPORT Deferred handling of asynchronous drivers is not * supported. * \return One of the standard framework error codes. */ @@ -417,12 +417,12 @@ struct mod_clock_api { * * \param[out] rate The current clock rate in Hertz. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_PENDING The request is pending. The requested rate will be + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_PENDING The request is pending. The requested rate will be * provided via a response event. - * \retval FWK_E_PARAM The clock identifier was invalid. - * \retval FWK_E_PARAM The rate pointer was NULL. - * \retval FWK_E_SUPPORT Deferred handling of asynchronous drivers is not + * \retval ::FWK_E_PARAM The clock identifier was invalid. + * \retval ::FWK_E_PARAM The rate pointer was NULL. + * \retval ::FWK_E_SUPPORT Deferred handling of asynchronous drivers is not * supported. * \return One of the standard framework error codes. */ @@ -437,9 +437,9 @@ struct mod_clock_api { * * \param[out] rate The rate, in Hertz, corresponding to the index. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The clock identifier was invalid. - * \retval FWK_E_PARAM The rate pointer was NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The clock identifier was invalid. + * \retval ::FWK_E_PARAM The rate pointer was NULL. * \return One of the standard framework error codes. */ int (*get_rate_from_index)(fwk_id_t clock_id, unsigned int rate_index, @@ -452,11 +452,11 @@ struct mod_clock_api { * * \param state One of the valid clock states. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_PENDING The request is pending. The result for this operation - * will be provided via a response event. - * \retval FWK_E_PARAM The clock identifier was invalid. - * \retval FWK_E_SUPPORT Deferred handling of asynchronous drivers is not + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_PENDING The request is pending. The result for this + * operation will be provided via a response event. + * \retval ::FWK_E_PARAM The clock identifier was invalid. + * \retval ::FWK_E_SUPPORT Deferred handling of asynchronous drivers is not * supported. * \return One of the standard framework error codes. */ @@ -469,12 +469,12 @@ struct mod_clock_api { * * \param[out] state The current clock state. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_PENDING The request is pending. The requested state will be + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_PENDING The request is pending. The requested state will be * provided via a response event. - * \retval FWK_E_PARAM The clock identifier was invalid. - * \retval FWK_E_PARAM The state pointer was NULL. - * \retval FWK_E_SUPPORT Deferred handling of asynchronous drivers is not + * \retval ::FWK_E_PARAM The clock identifier was invalid. + * \retval ::FWK_E_PARAM The state pointer was NULL. + * \retval ::FWK_E_SUPPORT Deferred handling of asynchronous drivers is not * supported. * \return One of the standard framework error codes. */ @@ -487,9 +487,9 @@ struct mod_clock_api { * * \param[out] info The clock device properties. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The clock identifier was invalid. - * \retval FWK_E_PARAM The info pointer was NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The clock identifier was invalid. + * \retval ::FWK_E_PARAM The info pointer was NULL. * \return One of the standard framework error codes. */ int (*get_info)(fwk_id_t clock_id, struct mod_clock_info *info); diff --git a/module/cmn600/include/mod_cmn600.h b/module/cmn600/include/mod_cmn600.h index bf04bfa3..a2016a4e 100644 --- a/module/cmn600/include/mod_cmn600.h +++ b/module/cmn600/include/mod_cmn600.h @@ -255,53 +255,53 @@ struct mod_cmn600_ccix_host_node_config { * \brief CMN600 CCIX configuration interface */ struct mod_cmn600_ccix_config_api { - /*! - * \brief Get the CCIX host configuration - * - * \param[out] config CCIX host configuration - * - * \retval FWK_SUCCESS if the operation succeed. - * \return one of the error code otherwise. - */ - int (*get_config)(struct mod_cmn600_ccix_host_node_config *config); - /*! - * \brief set the CCIX endpoint configuration - * - * \param[in] config CCIX endpoint configuration - * - * \retval FWK_SUCCESS if the operation succeed. - * \return one of the error code otherwise. - */ - int (*set_config)(struct mod_cmn600_ccix_remote_node_config *config); - /*! - * \brief Interface to trigger the protocol credit exchange - * - * \param link_id Link on which the protocol credit exchange - * would initiate. - * - * \retval FWK_SUCCESS if the operation succeed. - * \return one of the error code otherwise. - */ - int (*exchange_protocol_credit)(uint8_t link_id); - /*! - * \brief Interface to configure for system coherency - * - * \param link_id Link on which the coherency has to - * be enabled. - * - * \retval FWK_SUCCESS if the operation succeed. - * \return one of the error code otherwise. - */ - int (*enter_system_coherency)(uint8_t link_id); - /*! - * \brief Interface to enter DVM domain - * - * \param link_id Link on which DVM domain has to be enabled - * - * \retval FWK_SUCCESS if the operation succeed. - * \return one of the error code otherwise. - */ - int (*enter_dvm_domain)(uint8_t link_id); + /*! + * \brief Get the CCIX host configuration + * + * \param[out] config CCIX host configuration + * + * \retval ::FWK_SUCCESS if the operation succeed. + * \return one of the error code otherwise. + */ + int (*get_config)(struct mod_cmn600_ccix_host_node_config *config); + /*! + * \brief set the CCIX endpoint configuration + * + * \param[in] config CCIX endpoint configuration + * + * \retval ::FWK_SUCCESS if the operation succeed. + * \return one of the error code otherwise. + */ + int (*set_config)(struct mod_cmn600_ccix_remote_node_config *config); + /*! + * \brief Interface to trigger the protocol credit exchange + * + * \param link_id Link on which the protocol credit exchange + * would initiate. + * + * \retval ::FWK_SUCCESS if the operation succeed. + * \return one of the error code otherwise. + */ + int (*exchange_protocol_credit)(uint8_t link_id); + /*! + * \brief Interface to configure for system coherency + * + * \param link_id Link on which the coherency has to + * be enabled. + * + * \retval ::FWK_SUCCESS if the operation succeed. + * \return one of the error code otherwise. + */ + int (*enter_system_coherency)(uint8_t link_id); + /*! + * \brief Interface to enter DVM domain + * + * \param link_id Link on which DVM domain has to be enabled + * + * \retval ::FWK_SUCCESS if the operation succeed. + * \return one of the error code otherwise. + */ + int (*enter_dvm_domain)(uint8_t link_id); }; /*! diff --git a/module/css_clock/include/mod_css_clock.h b/module/css_clock/include/mod_css_clock.h index b260324d..3dbce6ac 100644 --- a/module/css_clock/include/mod_css_clock.h +++ b/module/css_clock/include/mod_css_clock.h @@ -150,7 +150,7 @@ struct mod_css_clock_direct_api { * \param new_state The power state that the clock's power domain will * transition to. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*process_pending_power_transition)( @@ -177,7 +177,7 @@ struct mod_css_clock_direct_api { * \param state The power state that the clock's power domain transitioned * to. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*process_power_transition)(fwk_id_t clock_id, unsigned int state); diff --git a/module/debug/include/mod_debug.h b/module/debug/include/mod_debug.h index 2aeec8f4..46482b4f 100644 --- a/module/debug/include/mod_debug.h +++ b/module/debug/include/mod_debug.h @@ -85,11 +85,11 @@ struct mod_debug_api { * * \param user_id The user requesting the Debug functionality. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_PENDING The operation has been acknowledged. - * \retval FWK_E_PARAM One or more parameters were incorrect. - * \retval FWK_E_BUSY Another request is already being processed. - * \retval FWK_E_ACCESS The specified user doesn't have the permission to + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_PENDING The operation has been acknowledged. + * \retval ::FWK_E_PARAM One or more parameters were incorrect. + * \retval ::FWK_E_BUSY Another request is already being processed. + * \retval ::FWK_E_ACCESS The specified user doesn't have the permission to * perform the requested action. * \return One of the standard framework error codes. */ @@ -105,11 +105,11 @@ struct mod_debug_api { * * \param user_id The user requesting the Debug enabled status. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_PENDING The operation has been acknowledged. - * \retval FWK_E_PARAM One or more parameters were incorrect. - * \retval FWK_E_BUSY Another request is already being processed. - * \retval FWK_E_ACCESS The specified user doesn't have the permission to + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_PENDING The operation has been acknowledged. + * \retval ::FWK_E_PARAM One or more parameters were incorrect. + * \retval ::FWK_E_BUSY Another request is already being processed. + * \retval ::FWK_E_ACCESS The specified user doesn't have the permission to * perform the requested action. * \return One of the standard framework error codes. */ @@ -120,7 +120,7 @@ struct mod_debug_api { * * \param id Debug device identifier. * - * \retval FWK_E_SUPPORT The operation is not supported. + * \retval ::FWK_E_SUPPORT The operation is not supported. * \return One of the standard framework error codes. */ int (*reset)(fwk_id_t id); @@ -130,7 +130,7 @@ struct mod_debug_api { * * \param id Debug device identifier. * - * \retval FWK_E_SUPPORT The operation is not supported. + * \retval ::FWK_E_SUPPORT The operation is not supported. * \return One of the standard framework error codes. */ int (*end)(fwk_id_t id); @@ -150,9 +150,9 @@ struct mod_debug_driver_api { * * \param user_id The user requesting the Debug driver functionality. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_PENDING The operation has been acknowledged. - * \retval FWK_E_BUSY Another request is already being processed. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_PENDING The operation has been acknowledged. + * \retval ::FWK_E_BUSY Another request is already being processed. * \return One of the standard framework error codes. */ int (*set_enabled)(fwk_id_t id, bool enable, enum scp_debug_user user_id); @@ -167,9 +167,9 @@ struct mod_debug_driver_api { * * \param user_id The user requesting the Debug driver enabled status. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_PENDING The operation has been acknowledged. - * \retval FWK_E_BUSY Another request is already being processed. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_PENDING The operation has been acknowledged. + * \retval ::FWK_E_BUSY Another request is already being processed. * \return One of the standard framework error codes. */ int (*get_enabled)(fwk_id_t id, bool *enabled, enum scp_debug_user user_id); @@ -204,7 +204,7 @@ struct mod_debug_driver_input_api { * * \param user_id The requesting user. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard framework error codes. */ int (*enable)(fwk_id_t id, bool enable, enum scp_debug_user user_id); diff --git a/module/dmc500/include/mod_dmc500.h b/module/dmc500/include/mod_dmc500.h index 7e19a01f..8c73b548 100644 --- a/module/dmc500/include/mod_dmc500.h +++ b/module/dmc500/include/mod_dmc500.h @@ -529,7 +529,7 @@ struct mod_dmc_ddr_phy_api { * \param element_id Element identifier corresponding to the device to * configure. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*configure)(fwk_id_t element_id); diff --git a/module/dmc620/include/mod_dmc620.h b/module/dmc620/include/mod_dmc620.h index 27a5e109..255e42cd 100644 --- a/module/dmc620/include/mod_dmc620.h +++ b/module/dmc620/include/mod_dmc620.h @@ -636,7 +636,7 @@ struct mod_dmc_ddr_phy_api { * \param element_id Element identifier corresponding to the device to * configure. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*configure)(fwk_id_t element_id); diff --git a/module/fip/include/mod_fip.h b/module/fip/include/mod_fip.h index b54a6663..de6d8341 100644 --- a/module/fip/include/mod_fip.h +++ b/module/fip/include/mod_fip.h @@ -86,10 +86,11 @@ struct mod_fip_api { * \param type FIP ToC entry type. * \param[out] entry Updated if the type of entry requested is found. - * \retval FWK_SUCCESS Entry found and \p entry updated. - * \retval FWK_E_INIT Underlying storage could not be parsed (during init). - * \retval FWK_E_RANGE No entry of type \p type could be located. - * \retval FWK_E_DATA FIP ToC corrupted or otherwise not usable on this + * \retval ::FWK_SUCCESS Entry found and \p entry updated. + * \retval ::FWK_E_INIT Underlying storage could not be parsed (during + * init). + * \retval ::FWK_E_RANGE No entry of type \p type could be located. + * \retval ::FWK_E_DATA FIP ToC corrupted or otherwise not usable on this * platform. */ int (*get_entry)( diff --git a/module/i2c/include/mod_i2c.h b/module/i2c/include/mod_i2c.h index 273c456f..cd381c19 100644 --- a/module/i2c/include/mod_i2c.h +++ b/module/i2c/include/mod_i2c.h @@ -107,9 +107,9 @@ struct mod_i2c_driver_api { * \param dev_id Identifier of the I2C device * \param transmit_request Request information for the I2C transmission * - * \retval FWK_PENDING The request was submitted. - * \retval FWK_SUCCESS The request was successfully completed. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_PENDING The request was submitted. + * \retval ::FWK_SUCCESS The request was successfully completed. + * \retval ::FWK_E_PARAM One or more parameters were invalid. * \return One of the standard framework status codes. */ int (*transmit_as_master)( @@ -126,9 +126,9 @@ struct mod_i2c_driver_api { * \param dev_id Identifier of the I2C device * \param receive_request Request information for the I2C reception * - * \retval FWK_PENDING The request was submitted. - * \retval FWK_SUCCESS The request was successfully completed. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_PENDING The request was submitted. + * \retval ::FWK_SUCCESS The request was successfully completed. + * \retval ::FWK_E_PARAM One or more parameters were invalid. * \return One of the standard framework status codes. */ int (*receive_as_master)( @@ -153,10 +153,10 @@ struct mod_i2c_api { * \param data Pointer to the data bytes to transmit to the slave * \param byte_count Number of data bytes to transmit * - * \retval FWK_PENDING The request was submitted. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_BUSY An I2C transaction is already on-going. - * \retval FWK_E_DEVICE The transmission is aborted due to a device error. + * \retval ::FWK_PENDING The request was submitted. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_BUSY An I2C transaction is already on-going. + * \retval ::FWK_E_DEVICE The transmission is aborted due to a device error. * \return One of the standard framework status codes. */ int (*transmit_as_master)(fwk_id_t dev_id, uint8_t slave_address, @@ -176,10 +176,10 @@ struct mod_i2c_api { * \param data Pointer to the buffer to receive data from the slave * \param byte_count Number of data bytes to receive * - * \retval FWK_PENDING The request was submitted. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_BUSY An I2C transaction is already on-going. - * \retval FWK_E_DEVICE The reception is aborted due to a device error. + * \retval ::FWK_PENDING The request was submitted. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_BUSY An I2C transaction is already on-going. + * \retval ::FWK_E_DEVICE The reception is aborted due to a device error. * \return One of the standard framework status codes. */ int (*receive_as_master)(fwk_id_t dev_id, uint8_t slave_address, @@ -206,10 +206,10 @@ struct mod_i2c_api { * \param receive_byte_count Number of data bytes to receive in the second * phase. * - * \retval FWK_PENDING The request was submitted. - * \retval FWK_E_PARAM One or more parameters were invalid. - * \retval FWK_E_BUSY An I2C transaction is already on-going. - * \retval FWK_E_DEVICE The reception is aborted due to a device error. + * \retval ::FWK_PENDING The request was submitted. + * \retval ::FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_BUSY An I2C transaction is already on-going. + * \retval ::FWK_E_DEVICE The reception is aborted due to a device error. * \return One of the standard framework status codes. */ int (*transmit_then_receive_as_master)(fwk_id_t dev_id, diff --git a/module/power_domain/include/mod_power_domain.h b/module/power_domain/include/mod_power_domain.h index 1dada0a6..b725aa37 100644 --- a/module/power_domain/include/mod_power_domain.h +++ b/module/power_domain/include/mod_power_domain.h @@ -294,8 +294,8 @@ struct mod_pd_driver_api { * \param dev_id Driver identifier of the power domain. * \param state Power state the power domain has to be put into. * - * \retval FWK_SUCCESS The power state has been successfully set. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_SUCCESS The power state has been successfully set. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. * \return One of the other specific error codes described by the driver * module. @@ -312,8 +312,8 @@ struct mod_pd_driver_api { * \param dev_id Driver identifier of the power domain. * \param[out] state Power state of the power domain. * - * \retval FWK_SUCCESS The power state was successfully returned. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_SUCCESS The power state was successfully returned. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. */ int (*get_state)(fwk_id_t dev_id, unsigned int *state); @@ -327,8 +327,8 @@ struct mod_pd_driver_api { * * \param dev_id Driver identifier of the power domain. * - * \retval FWK_SUCCESS The power domain was successfully reset. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_SUCCESS The power domain was successfully reset. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. * \return One of the other specific error codes described by the module. */ @@ -370,8 +370,8 @@ struct mod_pd_driver_api { * * \param dev_id Driver identifier of the power domain. * - * \retval FWK_SUCCESS The core has been successfully prepared. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_SUCCESS The core has been successfully prepared. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. */ int (*prepare_core_for_system_suspend)(fwk_id_t dev_id); @@ -387,10 +387,10 @@ struct mod_pd_driver_api { * \param dev_id Driver identifier of the power domain. * \param system_shutdown Type of system shutdown. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_PENDING The operation was acknowledged. Please note that at + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_PENDING The operation was acknowledged. Please note that at * present there is no dedicated driver input api for this case. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. */ int (*shutdown)(fwk_id_t dev_id, @@ -412,11 +412,11 @@ struct mod_pd_public_api { * queried for. * \param[out] type Type of the power domain. * - * \retval FWK_SUCCESS The type of the power domain was returned. - * \retval FWK_E_INIT The module has not been initialized. - * \retval FWK_E_STATE The power domain module is in an invalid state. - * \retval FWK_E_PARAM The power domain identifier is unknown. - * \retval FWK_E_PARAM The pointer 'type' is equal to NULL. + * \retval ::FWK_SUCCESS The type of the power domain was returned. + * \retval ::FWK_E_INIT The module has not been initialized. + * \retval ::FWK_E_STATE The power domain module is in an invalid state. + * \retval ::FWK_E_PARAM The power domain identifier is unknown. + * \retval ::FWK_E_PARAM The pointer 'type' is equal to NULL. */ int (*get_domain_type)(fwk_id_t pd_id, enum mod_pd_type *type); @@ -429,12 +429,12 @@ struct mod_pd_public_api { * \param pd_id Identifier of the power domain. * \param[out] parent_pd_id Identifier of the parent power domain. * - * \retval FWK_SUCCESS The identifier of the parent power domain was + * \retval ::FWK_SUCCESS The identifier of the parent power domain was * returned. - * \retval FWK_E_INIT The module has not been initialized. - * \retval FWK_E_STATE The power domain module is in an invalid state. - * \retval FWK_E_PARAM The power domain identifier is unknown. - * \retval FWK_E_PARAM The pointer 'parent_pd_id' is equal to NULL. + * \retval ::FWK_E_INIT The module has not been initialized. + * \retval ::FWK_E_STATE The power domain module is in an invalid state. + * \retval ::FWK_E_PARAM The power domain identifier is unknown. + * \retval ::FWK_E_PARAM The pointer 'parent_pd_id' is equal to NULL. */ int (*get_domain_parent_id)(fwk_id_t pd_id, fwk_id_t *parent_pd_id); }; @@ -455,11 +455,11 @@ struct mod_pd_restricted_api { * queried for. * \param[out] type Type of the power domain. * - * \retval FWK_SUCCESS The type of the power domain was returned. - * \retval FWK_E_INIT The module has not been initialized. - * \retval FWK_E_STATE The power domain module is in an invalid state. - * \retval FWK_E_PARAM The power domain identifier is unknown. - * \retval FWK_E_PARAM The pointer 'type' is equal to NULL. + * \retval ::FWK_SUCCESS The type of the power domain was returned. + * \retval ::FWK_E_INIT The module has not been initialized. + * \retval ::FWK_E_STATE The power domain module is in an invalid state. + * \retval ::FWK_E_PARAM The power domain identifier is unknown. + * \retval ::FWK_E_PARAM The pointer 'type' is equal to NULL. */ int (*get_domain_type)(fwk_id_t pd_id, enum mod_pd_type *type); @@ -472,12 +472,12 @@ struct mod_pd_restricted_api { * \param pd_id Identifier of the power domain. * \param[out] parent_pd_id The identifier of the parent power domain. * - * \retval FWK_SUCCESS The identifier of the parent power domain was + * \retval ::FWK_SUCCESS The identifier of the parent power domain was * returned. - * \retval FWK_E_INIT The module has not been initialized. - * \retval FWK_E_STATE The power domain module is in an invalid state. - * \retval FWK_E_PARAM The power domain identifier is unknown. - * \retval FWK_E_PARAM The pointer 'parent_pd_id' is equal to NULL. + * \retval ::FWK_E_INIT The module has not been initialized. + * \retval ::FWK_E_STATE The power domain module is in an invalid state. + * \retval ::FWK_E_PARAM The power domain identifier is unknown. + * \retval ::FWK_E_PARAM The pointer 'parent_pd_id' is equal to NULL. */ int (*get_domain_parent_id)(fwk_id_t pd_id, fwk_id_t *parent_pd_id); @@ -497,11 +497,11 @@ struct mod_pd_restricted_api { * and the children of the power domain involved are in a state where * the transition can be completed. * - * \retval FWK_SUCCESS The power state transition was completed. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_SUCCESS The power state transition was completed. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. - * \retval FWK_E_HANDLER The function is not called from a thread. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_HANDLER The function is not called from a thread. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*set_state)(fwk_id_t pd_id, uint32_t state); @@ -523,10 +523,10 @@ struct mod_pd_restricted_api { * and the children of the power domain involved are in a state where * the transition can be completed. * - * \retval FWK_SUCCESS The power state transition was submitted. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_SUCCESS The power state transition was submitted. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*set_state_async)(fwk_id_t pd_id, bool resp_requested, uint32_t state); @@ -537,12 +537,12 @@ struct mod_pd_restricted_api { * retrieved. * \param[out] state The power domain state. * - * \retval FWK_SUCCESS The power state was returned. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_SUCCESS The power state was returned. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. - * \retval FWK_E_HANDLER The function is not called from a thread. - * \retval FWK_E_PARAM The power domain identifier is unknown. - * \retval FWK_E_PARAM The pointer 'state' is equal to NULL. + * \retval ::FWK_E_HANDLER The function is not called from a thread. + * \retval ::FWK_E_PARAM The power domain identifier is unknown. + * \retval ::FWK_E_PARAM The pointer 'state' is equal to NULL. */ int (*get_state)(fwk_id_t pd_id, unsigned int *state); @@ -554,12 +554,12 @@ struct mod_pd_restricted_api { * * \param pd_id Identifier of the power domain to reset. * - * \retval FWK_SUCCESS Power state retrieving request transmitted. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_SUCCESS Power state retrieving request transmitted. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. - * \retval FWK_E_HANDLER The function is not called from a thread. - * \retval FWK_E_NOMEM Failed to allocate a request descriptor. - * \retval FWK_E_PARAM The power domain identifier is unknown. + * \retval ::FWK_E_HANDLER The function is not called from a thread. + * \retval ::FWK_E_NOMEM Failed to allocate a request descriptor. + * \retval ::FWK_E_PARAM The power domain identifier is unknown. */ int (*reset)(fwk_id_t pd_id); @@ -574,14 +574,14 @@ struct mod_pd_restricted_api { * \param state State the system has to be suspended to. The definition * of those states is platform specific. * - * \retval FWK_SUCCESS The system suspension has been initiated + * \retval ::FWK_SUCCESS The system suspension has been initiated * successfully. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. - * \retval FWK_E_HANDLER The function is not called from a thread. - * \retval FWK_E_NOMEM Failed to allocate a request descriptor. - * \retval FWK_E_PARAM Invalid state. - * \retval FWK_E_STATE The system is not in the proper state to be + * \retval ::FWK_E_HANDLER The function is not called from a thread. + * \retval ::FWK_E_NOMEM Failed to allocate a request descriptor. + * \retval ::FWK_E_PARAM Invalid state. + * \retval ::FWK_E_STATE The system is not in the proper state to be * suspended. */ int (*system_suspend)(unsigned int state); @@ -592,12 +592,12 @@ struct mod_pd_restricted_api { * \note The function shutdowns the system whatever its current state. If * the shutdown is successful, the function does not return. * - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. - * \retval FWK_PENDING Request aknowledged. A response event will not be + * \retval ::FWK_PENDING Request aknowledged. A response event will not be * sent to the caller. - * \retval FWK_E_HANDLER The function is not called from a thread. - * \retval FWK_E_NOMEM Failed to allocate a request descriptor. + * \retval ::FWK_E_HANDLER The function is not called from a thread. + * \retval ::FWK_E_NOMEM Failed to allocate a request descriptor. */ int (*system_shutdown)(enum mod_pd_system_shutdown system_shutdown); }; @@ -628,10 +628,10 @@ struct mod_pd_driver_input_api { * and the children of the power domain involved are in a state where * the transition can be completed. * - * \retval FWK_SUCCESS The composite power state transition was submitted. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_SUCCESS The composite power state transition was submitted. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. - * \retval FWK_E_PARAM One or more parameters were invalid. + * \retval ::FWK_E_PARAM One or more parameters were invalid. */ int (*set_state_async)( fwk_id_t pd_id, @@ -650,12 +650,12 @@ struct mod_pd_driver_input_api { * \param resp_requested True if the caller wants to be notified with an * event response at the end of the request processing. * - * \retval FWK_SUCCESS Reset request transmitted. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the + * \retval ::FWK_SUCCESS Reset request transmitted. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the * call to the API. - * \retval FWK_E_HANDLER The function is not called from a thread. - * \retval FWK_E_NOMEM Failed to allocate a request descriptor. - * \retval FWK_E_PARAM The power domain identifier is unknown. + * \retval ::FWK_E_HANDLER The function is not called from a thread. + * \retval ::FWK_E_NOMEM Failed to allocate a request descriptor. + * \retval ::FWK_E_PARAM The power domain identifier is unknown. */ int (*reset_async)(fwk_id_t pd_id, bool resp_requested); @@ -669,11 +669,11 @@ struct mod_pd_driver_input_api { * \param pd_id Identifier of the power domain, a power state transition * report is is sent to. * - * \retval FWK_SUCCESS Report transmitted. - * \retval FWK_E_ACCESS Invalid access, the framework has rejected the call - * to the API. - * \retval FWK_E_NOMEM Failed to allocate a report event. - * \retval FWK_E_PARAM The power domain identifier is unknown. + * \retval ::FWK_SUCCESS Report transmitted. + * \retval ::FWK_E_ACCESS Invalid access, the framework has rejected the + * call to the API. + * \retval ::FWK_E_NOMEM Failed to allocate a report event. + * \retval ::FWK_E_PARAM The power domain identifier is unknown. */ int (*report_power_state_transition)(fwk_id_t pd_id, unsigned int state); @@ -693,8 +693,8 @@ struct mod_pd_driver_input_api { * * \param[out] last_core_pd_id Identifier of the last core. * - * \retval FWK_E_PARAM The pointer to the identifier is not valid. - * \retval FWK_SUCCESS The request was successful. + * \retval ::FWK_E_PARAM The pointer to the identifier is not valid. + * \retval ::FWK_SUCCESS The request was successful. * \return One of the standard framework error codes. */ int (*get_last_core_pd_id)(fwk_id_t *last_core_pd_id); diff --git a/module/power_domain/src/mod_power_domain.c b/module/power_domain/src/mod_power_domain.c index b8cd704a..9415f9a3 100644 --- a/module/power_domain/src/mod_power_domain.c +++ b/module/power_domain/src/mod_power_domain.c @@ -661,8 +661,8 @@ static bool initiate_power_state_pre_transition_notification(struct pd_ctx *pd) * \param pd Description of the power domain to initiate the state transition * for. * - * \retval FWK_SUCCESS The power state transition was initiated. - * \retval FWK_E_DEVICE The power state transition was denied by the driver. + * \retval ::FWK_SUCCESS The power state transition was initiated. + * \retval ::FWK_E_DEVICE The power state transition was denied by the driver. * \return One of the other driver-defined error codes. */ static int initiate_power_state_transition(struct pd_ctx *pd) diff --git a/module/ppu_v1/include/mod_ppu_v1.h b/module/ppu_v1/include/mod_ppu_v1.h index e67a21f8..f968a602 100644 --- a/module/ppu_v1/include/mod_ppu_v1.h +++ b/module/ppu_v1/include/mod_ppu_v1.h @@ -174,7 +174,7 @@ struct ppu_v1_boot_api { * * \param pd_id Identifier of the power domain * - * \retval FWK_SUCCESS Operation successful. + * \retval ::FWK_SUCCESS Operation successful. * \return One of the standard framework error codes. */ int (*power_mode_on)(fwk_id_t pd_id); diff --git a/module/reset_domain/include/mod_reset_domain.h b/module/reset_domain/include/mod_reset_domain.h index 48cfcf99..775fe9a2 100644 --- a/module/reset_domain/include/mod_reset_domain.h +++ b/module/reset_domain/include/mod_reset_domain.h @@ -139,7 +139,7 @@ struct mod_reset_domain_api { * \param mode Reset domain mode. * \param reset_state Reset domain state as defined in SCMIv2 specification. * \param cookie Context-specific value. - * \retval FWK_SUCCESS or one of FWK_E_* error codes. + * \retval ::FWK_SUCCESS or one of FWK_E_* error codes. */ int (*set_reset_state)(fwk_id_t element_id, enum mod_reset_domain_mode mode, @@ -162,7 +162,7 @@ struct mod_reset_domain_drv_api { * \param reset_state Reset domain state as defined in SCMIv2 specification. * * \param cookie Context-specific value. - * \retval FWK_SUCCESS or one of FWK_E_* error codes. + * \retval ::FWK_SUCCESS or one of FWK_E_* error codes. */ int (*set_reset_state)(fwk_id_t dev_id, enum mod_reset_domain_mode mode, diff --git a/module/resource_perms/include/mod_resource_perms.h b/module/resource_perms/include/mod_resource_perms.h index 8a3bd64a..ac2fefd4 100644 --- a/module/resource_perms/include/mod_resource_perms.h +++ b/module/resource_perms/include/mod_resource_perms.h @@ -408,9 +408,9 @@ struct mod_res_permissions_api { * \param device_id identifier of the device. * \param flags permissions to set. * - * \retval FWK_SUCCESS The operation has completed successfully. - * \retval FWK_E_ACCESS Unknown agent_id or device_id. - * \retval FWK_E_PARAM Invalid flags or protocol_ID. + * \retval ::FWK_SUCCESS The operation has completed successfully. + * \retval ::FWK_E_ACCESS Unknown agent_id or device_id. + * \retval ::FWK_E_PARAM Invalid flags or protocol_ID. */ int (*agent_set_device_permission)( uint32_t agent_id, @@ -425,9 +425,9 @@ struct mod_res_permissions_api { * \param device_id identifier of the protocol. * \param flags permissions to set. * - * \retval FWK_SUCCESS The operation has completed successfully. - * \retval FWK_E_ACCESS Unknown agent_id or device_id. - * \retval FWK_E_PARAM Invalid flags or protocol_ID. + * \retval ::FWK_SUCCESS The operation has completed successfully. + * \retval ::FWK_E_ACCESS Unknown agent_id or device_id. + * \retval ::FWK_E_PARAM Invalid flags or protocol_ID. */ int (*agent_set_device_protocol_permission)( uint32_t agent_id, @@ -441,9 +441,9 @@ struct mod_res_permissions_api { * \param agent_id identifier of the agent. * \param flags permissions to set. * - * \retval FWK_SUCCESS The operation has completed successfully. - * \retval FWK_E_ACCESS Unknown agent_id. - * \retval FWK_E_PARAM Invalid flags. + * \retval ::FWK_SUCCESS The operation has completed successfully. + * \retval ::FWK_E_ACCESS Unknown agent_id. + * \retval ::FWK_E_PARAM Invalid flags. */ int (*agent_reset_config)(uint32_t agent_id, uint32_t flags); }; diff --git a/module/scmi/include/mod_scmi.h b/module/scmi/include/mod_scmi.h index 21d9c019..39153824 100644 --- a/module/scmi/include/mod_scmi.h +++ b/module/scmi/include/mod_scmi.h @@ -165,9 +165,9 @@ struct mod_scmi_to_transport_api { * \param[out] secure Channel security state. True if the channel * is secure, or false if it is non-secure. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The secure parameter is NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The secure parameter is NULL. * \return One of the standard error codes for implementation-defined * errors. */ @@ -179,9 +179,9 @@ struct mod_scmi_to_transport_api { * \param channel_id Channel identifier. * \param[out] size Maximum payload size in bytes. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The size parameter is NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The size parameter is NULL. * \return One of the standard error codes for implementation-defined * errors. */ @@ -193,10 +193,10 @@ struct mod_scmi_to_transport_api { * \param channel_id Channel identifier. * \param[out] message_header SCMI message header. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The message_header parameter is NULL. - * \retval FWK_E_ACCESS No message is available to read. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The message_header parameter is NULL. + * \retval ::FWK_E_ACCESS No message is available to read. * \return One of the standard error codes for implementation-defined * errors. */ @@ -210,10 +210,10 @@ struct mod_scmi_to_transport_api { * \param[out] size Payload size. May be NULL, in which case the * parameter should be ignored. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The payload parameter is NULL. - * \retval FWK_E_ACCESS No message is available to read. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The payload parameter is NULL. + * \retval ::FWK_E_ACCESS No message is available to read. * \return One of the standard error codes for implementation-defined * errors. */ @@ -228,9 +228,9 @@ struct mod_scmi_to_transport_api { * \param payload Payload data to write. * \param size Size of the payload data. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The payload parameter is NULL. - * \retval FWK_E_PARAM The offset and size provided are not within the + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The payload parameter is NULL. + * \retval ::FWK_E_PARAM The offset and size provided are not within the * bounds of the payload area. * \return One of the standard error codes for implementation-defined * errors. @@ -246,11 +246,11 @@ struct mod_scmi_to_transport_api { * been written. * \param size Size of the payload source. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The size parameter is less than the size of one + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The size parameter is less than the size of one * payload entry. - * \retval FWK_E_ACCESS No message is available to respond to. + * \retval ::FWK_E_ACCESS No message is available to respond to. * \return One of the standard error codes for implementation-defined * errors. */ @@ -264,9 +264,9 @@ struct mod_scmi_to_transport_api { * \param payload Payload data to write. * \param size Size of the payload source. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The size parameter is less than the size of one + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The size parameter is less than the size of one * payload entry. * \return One of the standard error codes for implementation-defined * errors. @@ -289,8 +289,8 @@ struct mod_scmi_from_transport_api { * * \param service_id service identifier. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The service_id parameter is invalid. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The service_id parameter is invalid. * \return One of the standard error codes for implementation-defined * errors. */ @@ -301,9 +301,9 @@ struct mod_scmi_from_transport_api { * * \param service_id SCMI service identifier. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The secure parameter is NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The secure parameter is NULL. * \return One of the standard error codes for implementation-defined * errors. */ @@ -329,7 +329,7 @@ struct mod_scmi_from_transport_api { * \param message_id Identifier of the message to be handled by the protocol * handler. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined errors. * */ @@ -348,7 +348,7 @@ struct mod_scmi_to_protocol_api { * \param protocol_id Identifier of the protocol module. * \param scmi_protocol_id SCMI protocol identifier. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. * @@ -373,7 +373,7 @@ struct mod_scmi_notification_api { * \param element_count Number of elements that support notification. * \param operation_count Number of notification SCMI messages supported. * - * \retval FWK_SUCCESS Initialization successful. + * \retval ::FWK_SUCCESS Initialization successful. * \retval One of the standard error codes for implementation-defined * errors. */ @@ -392,9 +392,10 @@ struct mod_scmi_notification_api { * \param operation_id Identifier of the operation. * \param service_id Identifier of the agent's SCMI service context. * - * \retval FWK_SUCCESS Adding of subscriber agent to the list is successful. + * \retval ::FWK_SUCCESS Adding of subscriber agent to the list is + * successful. * \retval One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*scmi_notification_add_subscriber)( unsigned int protocol_id, @@ -411,7 +412,7 @@ struct mod_scmi_notification_api { * context. * \param operation_id Identifier of the operation. * - * \retval FWK_SUCCESS Removing of subscriber agent from the list is + * \retval ::FWK_SUCCESS Removing of subscriber agent from the list is * successful. * \retval One of the standard error codes for implementation-defined * errors. @@ -433,7 +434,7 @@ struct mod_scmi_notification_api { * agent. * \param payload_size Size of the message. * - * \retval FWK_SUCCESS Notification to agents is successful. + * \retval ::FWK_SUCCESS Notification to agents is successful. * \retval One of the standard error codes for implementation-defined * errors. */ @@ -455,10 +456,10 @@ struct mod_scmi_from_protocol_api { * * \param[out] agent_count Number of active agents. * - * \retval FWK_SUCCESS The agent count was returned. - * \retval FWK_E_PARAM The parameter `agent_count` is equal to `NULL`. + * \retval ::FWK_SUCCESS The agent count was returned. + * \retval ::FWK_E_PARAM The parameter `agent_count` is equal to `NULL`. */ - int (*get_agent_count)(int *agent_count); + int (*get_agent_count)(int *agent_count); /*! * \brief Get the identifier of the agent associated with a service @@ -466,13 +467,13 @@ struct mod_scmi_from_protocol_api { * \param service_id Identifier of the service. * \param[out] agent_id Agent identifier. * - * \retval FWK_SUCCESS The agent identifier was returned. - * \retval FWK_E_PARAM The service identifier is not valid. - * \retval FWK_E_PARAM The parameter 'agent_id' is equal to NULL. - * \retval FWK_E_INIT The service is not initialized. - * \retval FWK_E_STATE The service is in an invalid state. + * \retval ::FWK_SUCCESS The agent identifier was returned. + * \retval ::FWK_E_PARAM The service identifier is not valid. + * \retval ::FWK_E_PARAM The parameter 'agent_id' is equal to NULL. + * \retval ::FWK_E_INIT The service is not initialized. + * \retval ::FWK_E_STATE The service is in an invalid state. */ - int (*get_agent_id)(fwk_id_t service_id, unsigned int *agent_id); + int (*get_agent_id)(fwk_id_t service_id, unsigned int *agent_id); /*! * \brief Get the type of the agent given its identifier. @@ -483,12 +484,11 @@ struct mod_scmi_from_protocol_api { * \param agent_id Identifier of the agent. * \param[out] agent_type Agent type. * - * \retval FWK_SUCCESS The agent identifier was returned. - * \retval FWK_E_PARAM The agent identifier is not valid. - * \retval FWK_E_PARAM The parameter 'agent_type' is equal to NULL. + * \retval ::FWK_SUCCESS The agent identifier was returned. + * \retval ::FWK_E_PARAM The agent identifier is not valid. + * \retval ::FWK_E_PARAM The parameter 'agent_type' is equal to NULL. */ - int (*get_agent_type)(uint32_t agent_id, - enum scmi_agent_type *agent_type); + int (*get_agent_type)(uint32_t agent_id, enum scmi_agent_type *agent_type); /*! * \brief Get the maximum permitted payload size of a channel associated @@ -497,11 +497,11 @@ struct mod_scmi_from_protocol_api { * \param service_id Service identifier. * \param[out] size Maximum payload size in bytes. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The service_id parameter is invalid. - * \retval FWK_E_PARAM The size parameter is NULL. - * \retval FWK_E_INIT The service is not initialized. - * \retval FWK_E_STATE The service is in an invalid sate. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The service_id parameter is invalid. + * \retval ::FWK_E_PARAM The size parameter is NULL. + * \retval ::FWK_E_INIT The service is not initialized. + * \retval ::FWK_E_STATE The service is in an invalid sate. * \return One of the standard error codes for implementation-defined * errors. */ @@ -515,9 +515,9 @@ struct mod_scmi_from_protocol_api { * \param payload Payload data to write. * \param size Size of the payload data. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The payload parameter is NULL. - * \retval FWK_E_PARAM The offset and size provided are not within the + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The payload parameter is NULL. + * \retval ::FWK_E_PARAM The offset and size provided are not within the * bounds of the payload area. * \return One of the standard error codes for implementation-defined * errors. diff --git a/module/sds/include/mod_sds.h b/module/sds/include/mod_sds.h index 6005b203..84aa30f5 100644 --- a/module/sds/include/mod_sds.h +++ b/module/sds/include/mod_sds.h @@ -170,10 +170,10 @@ struct mod_sds_api { * * \param size Size, in bytes, of the data to be written. * - * \retval FWK_SUCCESS Data was successfully written to the structure. - * \retval FWK_E_PARAM The data pointer parameter was NULL. - * \retval FWK_E_PARAM An invalid structure identifier was provided. - * \retval FWK_E_RANGE The field extends outside of the structure bounds. + * \retval ::FWK_SUCCESS Data was successfully written to the structure. + * \retval ::FWK_E_PARAM The data pointer parameter was NULL. + * \retval ::FWK_E_PARAM An invalid structure identifier was provided. + * \retval ::FWK_E_RANGE The field extends outside of the structure bounds. */ int (*struct_write)(uint32_t structure_id, unsigned int offset, const void *data, size_t size); @@ -204,10 +204,10 @@ struct mod_sds_api { * \param size Size, in bytes, of the storage pointed to by the data * parameter. * - * \retval FWK_SUCCESS Data was successfully read from the structure. - * \retval FWK_E_PARAM The data pointer parameter was NULL. - * \retval FWK_E_PARAM An invalid structure identifier was provided. - * \retval FWK_E_RANGE The field extends outside of the structure bounds. + * \retval ::FWK_SUCCESS Data was successfully read from the structure. + * \retval ::FWK_E_PARAM The data pointer parameter was NULL. + * \retval ::FWK_E_PARAM An invalid structure identifier was provided. + * \retval ::FWK_E_RANGE The field extends outside of the structure bounds. */ int (*struct_read)(uint32_t structure_id, unsigned int offset, void *data, size_t size); @@ -219,9 +219,9 @@ struct mod_sds_api { * \param structure_id The identifier of the Shared Data Structure to * finalize. * - * \retval FWK_SUCCESS The structure was successfully finalized. - * \retval FWK_E_PARAM An invalid structure identifier was provided. - * \retval FWK_E_STATE The structure has already been finalized. + * \retval ::FWK_SUCCESS The structure was successfully finalized. + * \retval ::FWK_E_PARAM An invalid structure identifier was provided. + * \retval ::FWK_E_STATE The structure has already been finalized. */ int (*struct_finalize)(uint32_t structure_id); }; diff --git a/module/sensor/include/mod_sensor.h b/module/sensor/include/mod_sensor.h index 5e39d7c9..94ec3d70 100644 --- a/module/sensor/include/mod_sensor.h +++ b/module/sensor/include/mod_sensor.h @@ -180,9 +180,9 @@ struct mod_sensor_driver_api { * \param id Specific sensor device id. * \param[out] value Sensor value. * - * \retval FWK_PENDING The request is pending. The driver will provide the + * \retval ::FWK_PENDING The request is pending. The driver will provide the * requested value later through the driver response API. - * \retval FWK_SUCCESS Value was read successfully. + * \retval ::FWK_SUCCESS Value was read successfully. * \return One of the standard framework error codes. */ int (*get_value)(fwk_id_t id, uint64_t *value); @@ -193,7 +193,7 @@ struct mod_sensor_driver_api { * \param id Specific sensor device id. * \param[out] info The sensor information. * - * \retval FWK_SUCCESS The information was read successfully. + * \retval ::FWK_SUCCESS The information was read successfully. * \return One of the standard framework error codes. */ int (*get_info)(fwk_id_t id, struct mod_sensor_info *info); @@ -211,11 +211,11 @@ struct mod_sensor_api { * \param id Specific sensor device id. * \param[out] value The sensor value. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_DEVICE Driver error. - * \retval FWK_E_BUSY At least one reading of the sensor value is already + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_DEVICE Driver error. + * \retval ::FWK_E_BUSY At least one reading of the sensor value is already * on-going. - * \retval FWK_PENDING The request is pending. The requested value will be + * \retval ::FWK_PENDING The request is pending. The requested value will be * provided via a response event. * \return One of the standard framework error codes. */ @@ -229,8 +229,8 @@ struct mod_sensor_api { * \param id Specific sensor device id. * \param[out] info The information structure. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_DEVICE Driver error. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_DEVICE Driver error. * \return One of the standard framework error codes. */ int (*get_info)(fwk_id_t id, struct mod_sensor_info *info); diff --git a/module/sid/include/mod_sid.h b/module/sid/include/mod_sid.h index f17824a1..cfa2779a 100644 --- a/module/sid/include/mod_sid.h +++ b/module/sid/include/mod_sid.h @@ -101,8 +101,8 @@ struct mod_sid_subsystem_config { * * \param[out] system_info Pointer to the system information data. * - * \retval FWK_SUCCESS The pointer was returned successfully. - * \retval FWK_E_INIT The system information is not initialized. + * \retval ::FWK_SUCCESS The pointer was returned successfully. + * \retval ::FWK_E_INIT The system information is not initialized. */ int mod_sid_get_system_info(const struct mod_sid_info **system_info); diff --git a/module/smt/include/mod_smt.h b/module/smt/include/mod_smt.h index 893f96e1..9850a4fd 100644 --- a/module/smt/include/mod_smt.h +++ b/module/smt/include/mod_smt.h @@ -93,8 +93,8 @@ struct mod_smt_driver_api { * * \param device_id Device identifier * - * \retval FWK_SUCCESS The operation succeeded - * \retval FWK_E_PARAM The device_id parameter is invalid + * \retval ::FWK_SUCCESS The operation succeeded + * \retval ::FWK_E_PARAM The device_id parameter is invalid * \return One of the standard error codes for implementation-defined * errors */ @@ -112,7 +112,7 @@ struct mod_smt_driver_input_api { * * \param device_id Channel identifier * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -131,9 +131,9 @@ struct mod_smt_to_transport_api { * \param[out] secure Channel security state. True if the channel * is secure, or false if it is non-secure. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The secure parameter is NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The secure parameter is NULL. * \return One of the standard error codes for implementation-defined * errors. */ @@ -145,9 +145,9 @@ struct mod_smt_to_transport_api { * \param channel_id Channel identifier. * \param[out] size Maximum payload size in bytes. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The size parameter is NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The size parameter is NULL. * \return One of the standard error codes for implementation-defined * errors. */ @@ -159,10 +159,10 @@ struct mod_smt_to_transport_api { * \param channel_id Channel identifier. * \param[out] message_header Pointer to the message header. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The message_header parameter is NULL. - * \retval FWK_E_ACCESS No message is available to read. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The message_header parameter is NULL. + * \retval ::FWK_E_ACCESS No message is available to read. * \return One of the standard error codes for implementation-defined * errors. */ @@ -176,10 +176,10 @@ struct mod_smt_to_transport_api { * \param[out] size Payload size. May be NULL, in which case the * parameter should be ignored. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The payload parameter is NULL. - * \retval FWK_E_ACCESS No message is available to read. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The payload parameter is NULL. + * \retval ::FWK_E_ACCESS No message is available to read. * \return One of the standard error codes for implementation-defined * errors. */ @@ -194,9 +194,9 @@ struct mod_smt_to_transport_api { * \param payload Payload data to write. * \param size Size of the payload data. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The payload parameter is NULL. - * \retval FWK_E_PARAM The offset and size provided are not within the + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The payload parameter is NULL. + * \retval ::FWK_E_PARAM The offset and size provided are not within the * bounds of the payload area. * \return One of the standard error codes for implementation-defined * errors. @@ -212,11 +212,11 @@ struct mod_smt_to_transport_api { * been written. * \param size Size of the payload source. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The size parameter is less than the size of one + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The size parameter is less than the size of one * payload entry. - * \retval FWK_E_ACCESS No message is available to respond to. + * \retval ::FWK_E_ACCESS No message is available to respond to. * \return One of the standard error codes for implementation-defined * errors. */ @@ -234,8 +234,8 @@ struct mod_smt_from_transport_api { * * \param service_id service identifier. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The service_id parameter is invalid. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The service_id parameter is invalid. * \return One of the standard error codes for implementation-defined * errors. */ @@ -246,9 +246,9 @@ struct mod_smt_from_transport_api { * * \param service_id Service identifier. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The secure parameter is NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The secure parameter is NULL. * \return One of the standard error codes for implementation-defined * errors. */ diff --git a/module/system_info/include/mod_system_info.h b/module/system_info/include/mod_system_info.h index ef5870e5..02889e78 100644 --- a/module/system_info/include/mod_system_info.h +++ b/module/system_info/include/mod_system_info.h @@ -101,8 +101,8 @@ struct mod_system_info_get_info_api { * * \param[out] sys_info Pointer to the system information data. * - * \retval FWK_SUCCESS if the sys_info pointer has been successfully set. - * \retval FWK_E_SUPPORT if the system information is not supported by the + * \retval ::FWK_SUCCESS if the sys_info pointer has been successfully set. + * \retval ::FWK_E_SUPPORT if the system information is not supported by the * product. */ int (*get_system_info)(const struct mod_system_info **sys_info); diff --git a/module/timer/include/mod_timer.h b/module/timer/include/mod_timer.h index 45e0a522..daa1282b 100644 --- a/module/timer/include/mod_timer.h +++ b/module/timer/include/mod_timer.h @@ -122,8 +122,8 @@ struct mod_timer_api { * \param dev_id Element identifier that identifies the timer device. * \param[out] frequency The timer frequency. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM The frequency pointer was invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM The frequency pointer was invalid. * \retval One of the other specific error codes described by the framework. */ int (*get_frequency)(fwk_id_t dev_id, uint32_t *frequency); @@ -139,8 +139,8 @@ struct mod_timer_api { * \param microseconds Period, in microseconds. * \param[out] timestamp The resulting counter timestamp. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM The timestamp pointer was invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM The timestamp pointer was invalid. * \retval One of the other specific error codes described by the framework. */ int (*time_to_timestamp)(fwk_id_t dev_id, @@ -156,8 +156,8 @@ struct mod_timer_api { * \param dev_id Element identifier that identifies the timer device. * \param[out] counter The counter value. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM The counter pointer was invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM The counter pointer was invalid. * \retval One of the other specific error codes described by the framework. */ int (*get_counter)(fwk_id_t dev_id, uint64_t *counter); @@ -171,7 +171,7 @@ struct mod_timer_api { * \param dev_id Element identifier that identifies the timer device. * \param microseconds The amount of time, given in microseconds, to delay. * - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_SUCCESS Operation succeeded. * \retval One of the other specific error codes described by the framework. */ int (*delay)(fwk_id_t dev_id, uint32_t microseconds); @@ -191,10 +191,10 @@ struct mod_timer_api { * or until the timeout period has elapsed. * \param data Pointer passed to the condition function when it is called. * - * \retval FWK_SUCCESS The condition was met before the timeout period + * \retval ::FWK_SUCCESS The condition was met before the timeout period * elapsed. - * \retval FWK_E_TIMEOUT The timeout period elapsed before the condition was - * met. + * \retval ::FWK_E_TIMEOUT The timeout period elapsed before the condition + * was met. * \retval One of the other specific error codes described by the framework. */ int (*wait)(fwk_id_t dev_id, @@ -215,8 +215,8 @@ struct mod_timer_api { * \param[out] remaining_ticks The remaining number of ticks before * the timer value reaches the given timestamp. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM The remaining_ticks pointer was invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM The remaining_ticks pointer was invalid. * \retval One of the other specific error codes described by the framework. * * \note remaining_ticks is also a timestamp. @@ -238,8 +238,8 @@ struct mod_timer_api { * \param [out] remaining_ticks Number of ticks between now and the next * alarm trigger of the timer identified by \p dev_id. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM One of the parameters is invalid. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM One of the parameters is invalid. * \return One of the other specific error codes described by the framework. */ int (*get_next_alarm_remaining)(fwk_id_t dev_id, @@ -277,9 +277,9 @@ struct mod_timer_alarm_api { * \pre \p alarm_id must be a valid sub-element alarm identifier that has * previously been bound to. * - * \retval FWK_E_ACCESS The function was called from an interrupt handler + * \retval ::FWK_E_ACCESS The function was called from an interrupt handler * OR could not attain call context. - * \retval FWK_SUCCESS The alarm was started. + * \retval ::FWK_SUCCESS The alarm was started. */ int (*start)(fwk_id_t alarm_id, unsigned int milliseconds, @@ -299,12 +299,12 @@ struct mod_timer_alarm_api { * \pre \p alarm_id must be a valid sub-element alarm identifier that has * previously been bound to. * - * \retval FWK_SUCCESS The alarm was stopped. - * \retval FWK_E_STATE The alarm was already stopped. - * \retval FWK_E_ACCESS The function was called from an interrupt handler + * \retval ::FWK_SUCCESS The alarm was stopped. + * \retval ::FWK_E_STATE The alarm was already stopped. + * \retval ::FWK_E_ACCESS The function was called from an interrupt handler * different from the interrupt handler of the timer the alarm is * associated to OR could not attain call context. - * \retval FWK_E_INIT The component has not been initialized. + * \retval ::FWK_E_INIT The component has not been initialized. */ int (*stop)(fwk_id_t alarm_id); }; diff --git a/product/juno/module/juno_dmc400/include/mod_juno_dmc400.h b/product/juno/module/juno_dmc400/include/mod_juno_dmc400.h index 2df9598a..7ad4ee7f 100644 --- a/product/juno/module/juno_dmc400/include/mod_juno_dmc400.h +++ b/product/juno/module/juno_dmc400/include/mod_juno_dmc400.h @@ -433,8 +433,8 @@ struct mod_juno_dmc400_ddr_phy_api { * \param element_id Element identifier corresponding to the device to * configure. * - * \retval FWK_E_DATA No data found for the element. - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_DATA No data found for the element. + * \retval ::FWK_SUCCESS Operation succeeded. * \return One of the standard framework error codes. */ int (*configure_ddr)(fwk_id_t element_id); @@ -445,7 +445,7 @@ struct mod_juno_dmc400_ddr_phy_api { * \param module_id Module identifier corresponding to the device to * configure. * - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_SUCCESS Operation succeeded. * \return One of the standard framework error codes. */ int (*configure_clk)(fwk_id_t module_id); @@ -456,8 +456,8 @@ struct mod_juno_dmc400_ddr_phy_api { * \param element_id Element identifier corresponding to the device to * configure. * - * \retval FWK_E_DATA No data found for the element. - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_DATA No data found for the element. + * \retval ::FWK_SUCCESS Operation succeeded. * \return One of the standard framework error codes. */ int (*configure_idle)(fwk_id_t element_id); @@ -469,7 +469,7 @@ struct mod_juno_dmc400_ddr_phy_api { * configure. * \param enable Flag to indicate the retention operation. * - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_SUCCESS Operation succeeded. * \return One of the standard framework error codes. */ int (*configure_retention)(fwk_id_t module_id, bool enable); diff --git a/product/juno/module/juno_hdlcd/include/mod_juno_hdlcd.h b/product/juno/module/juno_hdlcd/include/mod_juno_hdlcd.h index 90c98216..bc25a36e 100644 --- a/product/juno/module/juno_hdlcd/include/mod_juno_hdlcd.h +++ b/product/juno/module/juno_hdlcd/include/mod_juno_hdlcd.h @@ -105,8 +105,8 @@ struct mod_juno_hdlcd_drv_api { * \param index The index of the lookup table that contains the information * to set the rate of the clock. * - * \retval FWK_SUCCESS The request is successful. - * \retval FWK_E_PARAM One or more parameters are incorrect. + * \retval ::FWK_SUCCESS The request is successful. + * \retval ::FWK_E_PARAM One or more parameters are incorrect. * * \return Status code representing the result of the operation. */ diff --git a/product/juno/module/juno_ppu/include/mod_juno_ppu.h b/product/juno/module/juno_ppu/include/mod_juno_ppu.h index 2072a90e..f01d70d2 100644 --- a/product/juno/module/juno_ppu/include/mod_juno_ppu.h +++ b/product/juno/module/juno_ppu/include/mod_juno_ppu.h @@ -124,9 +124,9 @@ struct mod_juno_ppu_rom_api { * \param state The new state for the PPU (defined in the Power Domain * module). * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM An invalid state was given. - * \retval FWK_E_DEVICE The PPU did not accept the new state. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM An invalid state was given. + * \retval ::FWK_E_DEVICE The PPU did not accept the new state. * \return One of the standard framework error codes. */ int (*set_state_and_wait)(fwk_id_t ppu_id, unsigned int state); @@ -137,9 +137,9 @@ struct mod_juno_ppu_rom_api { * \param ppu_id Element identifier of the PPU. * \param[out] state Policy. * - * \retval FWK_SUCCESS Operation succeeded. - * \retval FWK_E_PARAM The \p state parameter was \c NULL. - * \retval FWK_E_DEVICE Device error. + * \retval ::FWK_SUCCESS Operation succeeded. + * \retval ::FWK_E_PARAM The \p state parameter was \c NULL. + * \retval ::FWK_E_DEVICE Device error. * \return One of the standard framework error codes. */ int (*get_state)(fwk_id_t ppu_id, unsigned int *state); diff --git a/product/juno/module/juno_xrp7724/include/mod_juno_xrp7724.h b/product/juno/module/juno_xrp7724/include/mod_juno_xrp7724.h index d35c12dd..3ff3f621 100644 --- a/product/juno/module/juno_xrp7724/include/mod_juno_xrp7724.h +++ b/product/juno/module/juno_xrp7724/include/mod_juno_xrp7724.h @@ -108,7 +108,7 @@ struct mod_juno_xrp7724_api_system_mode { * The caller may get a response through an event in case the request * failed. * - * \retval FWK_PENDING The request was submitted, not yet completed. + * \retval ::FWK_PENDING The request was submitted, not yet completed. * \return One of the standard framework error codes. */ int (*shutdown)(void); @@ -122,7 +122,7 @@ struct mod_juno_xrp7724_api_system_mode { * The caller may get a response through an event in case the request * failed. - * \retval FWK_PENDING The request was submitted, not yet completed. + * \retval ::FWK_PENDING The request was submitted, not yet completed. * \return One of the standard framework error codes. */ int (*reset)(void); diff --git a/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h b/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h index e409af63..dbfd5431 100644 --- a/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h +++ b/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h @@ -258,7 +258,7 @@ struct mod_cmn_skeena_ccix_config_api { * * \param[out] config CCIX host configuration * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*get_config)(struct mod_cmn_skeena_ccix_host_node_config *config); @@ -267,7 +267,7 @@ struct mod_cmn_skeena_ccix_config_api { * * \param[in] config CCIX endpoint configuration * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*set_config)(struct mod_cmn_skeena_ccix_remote_node_config *config); @@ -277,7 +277,7 @@ struct mod_cmn_skeena_ccix_config_api { * \param link_id Link on which the protocol credit exchange * would initiate. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*exchange_protocol_credit)(uint8_t link_id); @@ -287,7 +287,7 @@ struct mod_cmn_skeena_ccix_config_api { * \param link_id Link on which the coherency has to * be enabled. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*enter_system_coherency)(uint8_t link_id); @@ -296,7 +296,7 @@ struct mod_cmn_skeena_ccix_config_api { * * \param link_id Link on which DVM domain has to be enabled * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*enter_dvm_domain)(uint8_t link_id); diff --git a/product/morello/module/dmc_bing/include/mod_dmc_bing.h b/product/morello/module/dmc_bing/include/mod_dmc_bing.h index 58888063..a87dd0cc 100644 --- a/product/morello/module/dmc_bing/include/mod_dmc_bing.h +++ b/product/morello/module/dmc_bing/include/mod_dmc_bing.h @@ -637,7 +637,7 @@ struct mod_dmc_ddr_phy_api { * \param element_id Element identifier corresponding to the device to * configure. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*configure)(fwk_id_t element_id); diff --git a/product/morello/module/morello_smt/include/mod_smt.h b/product/morello/module/morello_smt/include/mod_smt.h index dd4e2dc1..d3e2de62 100644 --- a/product/morello/module/morello_smt/include/mod_smt.h +++ b/product/morello/module/morello_smt/include/mod_smt.h @@ -104,8 +104,8 @@ struct mod_smt_driver_api { * * \param device_id Device identifier * - * \retval FWK_SUCCESS The operation succeeded - * \retval FWK_E_PARAM The device_id parameter is invalid + * \retval ::FWK_SUCCESS The operation succeeded + * \retval ::FWK_E_PARAM The device_id parameter is invalid * \return One of the standard error codes for implementation-defined * errors */ @@ -123,7 +123,7 @@ struct mod_smt_driver_input_api { * * \param device_id Channel identifier * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -141,9 +141,9 @@ struct mod_scmi_to_transport_api { * \param[out] secure The channel security state. True * if the channel is secure, or false if it is non-secure. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The secure parameter is NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The secure parameter is NULL. * \return One of the standard error codes for implementation-defined * errors. */ @@ -155,9 +155,9 @@ struct mod_scmi_to_transport_api { * \param channel_id Channel identifier. * \param[out] size The maximum payload size in bytes. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The size parameter is NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The size parameter is NULL. * \return One of the standard error codes for implementation-defined * errors. */ @@ -169,10 +169,10 @@ struct mod_scmi_to_transport_api { * \param channel_id Channel identifier. * \param[out] message_header The SCMI message header. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The message_header parameter is NULL. - * \retval FWK_E_ACCESS No message is available to read. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The message_header parameter is NULL. + * \retval ::FWK_E_ACCESS No message is available to read. * \return One of the standard error codes for implementation-defined * errors. */ @@ -186,10 +186,10 @@ struct mod_scmi_to_transport_api { * \param[out] size The payload size. May be NULL, in which case the * parameter should be ignored. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The payload parameter is NULL. - * \retval FWK_E_ACCESS No message is available to read. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The payload parameter is NULL. + * \retval ::FWK_E_ACCESS No message is available to read. * \return One of the standard error codes for implementation-defined * errors. */ @@ -203,9 +203,9 @@ struct mod_scmi_to_transport_api { * \param payload Payload data to write. * \param size Size of the payload data. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The payload parameter is NULL. - * \retval FWK_E_PARAM The offset and size provided are not within the + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The payload parameter is NULL. + * \retval ::FWK_E_PARAM The offset and size provided are not within the * bounds of the payload area. * \return One of the standard error codes for implementation-defined * errors. @@ -224,11 +224,11 @@ struct mod_scmi_to_transport_api { * been written. * \param size Size of the payload source. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The size parameter is less than the size of one + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The size parameter is less than the size of one * payload entry. - * \retval FWK_E_ACCESS No message is available to respond to. + * \retval ::FWK_E_ACCESS No message is available to respond to. * \return One of the standard error codes for implementation-defined * errors. */ @@ -257,7 +257,7 @@ struct mod_scmi_agent_to_transport_api { * \param channel_id Channel identifier * \param cmd Pointer to SMT command configuration * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -271,7 +271,7 @@ struct mod_scmi_agent_to_transport_api { * \param[out] size The payload size. May be NULL, in which case the * parameter should be ignored. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -282,7 +282,7 @@ struct mod_scmi_agent_to_transport_api { * * \param channel_id Channel identifier * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ diff --git a/product/morello/module/scmi_agent/include/mod_scmi_agent.h b/product/morello/module/scmi_agent/include/mod_scmi_agent.h index f93c9a61..1c243fcc 100644 --- a/product/morello/module/scmi_agent/include/mod_scmi_agent.h +++ b/product/morello/module/scmi_agent/include/mod_scmi_agent.h @@ -77,7 +77,7 @@ struct mod_scmi_agent_api { * \param agent_id Agent identifier * \param[out] version Protocol version. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -89,7 +89,7 @@ struct mod_scmi_agent_api { * \param agent_id Agent identifier * \param[out] clock_status SCP clock status. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -102,7 +102,7 @@ struct mod_scmi_agent_api { * \param[out] multichip_mode Multi-chip mode value. * \param[out] chipid Chip ID value. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ diff --git a/product/n1sdp/module/n1sdp_c2c/include/mod_n1sdp_c2c_i2c.h b/product/n1sdp/module/n1sdp_c2c/include/mod_n1sdp_c2c_i2c.h index 06420fd3..0c177bce 100644 --- a/product/n1sdp/module/n1sdp_c2c/include/mod_n1sdp_c2c_i2c.h +++ b/product/n1sdp/module/n1sdp_c2c/include/mod_n1sdp_c2c_i2c.h @@ -99,7 +99,7 @@ struct n1sdp_c2c_slave_info_api { * * \param size_gb Pointer to storage where the size is stored. * - * \retval FWK_SUCCESS If operation succeeds. + * \retval ::FWK_SUCCESS If operation succeeds. * \return One of the possible error return codes. */ int (*get_ddr_size_gb)(uint8_t *size_gb); @@ -109,40 +109,41 @@ struct n1sdp_c2c_slave_info_api { * \brief N1SDP C2C power domain API */ struct n1sdp_c2c_pd_api { - /*! - * \brief API to set a power state in remote chip. - * - * \param cmd The C2C command type to issue. - * \param pd_id The target power domain ID. - * \param pd_type The target power domain type. - * - * \retval FWK_SUCCESS If operation succeeds. - * \return One of the possible error return codes. - */ - int (*set_state)(enum n1sdp_c2c_cmd cmd, uint8_t pd_id, uint8_t pd_type); - /*! - * \brief API to get a power state in remote chip. - * - * \param cmd The C2C command type to issue. - * \param pd_id The target power domain ID. - * \param state Current power state in power domain pd_id. - * - * \retval FWK_SUCCESS If operation succeeds. - * \return One of the possible error return codes. - */ - int (*get_state)(enum n1sdp_c2c_cmd cmd, uint8_t pd_id, - unsigned int *state); - /*! - * \brief API to issue shutdown/reboot to remote chip. - * - * \param cmd The C2C command type to issue. - * \param type The shutdown/reboot type to issue. - * - * \retval FWK_SUCCESS If operation succeeds. - * \return One of the possible error return codes. - */ - int (*shutdown_reboot)(enum n1sdp_c2c_cmd cmd, - enum mod_pd_system_shutdown type); + /*! + * \brief API to set a power state in remote chip. + * + * \param cmd The C2C command type to issue. + * \param pd_id The target power domain ID. + * \param pd_type The target power domain type. + * + * \retval ::FWK_SUCCESS If operation succeeds. + * \return One of the possible error return codes. + */ + int (*set_state)(enum n1sdp_c2c_cmd cmd, uint8_t pd_id, uint8_t pd_type); + /*! + * \brief API to get a power state in remote chip. + * + * \param cmd The C2C command type to issue. + * \param pd_id The target power domain ID. + * \param state Current power state in power domain pd_id. + * + * \retval ::FWK_SUCCESS If operation succeeds. + * \return One of the possible error return codes. + */ + int ( + *get_state)(enum n1sdp_c2c_cmd cmd, uint8_t pd_id, unsigned int *state); + /*! + * \brief API to issue shutdown/reboot to remote chip. + * + * \param cmd The C2C command type to issue. + * \param type The shutdown/reboot type to issue. + * + * \retval ::FWK_SUCCESS If operation succeeds. + * \return One of the possible error return codes. + */ + int (*shutdown_reboot)( + enum n1sdp_c2c_cmd cmd, + enum mod_pd_system_shutdown type); }; /*! diff --git a/product/n1sdp/module/n1sdp_dmc620/include/mod_n1sdp_dmc620.h b/product/n1sdp/module/n1sdp_dmc620/include/mod_n1sdp_dmc620.h index 604b3dfd..d697b0db 100644 --- a/product/n1sdp/module/n1sdp_dmc620/include/mod_n1sdp_dmc620.h +++ b/product/n1sdp/module/n1sdp_dmc620/include/mod_n1sdp_dmc620.h @@ -706,7 +706,7 @@ struct mod_dmc_ddr_phy_api { * \param element_id Element identifier corresponding to the device to * configure. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*configure)(fwk_id_t element_id, struct dimm_info *info); @@ -717,7 +717,7 @@ struct mod_dmc_ddr_phy_api { * \param element_id Element identifier corresponding to the device to * configure. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*post_training_configure)(fwk_id_t element_id, @@ -730,7 +730,7 @@ struct mod_dmc_ddr_phy_api { * configure. * \param training_type Training type for which PHY status to be verified. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*verify_phy_status)(fwk_id_t element_id, @@ -744,7 +744,7 @@ struct mod_dmc_ddr_phy_api { * configure. * \param rank The rank number to perform the tuning. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*wrlvl_phy_obs_regs)(fwk_id_t element_id, @@ -758,7 +758,7 @@ struct mod_dmc_ddr_phy_api { * configure. * \param rank The rank number to perform the tuning. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*read_gate_phy_obs_regs)(fwk_id_t element_id, @@ -772,7 +772,7 @@ struct mod_dmc_ddr_phy_api { * configure. * \param rank The rank number to perform the tuning. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return one of the error code otherwise. */ int (*phy_obs_regs)(fwk_id_t element_id, @@ -789,7 +789,7 @@ struct mod_dmc620_mem_info_api { * * \param size Pointer where memory size will be stored. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \retval one of the error code otherwise. */ int (*get_mem_size_gb)(uint32_t *size); diff --git a/product/n1sdp/module/n1sdp_i2c/include/mod_n1sdp_i2c.h b/product/n1sdp/module/n1sdp_i2c/include/mod_n1sdp_i2c.h index edbc556b..60498bd0 100644 --- a/product/n1sdp/module/n1sdp_i2c/include/mod_n1sdp_i2c.h +++ b/product/n1sdp/module/n1sdp_i2c/include/mod_n1sdp_i2c.h @@ -159,7 +159,7 @@ struct mod_n1sdp_i2c_master_api_polled { * \param data Pointer to data buffer. * \param length Data size to be read in bytes. * - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_SUCCESS Operation succeeded. * \return One of the other specific error codes described by the framework. */ int (*read)(fwk_id_t device_id, uint16_t address, char *data, @@ -175,7 +175,7 @@ struct mod_n1sdp_i2c_master_api_polled { * \param stop When set to true indicates end of data transfer and interface * releases the sclk line. * - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_SUCCESS Operation succeeded. * \return One of the other specific error codes described by the framework. */ int (*write)(fwk_id_t device_id, uint16_t address, const char *data, @@ -193,7 +193,7 @@ struct mod_n1sdp_i2c_slave_api_irq { * \param data Pointer to data buffer. * \param length Data size to be read in bytes. * - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_SUCCESS Operation succeeded. * \return One of the other specific error codes described by the framework. */ int (*read)(fwk_id_t device_id, uint8_t *data, uint8_t length); @@ -207,7 +207,7 @@ struct mod_n1sdp_i2c_slave_api_irq { * \param stop When set to true indicates end of data transfer and interface * releases the sclk line. * - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_SUCCESS Operation succeeded. * \return One of the other specific error codes described by the framework. */ int (*write)(fwk_id_t device_id, uint8_t *data, uint8_t length); diff --git a/product/n1sdp/module/n1sdp_pcie/include/mod_n1sdp_pcie.h b/product/n1sdp/module/n1sdp_pcie/include/mod_n1sdp_pcie.h index 2a006138..d4dffe06 100644 --- a/product/n1sdp/module/n1sdp_pcie/include/mod_n1sdp_pcie.h +++ b/product/n1sdp/module/n1sdp_pcie/include/mod_n1sdp_pcie.h @@ -83,88 +83,86 @@ enum n1sdp_pcie_api_idx { * \brief N1SDP PCIe initialization api */ struct n1sdp_pcie_init_api { - /*! - * \brief API to power ON the PCIe controller - * - * \param id Identifier of the PCIe instance - * - * \retval FWK_SUCCESS The operation succeeded. - * \return One of the standard error codes. - */ - int (*power_on)(fwk_id_t id); - - /*! - * \brief API to initialize the PHY layer - * - * \param id Identifier of the PCIe instance - * - * \retval FWK_SUCCESS The operation succeeded. - * \return One of the standard error codes. - */ - int (*phy_init)(fwk_id_t id); - - /*! - * \brief API to initialize the PCIe controller - * - * \param id Identifier of the PCIe instance - * \param ep_mode Identifier to configure the controller - * in root port or endpoint mode - * - * \retval FWK_SUCCESS The operation succeeded. - * \return One of the standard error codes. - */ - int (*controller_init)(fwk_id_t id, bool ep_mode); - - /*! - * \brief API to perform the link training process - * - * \param id Identifier of the PCIe instance - * - * \retval FWK_SUCCESS The operation succeeded. - * \return One of the standard error codes. - */ - int (*link_training)(fwk_id_t id, bool ep_mode); - - /*! - * \brief API to setup the root complex - * - * \param id Identifier of the PCIe instance - * - * \retval FWK_SUCCESS The operation succeeded. - * \return One of the standard error codes. - */ - int (*rc_setup)(fwk_id_t id); - - /*! - * \brief API to enable Virtual Channel 1 and map to - * specified Traffic class. This API is used in multichip mode. - * - * \param id Identifier of the PCIe instance - * \param vc1_tc Traffic class to be mapped to VC1 - * - * \retval FWK_SUCCESS The operation succeeded. - * \return One of the standard error codes. - */ - int (*vc1_setup)(fwk_id_t id, uint8_t vc1_tc); + /*! + * \brief API to power ON the PCIe controller + * + * \param id Identifier of the PCIe instance + * + * \retval ::FWK_SUCCESS The operation succeeded. + * \return One of the standard error codes. + */ + int (*power_on)(fwk_id_t id); + + /*! + * \brief API to initialize the PHY layer + * + * \param id Identifier of the PCIe instance + * + * \retval ::FWK_SUCCESS The operation succeeded. + * \return One of the standard error codes. + */ + int (*phy_init)(fwk_id_t id); + /*! + * \brief API to initialize the PCIe controller + * + * \param id Identifier of the PCIe instance + * \param ep_mode Identifier to configure the controller + * in root port or endpoint mode + * + * \retval ::FWK_SUCCESS The operation succeeded. + * \return One of the standard error codes. + */ + int (*controller_init)(fwk_id_t id, bool ep_mode); + + /*! + * \brief API to perform the link training process + * + * \param id Identifier of the PCIe instance + * + * \retval ::FWK_SUCCESS The operation succeeded. + * \return One of the standard error codes. + */ + int (*link_training)(fwk_id_t id, bool ep_mode); + + /*! + * \brief API to setup the root complex + * + * \param id Identifier of the PCIe instance + * + * \retval ::FWK_SUCCESS The operation succeeded. + * \return One of the standard error codes. + */ + int (*rc_setup)(fwk_id_t id); + + /*! + * \brief API to enable Virtual Channel 1 and map to + * specified Traffic class. This API is used in multichip mode. + * + * \param id Identifier of the PCIe instance + * \param vc1_tc Traffic class to be mapped to VC1 + * + * \retval ::FWK_SUCCESS The operation succeeded. + * \return One of the standard error codes. + */ + int (*vc1_setup)(fwk_id_t id, uint8_t vc1_tc); }; /*! * \brief N1SDP PCIe ccix configuration api */ struct n1sdp_pcie_ccix_config_api { - /*! - * \brief Enable the optimized tlp (Transaction Layer Packet) - * for the ccix root complex - * - * \param enable Enable optimized tlp (true) or disable it (false) - * and thus enable pcie compatible header - * - * \retval FWK_SUCCESS The operation succeeded. - * \return One of the standard error codes. - */ - int (*enable_opt_tlp)(bool enable); - + /*! + * \brief Enable the optimized tlp (Transaction Layer Packet) + * for the ccix root complex + * + * \param enable Enable optimized tlp (true) or disable it (false) + * and thus enable pcie compatible header + * + * \retval ::FWK_SUCCESS The operation succeeded. + * \return One of the standard error codes. + */ + int (*enable_opt_tlp)(bool enable); }; /*! diff --git a/product/n1sdp/module/n1sdp_scp2pcc/include/mod_n1sdp_scp2pcc.h b/product/n1sdp/module/n1sdp_scp2pcc/include/mod_n1sdp_scp2pcc.h index d88bb973..7e30c936 100644 --- a/product/n1sdp/module/n1sdp_scp2pcc/include/mod_n1sdp_scp2pcc.h +++ b/product/n1sdp/module/n1sdp_scp2pcc/include/mod_n1sdp_scp2pcc.h @@ -56,7 +56,7 @@ struct mod_n1sdp_scp2pcc_api { * \param size Size of the payload to be sent. * \param type Indicates the type of payload sent. * - * \retval FWK_SUCCESS Operation succeeded. + * \retval ::FWK_SUCCESS Operation succeeded. * \return One of the other specific error codes described by the framework. */ int (*send)(void *data, uint16_t size, uint16_t type); diff --git a/product/n1sdp/module/n1sdp_smt/include/mod_smt.h b/product/n1sdp/module/n1sdp_smt/include/mod_smt.h index 06285b11..1ec099e4 100644 --- a/product/n1sdp/module/n1sdp_smt/include/mod_smt.h +++ b/product/n1sdp/module/n1sdp_smt/include/mod_smt.h @@ -104,8 +104,8 @@ struct mod_smt_driver_api { * * \param device_id Device identifier * - * \retval FWK_SUCCESS The operation succeeded - * \retval FWK_E_PARAM The device_id parameter is invalid + * \retval ::FWK_SUCCESS The operation succeeded + * \retval ::FWK_E_PARAM The device_id parameter is invalid * \return One of the standard error codes for implementation-defined * errors */ @@ -123,7 +123,7 @@ struct mod_smt_driver_input_api { * * \param device_id Channel identifier * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -141,9 +141,9 @@ struct mod_scmi_to_transport_api { * \param[out] secure The channel security state. True * if the channel is secure, or false if it is non-secure. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The secure parameter is NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The secure parameter is NULL. * \return One of the standard error codes for implementation-defined * errors. */ @@ -155,9 +155,9 @@ struct mod_scmi_to_transport_api { * \param channel_id Channel identifier. * \param[out] size The maximum payload size in bytes. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The size parameter is NULL. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The size parameter is NULL. * \return One of the standard error codes for implementation-defined * errors. */ @@ -169,10 +169,10 @@ struct mod_scmi_to_transport_api { * \param channel_id Channel identifier. * \param[out] message_header The SCMI message header. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The message_header parameter is NULL. - * \retval FWK_E_ACCESS No message is available to read. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The message_header parameter is NULL. + * \retval ::FWK_E_ACCESS No message is available to read. * \return One of the standard error codes for implementation-defined * errors. */ @@ -186,10 +186,10 @@ struct mod_scmi_to_transport_api { * \param[out] size The payload size. May be NULL, in which case the * parameter should be ignored. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The payload parameter is NULL. - * \retval FWK_E_ACCESS No message is available to read. + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The payload parameter is NULL. + * \retval ::FWK_E_ACCESS No message is available to read. * \return One of the standard error codes for implementation-defined * errors. */ @@ -204,9 +204,9 @@ struct mod_scmi_to_transport_api { * \param payload Payload data to write. * \param size Size of the payload data. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The payload parameter is NULL. - * \retval FWK_E_PARAM The offset and size provided are not within the + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The payload parameter is NULL. + * \retval ::FWK_E_PARAM The offset and size provided are not within the * bounds of the payload area. * \return One of the standard error codes for implementation-defined * errors. @@ -222,11 +222,11 @@ struct mod_scmi_to_transport_api { * been written. * \param size Size of the payload source. * - * \retval FWK_SUCCESS The operation succeeded. - * \retval FWK_E_PARAM The channel_id parameter is invalid. - * \retval FWK_E_PARAM The size parameter is less than the size of one + * \retval ::FWK_SUCCESS The operation succeeded. + * \retval ::FWK_E_PARAM The channel_id parameter is invalid. + * \retval ::FWK_E_PARAM The size parameter is less than the size of one * payload entry. - * \retval FWK_E_ACCESS No message is available to respond to. + * \retval ::FWK_E_ACCESS No message is available to respond to. * \return One of the standard error codes for implementation-defined * errors. */ @@ -255,7 +255,7 @@ struct mod_scmi_agent_to_transport_api { * \param channel_id Channel identifier * \param cmd Pointer to SMT command configuration * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -269,7 +269,7 @@ struct mod_scmi_agent_to_transport_api { * \param[out] size The payload size. May be NULL, in which case the * parameter should be ignored. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -281,7 +281,7 @@ struct mod_scmi_agent_to_transport_api { * * \param channel_id Channel identifier * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ diff --git a/product/n1sdp/module/n1sdp_timer_sync/include/mod_n1sdp_timer_sync.h b/product/n1sdp/module/n1sdp_timer_sync/include/mod_n1sdp_timer_sync.h index 8bb2d677..fa08505f 100644 --- a/product/n1sdp/module/n1sdp_timer_sync/include/mod_n1sdp_timer_sync.h +++ b/product/n1sdp/module/n1sdp_timer_sync/include/mod_n1sdp_timer_sync.h @@ -41,24 +41,24 @@ enum mod_n1sdp_timer_sync_api_idx { * \brief N1SDP Timer Synchronization API */ struct n1sdp_timer_sync_api { - /*! - * \brief API to trigger synchronization in master. - * - * \param id Identifier of the timer sync module. - * - * \retval FWK_SUCCESS If operation succeeds. - * \return One of the possible error return codes. - */ - int (*master_sync)(fwk_id_t id); - /*! - * \brief API to trigger synchronization in slave. - * - * \param id Identifier of the timer sync module. - * - * \retval FWK_SUCCESS If operation succeeds. - * \return One of the possible error return codes. - */ - int (*slave_sync)(fwk_id_t id); + /*! + * \brief API to trigger synchronization in master. + * + * \param id Identifier of the timer sync module. + * + * \retval ::FWK_SUCCESS If operation succeeds. + * \return One of the possible error return codes. + */ + int (*master_sync)(fwk_id_t id); + /*! + * \brief API to trigger synchronization in slave. + * + * \param id Identifier of the timer sync module. + * + * \retval ::FWK_SUCCESS If operation succeeds. + * \return One of the possible error return codes. + */ + int (*slave_sync)(fwk_id_t id); }; /*! diff --git a/product/n1sdp/module/scmi_agent/include/mod_scmi_agent.h b/product/n1sdp/module/scmi_agent/include/mod_scmi_agent.h index 8a168e94..ac08d9de 100644 --- a/product/n1sdp/module/scmi_agent/include/mod_scmi_agent.h +++ b/product/n1sdp/module/scmi_agent/include/mod_scmi_agent.h @@ -77,7 +77,7 @@ struct mod_scmi_agent_api { * \param agent_id Agent identifier * \param[out] version Protocol version. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -89,7 +89,7 @@ struct mod_scmi_agent_api { * \param agent_id Agent identifier * \param[out] clock_status SCP clock status. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ @@ -102,7 +102,7 @@ struct mod_scmi_agent_api { * \param[out] multichip_mode Multi-chip mode value. * \param[out] chipid Chip ID value. * - * \retval FWK_SUCCESS The operation succeeded. + * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined * errors. */ diff --git a/product/sgm775/module/sgm775_dmc500/include/mod_sgm775_dmc500.h b/product/sgm775/module/sgm775_dmc500/include/mod_sgm775_dmc500.h index 5b8f5e2c..19bd89ed 100644 --- a/product/sgm775/module/sgm775_dmc500/include/mod_sgm775_dmc500.h +++ b/product/sgm775/module/sgm775_dmc500/include/mod_sgm775_dmc500.h @@ -445,7 +445,7 @@ struct mod_sgm775_dmc_ddr_phy_api { * \param element_id Element identifier corresponding to the device to * configure. * - * \retval FWK_SUCCESS if the operation succeed. + * \retval ::FWK_SUCCESS if the operation succeed. * \return One of the standard framework error codes. */ int (*configure)(fwk_id_t element_id); |