diff options
author | Chris Kay <chris.kay@arm.com> | 2020-09-28 12:38:49 +0100 |
---|---|---|
committer | jimqui01 <54316584+jimqui01@users.noreply.github.com> | 2020-10-02 14:19:09 +0100 |
commit | 691839e0c23cd6b836a39029e0639b9f62d6b46a (patch) | |
tree | 63c4f0de7b1d57a9c6f7417f7bff807019087a3d | |
parent | 3361c3269a4c6b053a39766c945a8be1611ce5c7 (diff) |
docs: Normalize Doxygen paragraph indentation
Doxygen continutation line intendation across the code-base is currently
inconsistent in spite of the code-style documentation specifying a
two-tab indent on continuation lines.
Change-Id: I0944d749042972797bde1997f02afd98d4028c1a
Signed-off-by: Chris Kay <chris.kay@arm.com>
27 files changed, 162 insertions, 160 deletions
diff --git a/framework/include/fwk_list.h b/framework/include/fwk_list.h index fcf4040a..197e2fe1 100644 --- a/framework/include/fwk_list.h +++ b/framework/include/fwk_list.h @@ -154,7 +154,8 @@ * \brief Remove a node from a linked list. * * \details In debug mode, the node being removed has its links set to \c NULL - * to ensure the node no longer references the list it has been removed from. + * to ensure the node no longer references the list it has been removed + * from. * * \param list Pointer to the list to remove the node from. Must not be \c NULL. * \param node Pointer to the node to remove. Must not be \c NULL. The node must diff --git a/framework/include/fwk_macros.h b/framework/include/fwk_macros.h index f0d96234..e073db87 100644 --- a/framework/include/fwk_macros.h +++ b/framework/include/fwk_macros.h @@ -145,7 +145,7 @@ * \param b The second value to compare. * * \note The __auto_type extension is used to normalize the types and to protect - * against double evaluation. + * against double evaluation. * * \return The smallest value from a and b. If both are equal, b is returned. */ @@ -164,7 +164,7 @@ * \param b The second value to compare. * * \note The __auto_type extension is used to normalize the types and to protect - * against double evaluation. + * against double evaluation. * * \return The largest value from a and b. If both are equal, b is returned. */ @@ -179,10 +179,10 @@ * \brief Firmware version in UINT32_T format * * \details The macro encodes a 'major, minor and patch' based version data - * into a 32 bits value using the following schema: - * [31:24] Major field - * [23:16] Minor field - * [15:0] Patch field + * into a 32 bits value using the following schema: + * [31:24] Major field + * [23:16] Minor field + * [15:0] Patch field * * \return None. */ diff --git a/framework/include/fwk_mm.h b/framework/include/fwk_mm.h index b94e5b4b..989f81e4 100644 --- a/framework/include/fwk_mm.h +++ b/framework/include/fwk_mm.h @@ -98,7 +98,7 @@ void *fwk_mm_alloc(size_t num, size_t size) FWK_LEAF FWK_NOTHROW FWK_ALLOC * * \return On success, returns the pointer to the beginning of newly allocated * memory. To avoid a memory leak, the returned pointer must be - * deallocated with ::fwk_mm_free() or ::fwk_mm_realloc(). + * deallocated with ::fwk_mm_free() or ::fwk_mm_realloc(). * * \return On failure, returns a null pointer. */ diff --git a/module/cmn600/include/mod_cmn600.h b/module/cmn600/include/mod_cmn600.h index 63222a39..f44f1a9b 100644 --- a/module/cmn600/include/mod_cmn600.h +++ b/module/cmn600/include/mod_cmn600.h @@ -148,8 +148,8 @@ struct mod_cmn600_config { /*! * \brief HN-F with CAL support flag * \details When set to true, enables HN-F with CAL support. This flag will - * be used only if HN-F is found to be connected to CAL (When connected to - * a CAL port, node id of HN-F will be a odd number). + * be used only if HN-F is found to be connected to CAL (When connected + * to a CAL port, node id of HN-F will be a odd number). */ bool hnf_cal_mode; }; diff --git a/module/cmn_booker/include/mod_cmn_booker.h b/module/cmn_booker/include/mod_cmn_booker.h index 28e5c53b..df854e6e 100644 --- a/module/cmn_booker/include/mod_cmn_booker.h +++ b/module/cmn_booker/include/mod_cmn_booker.h @@ -124,8 +124,8 @@ struct mod_cmn_booker_config { /*! * \brief HN-F with CAL support flag * \details When set to true, enables HN-F with CAL support. This flag will - * be used only if HN-F is found to be connected to CAL (When connected to - * a CAL port, node id of HN-F will be a odd number). + * be used only if HN-F is found to be connected to CAL (When connected + * to a CAL port, node id of HN-F will be a odd number). */ bool hnf_cal_mode; }; diff --git a/module/cmn_rhodes/include/mod_cmn_rhodes.h b/module/cmn_rhodes/include/mod_cmn_rhodes.h index 123692ff..9c169ab0 100644 --- a/module/cmn_rhodes/include/mod_cmn_rhodes.h +++ b/module/cmn_rhodes/include/mod_cmn_rhodes.h @@ -87,9 +87,9 @@ struct mod_cmn_rhodes_mem_region_map { * \brief Target node identifier * * \note Not used for \ref - * mod_cmn_rhodes_mem_region_type.MOD_CMN_RHODES_REGION_TYPE_SYSCACHE_SUB - * memory regions as it uses the pool of HN-F nodes available in the - * system + * mod_cmn_rhodes_mem_region_type.MOD_CMN_RHODES_REGION_TYPE_SYSCACHE_SUB + * memory regions as it uses the pool of HN-F nodes available in the + * system */ unsigned int node_id; }; @@ -98,15 +98,15 @@ struct mod_cmn_rhodes_mem_region_map { * \brief Remote Agent to Link ID mapping * * \details Each CCIX Gateway block (CXG) can communicate up to three remote - * CCIX protocol links. Each remote agent, identified by their AgentID (RAID - * or HAID) will be behind one of these three links. This structure holds the - * start and end Agent IDs for each link. The remote AgentID to LinkID LUT - * registers (por_{cxg_ra,cxg_ha, cxla}_agentid_to_linkid_reg<X>) will be - * configured sequentially from \ref - * mod_cmn_rhodes_agentid_to_linkid_map.remote_agentid_start - * and \ref mod_cmn_rhodes_agentid_to_linkid_map.remote_agentid_end values. For - * all three links, corresponding to these remote Agent IDs, HN-F's RN_PHYS_ID - * registers will be programmed with the node id of the CXG Gateway block. + * CCIX protocol links. Each remote agent, identified by their AgentID + * (RAID or HAID) will be behind one of these three links. This structure + * holds the start and end Agent IDs for each link. The remote AgentID to + * LinkID LUT registers (por_{cxg_ra,cxg_ha, + * cxla}_agentid_to_linkid_reg<X>) will be configured sequentially from + * \ref mod_cmn_rhodes_agentid_to_linkid_map.remote_agentid_start and \ref + * mod_cmn_rhodes_agentid_to_linkid_map.remote_agentid_end values. For all + * three links, corresponding to these remote Agent IDs, HN-F's RN_PHYS_ID + * registers will be programmed with the node id of the CXG Gateway block. * */ struct mod_cmn_rhodes_agentid_to_linkid_map { @@ -119,7 +119,7 @@ struct mod_cmn_rhodes_agentid_to_linkid_map { /*! * \brief Remote Memory region map descriptor which will be used by CXRA SAM - * programming + * programming */ struct mod_cmn_rhodes_ra_mem_region_map { /*! Base address */ @@ -136,10 +136,11 @@ struct mod_cmn_rhodes_ra_mem_region_map { * \brief CCIX Gateway block descriptor * * \details Each CCIX Gateway block (CXG) can have up to eight remote memory map - * \ref mod_cmn_rhodes_ra_mem_region_map descriptors and can have three links - * which can target range of remote agent ids. User is expected to assign an - * Home AgentID (HAID) \ref mod_cmn_rhodes_ccix_config.haid for each logical ids - * of the CXG blocks. Overall structure of the descriptor is shown below: + * \ref mod_cmn_rhodes_ra_mem_region_map descriptors and can have three + * links which can target range of remote agent ids. User is expected to + * assign an Home AgentID (HAID) \ref mod_cmn_rhodes_ccix_config.haid for + * each logical ids of the CXG blocks. Overall structure of the descriptor + * is shown below: * * +----------------------------------------------------------+ * | mod_cmn_rhodes_ccix_config<ldid> | @@ -251,8 +252,8 @@ struct mod_cmn_rhodes_config { /*! * \brief HN-F with CAL support flag * \details When set to true, enables HN-F with CAL support. This flag will - * be used only if HN-F is found to be connected to CAL (When connected to - * a CAL port, node id of HN-F will be a odd number). + * be used only if HN-F is found to be connected to CAL (When connected + * to a CAL port, node id of HN-F will be a odd number). */ bool hnf_cal_mode; }; diff --git a/module/debug/include/mod_debug.h b/module/debug/include/mod_debug.h index b1b61cea..9296473a 100644 --- a/module/debug/include/mod_debug.h +++ b/module/debug/include/mod_debug.h @@ -81,7 +81,7 @@ struct mod_debug_api { * \param id Debug device identifier. * * \param enable Targeted state for Debug, true for enabled, false - * otherwise. + * otherwise. * * \param user_id The user requesting the Debug functionality. * @@ -90,7 +90,7 @@ struct mod_debug_api { * \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. + * perform the requested action. * \return One of the standard framework error codes. */ int (*set_enabled)(fwk_id_t id, bool enable, enum scp_debug_user user_id); @@ -101,7 +101,7 @@ struct mod_debug_api { * \param id Debug device identifier. * * \param[out] enabled State of Debug, true for enabled, false - * otherwise. + * otherwise. * * \param user_id The user requesting the Debug enabled status. * @@ -110,7 +110,7 @@ struct mod_debug_api { * \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. + * perform the requested action. * \return One of the standard framework error codes. */ int (*get_enabled)(fwk_id_t id, bool *enabled, enum scp_debug_user user_id); @@ -146,7 +146,7 @@ struct mod_debug_driver_api { * \param id Debug driver identifier. * * \param enable Targeted state the driver true for enabled, false - * otherwise. + * otherwise. * * \param user_id The user requesting the Debug driver functionality. * @@ -163,7 +163,7 @@ struct mod_debug_driver_api { * \param id Debug driver identifier. * * \param[out] enabled State of Debug, true for enabled, false - * otherwise. + * otherwise. * * \param user_id The user requesting the Debug driver enabled status. * diff --git a/module/dvfs/include/mod_dvfs.h b/module/dvfs/include/mod_dvfs.h index e0d6aa8f..c9832b7e 100644 --- a/module/dvfs/include/mod_dvfs.h +++ b/module/dvfs/include/mod_dvfs.h @@ -108,7 +108,7 @@ struct mod_dvfs_domain_config { /*! \brief Allow inexact performance levels. * * \note It will set any immediately higher than the requested value if it - * is possible, otherwise it will set the highest possible. + * is possible, otherwise it will set the highest possible. */ bool approximate_level; }; diff --git a/module/fip/include/mod_fip.h b/module/fip/include/mod_fip.h index 57b90bb0..d07d2814 100644 --- a/module/fip/include/mod_fip.h +++ b/module/fip/include/mod_fip.h @@ -26,7 +26,7 @@ * \brief Provides an API to access firmware image partitions. * * \details This module provides a table of descriptors that each describe a - * block of firmware image entry in the underlying storage. + * block of firmware image entry in the underlying storage. * * \{ */ diff --git a/module/power_domain/include/mod_power_domain.h b/module/power_domain/include/mod_power_domain.h index 2d38f8a7..b3c2efd5 100644 --- a/module/power_domain/include/mod_power_domain.h +++ b/module/power_domain/include/mod_power_domain.h @@ -29,7 +29,7 @@ * \defgroup GroupPowerDomain Power Domains * * \details Support for querying and setting the power state of power domains - * such as CPU, cluster and GPU power domains. + * such as CPU, cluster and GPU power domains. * * \{ */ @@ -842,8 +842,8 @@ struct pd_set_state_response { * \brief Copy of the "composite_state" request parameter * * \details The composite state that defines the power state that the power - * domain, target of the request, had to be put into and possibly the power - * states the ancestors of the power domain had to be put into. + * domain, target of the request, had to be put into and possibly the + * power states the ancestors of the power domain had to be put into. */ uint32_t composite_state; }; @@ -860,8 +860,8 @@ struct pd_get_state_response { * \brief Copy of the "state" request parameter * * \details The power state of the power domain target of the request or - * the composite state of the power domain and its ancestors depending on - * the value of the "composite" request parameter. + * the composite state of the power domain and its ancestors depending + * on the value of the "composite" request parameter. */ uint32_t state; }; diff --git a/module/resource_perms/include/mod_resource_perms.h b/module/resource_perms/include/mod_resource_perms.h index ac2fefd4..0a9e3b2c 100644 --- a/module/resource_perms/include/mod_resource_perms.h +++ b/module/resource_perms/include/mod_resource_perms.h @@ -75,8 +75,8 @@ enum mod_res_perms_protocol_deny { struct mod_res_agent_protocol_permissions { /*! * \details This bitmask specifies which protocols are DISABLED for this - * agent. If a bit is set that agent does NOT have permission to - * use the protocol. + * agent. If a bit is set that agent does NOT have permission to + * use the protocol. */ mod_res_perms_t protocols; }; @@ -133,26 +133,26 @@ struct mod_res_agent_msg_permissions { /*! * \brief Bitmask of the resources for each protocol:command disabled for - * the agent. + * the agent. * * \details Each protocol will manage a unique number of commands, so - * we specify different size tables. + * we specify different size tables. * * If the permissions table is not set then the agent is deemed - * to be allowed access that protocol:command:resource. They will - * be checked in order protocol->command->resource. + * to be allowed access that protocol:command:resource. They will + * be checked in order protocol->command->resource. * * In order for a protocol to be disabled for an agent, the - * bit must be SET in the agent_protocol_permissions table. + * bit must be SET in the agent_protocol_permissions table. * * In order for a command to be disabled for an agent, the - * bit must be SET in the agent_cmd_permissions table. + * bit must be SET in the agent_cmd_permissions table. * * In order for a resource to be disabled for an agent, the - * bit must be SET in the agent_permission table. + * bit must be SET in the agent_permission table. * * \note The VERSION/ATTRIBUTES/MSG_ATTRIBUTES commands - * are available to all agents. + * are available to all agents. * * \note The BASE and SYSTEM_POWER protocols are managed by * agent:protocol:command, there are no resource diff --git a/module/scmi/include/internal/scmi.h b/module/scmi/include/internal/scmi.h index 0b036171..10d43f3c 100644 --- a/module/scmi/include/internal/scmi.h +++ b/module/scmi/include/internal/scmi.h @@ -37,10 +37,11 @@ enum scmi_role { * - a PSCI implementation on AP processors. * - a management agent. * - an OSPM. - * The POWER_STATE_SET command targeting a power domain, including AP cores, is - * processed only if issued by a PSCI agent. The processing of the - * SYSTEM_POWER_STATE_SET command depends on the type of the agent that issued - * it. The OTHER type is added here to cover the other type of agents. + * The POWER_STATE_SET command targeting a power domain, including AP + * cores, is processed only if issued by a PSCI agent. The processing of + * the SYSTEM_POWER_STATE_SET command depends on the type of the agent that + * issued it. The OTHER type is added here to cover the other type of + * agents. */ enum scmi_agent_type { /*! PSCI agent */ @@ -65,7 +66,7 @@ enum scmi_agent_type { * \details Defines the channel direction in terms of the master to the slave. * * \note The integer values of this enumeration are based on the master of - * communications in that configuration. + * communications in that configuration. */ enum scmi_channel_type { /*!< Agent-to-platform */ diff --git a/module/scmi/include/mod_scmi.h b/module/scmi/include/mod_scmi.h index a2cd2d9f..a3b23ada 100644 --- a/module/scmi/include/mod_scmi.h +++ b/module/scmi/include/mod_scmi.h @@ -163,13 +163,13 @@ struct mod_scmi_to_transport_api { * * \param channel_id Channel identifier. * \param[out] secure Channel security state. True if the channel - * is secure, or false if it is non-secure. + * 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. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_secure)(fwk_id_t channel_id, bool *secure); @@ -183,7 +183,7 @@ struct mod_scmi_to_transport_api { * \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. + * errors. */ int (*get_max_payload_size)(fwk_id_t channel_id, size_t *size); @@ -198,7 +198,7 @@ struct mod_scmi_to_transport_api { * \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. + * errors. */ int (*get_message_header)(fwk_id_t channel_id, uint32_t *message_header); @@ -208,14 +208,14 @@ struct mod_scmi_to_transport_api { * \param channel_id Channel identifier. * \param[out] payload Pointer to the payload. * \param[out] size Payload size. May be NULL, in which case the - * parameter should be ignored. + * 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. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_payload)(fwk_id_t channel_id, const void **payload, size_t *size); @@ -231,9 +231,9 @@ struct mod_scmi_to_transport_api { * \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. + * bounds of the payload area. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*write_payload)(fwk_id_t channel_id, size_t offset, const void *payload, size_t size); @@ -243,16 +243,16 @@ struct mod_scmi_to_transport_api { * * \param channel_id Channel identifier. * \param payload Payload data to write, or NULL if a payload has already - * been written. + * 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 - * payload entry. + * payload entry. * \retval ::FWK_E_ACCESS No message is available to respond to. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*respond)(fwk_id_t channel_id, const void *payload, size_t size); @@ -267,9 +267,9 @@ struct mod_scmi_to_transport_api { * \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. + * payload entry. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*transmit)(fwk_id_t channel_id, uint32_t message_header, const void *payload, size_t size); @@ -281,8 +281,8 @@ struct mod_scmi_to_transport_api { struct mod_scmi_from_transport_api { /*! * \brief Signal to a SCMI service that a incoming message for it has - * incorrect length and payload size and so the incoming message has been - * dropped. + * incorrect length and payload size and so the incoming message has + * been dropped. * * \note Subscribed SCMI service should call the respond API to free the * channel. @@ -292,7 +292,7 @@ struct mod_scmi_from_transport_api { * \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. + * errors. */ int (*signal_error)(fwk_id_t service_id); @@ -305,7 +305,7 @@ struct mod_scmi_from_transport_api { * \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. + * errors. */ int (*signal_message)(fwk_id_t service_id); }; @@ -375,7 +375,7 @@ struct mod_scmi_notification_api { * * \retval ::FWK_SUCCESS Initialization successful. * \retval One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*scmi_notification_init)( unsigned int protocol_id, @@ -415,7 +415,7 @@ struct mod_scmi_notification_api { * \retval ::FWK_SUCCESS Removing of subscriber agent from the list is * successful. * \retval One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*scmi_notification_remove_subscriber)( unsigned int protocol_id, @@ -436,7 +436,7 @@ struct mod_scmi_notification_api { * * \retval ::FWK_SUCCESS Notification to agents is successful. * \retval One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*scmi_notification_notify)( unsigned int protocol_id, @@ -503,7 +503,7 @@ struct mod_scmi_from_protocol_api { * \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. + * errors. */ int (*get_max_payload_size)(fwk_id_t service_id, size_t *size); @@ -520,7 +520,7 @@ struct mod_scmi_from_protocol_api { * \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. + * errors. */ int (*write_payload)(fwk_id_t service_id, size_t offset, const void *payload, size_t size); @@ -530,7 +530,7 @@ struct mod_scmi_from_protocol_api { * * \param service_id Service identifier. * \param payload Payload data to write, or NULL if a payload has already - * been written. + * been written. * \param size Size of the payload. */ void (*respond)(fwk_id_t service_id, const void *payload, size_t size); @@ -549,10 +549,9 @@ struct mod_scmi_from_protocol_api { const void *payload, size_t size); }; - /*! * \brief Identify if an SCMI entity is the communications master for a given - * channel type. + * channel type. * * \param type Channel type. * \param role Entity role. @@ -568,7 +567,7 @@ static inline bool mod_scmi_is_master(enum scmi_channel_type type, /*! * \brief Identify if an SCMI entity is the communications slave for a given - * channel type. + * channel type. * * \param type Channel type. * \param role Entity role. diff --git a/module/scmi_clock/include/mod_scmi_clock.h b/module/scmi_clock/include/mod_scmi_clock.h index 8249db0c..e10d9b64 100644 --- a/module/scmi_clock/include/mod_scmi_clock.h +++ b/module/scmi_clock/include/mod_scmi_clock.h @@ -114,7 +114,7 @@ struct mod_scmi_clock_config { * \details The SCMI policy handlers are weak definitions to allow a platform * to implement a policy appropriate to that platform. The SCMI * clock policy functions may be overridden in the - * `product/<platform>/src` directory. + * `product/<platform>/src` directory. * * \note The `rate`/`round_mode`/`state` values may be changed by the policy * handlers. diff --git a/module/scmi_perf/include/mod_scmi_perf.h b/module/scmi_perf/include/mod_scmi_perf.h index 617c02db..79dfe9b2 100644 --- a/module/scmi_perf/include/mod_scmi_perf.h +++ b/module/scmi_perf/include/mod_scmi_perf.h @@ -152,7 +152,7 @@ enum scmi_perf_api_idx { * \details The SCMI policy handlers are weak definitions to allow a platform * to implement a policy appropriate to that platform. The SCMI * performance policy functions may be overridden in the - * `product/<platform>/src` directory. + * `product/<platform>/src` directory. * * \note The `level`/`range` values may be changed by the policy handlers. * \note See `product/juno/src/juno_scmi_clock.c` for an example policy diff --git a/module/scmi_power_domain/include/mod_scmi_power_domain.h b/module/scmi_power_domain/include/mod_scmi_power_domain.h index 414efbbb..bb6a6db7 100644 --- a/module/scmi_power_domain/include/mod_scmi_power_domain.h +++ b/module/scmi_power_domain/include/mod_scmi_power_domain.h @@ -53,7 +53,7 @@ struct mod_scmi_pd_config { * \details The SCMI policy handlers are weak definitions to allow a platform * to implement a policy appropriate to that platform. The SCMI * power domain policy functions may be overridden in the - * `product/<platform>/src` directory. + * `product/<platform>/src` directory. * * \note The `state` value may be changed by the policy handler. * \note See `product/juno/src/juno_scmi_clock.c` for an example policy diff --git a/module/scmi_system_power/include/mod_scmi_system_power.h b/module/scmi_system_power/include/mod_scmi_system_power.h index 45893efd..ec0cdeaf 100644 --- a/module/scmi_system_power/include/mod_scmi_system_power.h +++ b/module/scmi_system_power/include/mod_scmi_system_power.h @@ -80,7 +80,7 @@ struct mod_scmi_system_power_config { * \details The SCMI policy handlers are weak definitions to allow a platform * to implement a policy appropriate to that platform. The SCMI * system power policy functions may be overridden in the - * `product/<platform>/src` directory. + * `product/<platform>/src` directory. * * \note The `state` data may be modified by the policy handler. * \note See `product/juno/src/juno_scmi_clock.c` for an example policy diff --git a/module/smt/include/mod_smt.h b/module/smt/include/mod_smt.h index e3655982..2774ba4f 100644 --- a/module/smt/include/mod_smt.h +++ b/module/smt/include/mod_smt.h @@ -18,7 +18,7 @@ * \name Channel policies * * \details These policies define attributes that affect how the channel is - * treated by the SMT component. + * treated by the SMT component. * * \{ */ @@ -96,7 +96,7 @@ struct mod_smt_driver_api { * \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 + * errors */ int (*raise_interrupt)(fwk_id_t device_id); }; @@ -114,14 +114,14 @@ struct mod_smt_driver_input_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*signal_message)(fwk_id_t channel_id); }; /*! * \brief SMT transport API. - * SMT transport API for Non SCMI Shared Memory Transport messages + * SMT transport API for Non SCMI Shared Memory Transport messages */ struct mod_smt_to_transport_api { /*! @@ -129,13 +129,13 @@ struct mod_smt_to_transport_api { * * \param channel_id Channel identifier. * \param[out] secure Channel security state. True if the channel - * is secure, or false if it is non-secure. + * 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. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_secure)(fwk_id_t channel_id, bool *secure); @@ -149,7 +149,7 @@ struct mod_smt_to_transport_api { * \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. + * errors. */ int (*get_max_payload_size)(fwk_id_t channel_id, size_t *size); @@ -164,7 +164,7 @@ struct mod_smt_to_transport_api { * \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. + * errors. */ int (*get_message_header)(fwk_id_t channel_id, uint32_t *message_header); @@ -174,14 +174,14 @@ struct mod_smt_to_transport_api { * \param channel_id Channel identifier. * \param[out] payload Pointer to the payload. * \param[out] size Payload size. May be NULL, in which case the - * parameter should be ignored. + * 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. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_payload)(fwk_id_t channel_id, const void **payload, size_t *size); @@ -197,9 +197,9 @@ struct mod_smt_to_transport_api { * \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. + * bounds of the payload area. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*write_payload)(fwk_id_t channel_id, size_t offset, const void *payload, size_t size); @@ -209,16 +209,16 @@ struct mod_smt_to_transport_api { * * \param channel_id Channel identifier. * \param payload Payload data to write, or NULL if a payload has already - * been written. + * 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 - * payload entry. + * payload entry. * \retval ::FWK_E_ACCESS No message is available to respond to. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*respond)(fwk_id_t channel_id, const void *payload, size_t size); }; @@ -230,14 +230,15 @@ struct mod_smt_to_transport_api { struct mod_smt_from_transport_api { /*! * \brief Signal to a service that a incoming message for it has incorrect - * length and payload size and so the incoming message has been dropped. + * length and payload size and so the incoming message has been + * dropped. * * \param service_id service identifier. * * \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. + * errors. */ int (*signal_error)(fwk_id_t service_id); @@ -250,7 +251,7 @@ struct mod_smt_from_transport_api { * \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. + * errors. */ int (*signal_message)(fwk_id_t service_id); }; diff --git a/module/timer/include/mod_timer.h b/module/timer/include/mod_timer.h index 92d03249..a5edf29b 100644 --- a/module/timer/include/mod_timer.h +++ b/module/timer/include/mod_timer.h @@ -213,7 +213,7 @@ struct mod_timer_api { * \param dev_id Element identifier that identifies the timer device. * \param timestamp Timestamp to compare to the current timer value. * \param[out] remaining_ticks The remaining number of ticks before - * the timer value reaches the given timestamp. + * the timer value reaches the given timestamp. * * \retval ::FWK_SUCCESS Operation succeeded. * \retval ::FWK_E_PARAM The remaining_ticks pointer was invalid. 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 94960b84..b33145ac 100644 --- a/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h +++ b/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h @@ -148,8 +148,8 @@ struct mod_cmn_skeena_config { /*! * \brief HN-F with CAL support flag * \details When set to true, enables HN-F with CAL support. This flag will - * be used only if HN-F is found to be connected to CAL (When connected to - * a CAL port, node id of HN-F will be a odd number). + * be used only if HN-F is found to be connected to CAL (When connected + * to a CAL port, node id of HN-F will be a odd number). */ bool hnf_cal_mode; }; 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 75e7d3d2..6e8a4e78 100644 --- a/product/morello/module/dmc_bing/include/mod_dmc_bing.h +++ b/product/morello/module/dmc_bing/include/mod_dmc_bing.h @@ -29,8 +29,7 @@ * Technical Reference Manual for details on the specific registers that * are programmed here. * - * \sa - * https://developer.arm.com/docs/100568/latest/programmers-model/register-summary + * \sa https://developer.arm.com/docs/100568/latest/programmers-model/register-summary * \{ */ diff --git a/product/morello/module/morello_smt/include/mod_smt.h b/product/morello/module/morello_smt/include/mod_smt.h index 6b012eb9..27d062c1 100644 --- a/product/morello/module/morello_smt/include/mod_smt.h +++ b/product/morello/module/morello_smt/include/mod_smt.h @@ -18,7 +18,7 @@ * \name Channel policies * * \details These policies define attributes that affect how the channel is - * treated by the SMT component. + * treated by the SMT component. * * \{ */ @@ -107,7 +107,7 @@ struct mod_smt_driver_api { * \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 + * errors */ int (*raise_interrupt)(fwk_id_t device_id); }; @@ -125,7 +125,7 @@ struct mod_smt_driver_input_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*signal_message)(fwk_id_t channel_id); }; @@ -139,13 +139,13 @@ struct mod_scmi_to_transport_api { * * \param channel_id Channel identifier. * \param[out] secure The channel security state. True - * if the channel is secure, or false if it is non-secure. + * 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. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_secure)(fwk_id_t channel_id, bool *secure); @@ -159,7 +159,7 @@ struct mod_scmi_to_transport_api { * \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. + * errors. */ int (*get_max_payload_size)(fwk_id_t channel_id, size_t *size); @@ -174,7 +174,7 @@ struct mod_scmi_to_transport_api { * \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. + * errors. */ int (*get_message_header)(fwk_id_t channel_id, uint32_t *message_header); @@ -184,14 +184,14 @@ struct mod_scmi_to_transport_api { * \param channel_id Channel identifier. * \param[out] payload The pointer to the payload. * \param[out] size The payload size. May be NULL, in which case the - * parameter should be ignored. + * 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. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_payload)(fwk_id_t channel_id, const void **payload, size_t *size); @@ -206,9 +206,9 @@ struct mod_scmi_to_transport_api { * \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. + * bounds of the payload area. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*write_payload)( fwk_id_t channel_id, @@ -221,16 +221,16 @@ struct mod_scmi_to_transport_api { * * \param channel_id Channel identifier. * \param payload Payload data to write, or NULL if a payload has already - * been written. + * 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 - * payload entry. + * payload entry. * \retval ::FWK_E_ACCESS No message is available to respond to. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*respond)(fwk_id_t channel_id, const void *payload, size_t size); }; @@ -259,7 +259,7 @@ struct mod_scmi_agent_to_transport_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*send)(fwk_id_t channel_id, struct mod_smt_command_config *cmd); @@ -269,11 +269,11 @@ struct mod_scmi_agent_to_transport_api { * \param channel_id Channel identifier. * \param[out] payload The pointer to the payload. * \param[out] size The payload size. May be NULL, in which case the - * parameter should be ignored. + * parameter should be ignored. * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_payload)(fwk_id_t channel_id, const void **payload, size_t *size); @@ -284,7 +284,7 @@ struct mod_scmi_agent_to_transport_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*put_channel)(fwk_id_t channel_id); }; 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 5ca4acee..b5873798 100644 --- a/product/morello/module/scmi_agent/include/mod_scmi_agent.h +++ b/product/morello/module/scmi_agent/include/mod_scmi_agent.h @@ -79,7 +79,7 @@ struct mod_scmi_agent_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_protocol_version)(fwk_id_t agent_id, uint32_t *version); @@ -91,7 +91,7 @@ struct mod_scmi_agent_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_clock_status)(fwk_id_t agent_id, uint32_t *clock_status); @@ -104,7 +104,7 @@ struct mod_scmi_agent_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_chipid_info)( fwk_id_t agent_id, 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 02008788..9c108e5d 100644 --- a/product/n1sdp/module/n1sdp_pcie/include/mod_n1sdp_pcie.h +++ b/product/n1sdp/module/n1sdp_pcie/include/mod_n1sdp_pcie.h @@ -24,7 +24,7 @@ * \brief Driver support for N1SDP PCIe Root Complex & End Point devices. * * \details This module provides driver support for enabling and configuring - * the PCIe peripheral either in root complex mode or in end point mode. + * the PCIe peripheral either in root complex mode or in end point mode. * * \{ */ @@ -108,7 +108,7 @@ struct n1sdp_pcie_init_api { * * \param id Identifier of the PCIe instance * \param ep_mode Identifier to configure the controller - * in root port or endpoint mode + * in root port or endpoint mode * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes. @@ -137,7 +137,7 @@ struct n1sdp_pcie_init_api { /*! * \brief API to enable Virtual Channel 1 and map to - * specified Traffic class. This API is used in multichip mode. + * 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 @@ -154,10 +154,10 @@ struct n1sdp_pcie_init_api { struct n1sdp_pcie_ccix_config_api { /*! * \brief Enable the optimized tlp (Transaction Layer Packet) - * for the ccix root complex + * for the ccix root complex * * \param enable Enable optimized tlp (true) or disable it (false) - * and thus enable pcie compatible header + * and thus enable pcie compatible header * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes. diff --git a/product/n1sdp/module/n1sdp_smt/include/mod_smt.h b/product/n1sdp/module/n1sdp_smt/include/mod_smt.h index ca415165..8f9f7d8f 100644 --- a/product/n1sdp/module/n1sdp_smt/include/mod_smt.h +++ b/product/n1sdp/module/n1sdp_smt/include/mod_smt.h @@ -18,7 +18,7 @@ * \name Channel policies * * \details These policies define attributes that affect how the channel is - * treated by the SMT component. + * treated by the SMT component. * * \{ */ @@ -107,7 +107,7 @@ struct mod_smt_driver_api { * \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 + * errors */ int (*raise_interrupt)(fwk_id_t device_id); }; @@ -125,7 +125,7 @@ struct mod_smt_driver_input_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*signal_message)(fwk_id_t channel_id); }; @@ -139,13 +139,13 @@ struct mod_scmi_to_transport_api { * * \param channel_id Channel identifier. * \param[out] secure The channel security state. True - * if the channel is secure, or false if it is non-secure. + * 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. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_secure)(fwk_id_t channel_id, bool *secure); @@ -159,7 +159,7 @@ struct mod_scmi_to_transport_api { * \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. + * errors. */ int (*get_max_payload_size)(fwk_id_t channel_id, size_t *size); @@ -174,7 +174,7 @@ struct mod_scmi_to_transport_api { * \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. + * errors. */ int (*get_message_header)(fwk_id_t channel_id, uint32_t *message_header); @@ -184,14 +184,14 @@ struct mod_scmi_to_transport_api { * \param channel_id Channel identifier. * \param[out] payload The pointer to the payload. * \param[out] size The payload size. May be NULL, in which case the - * parameter should be ignored. + * 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. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_payload)(fwk_id_t channel_id, const void **payload, size_t *size); @@ -207,9 +207,9 @@ struct mod_scmi_to_transport_api { * \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. + * bounds of the payload area. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*write_payload)(fwk_id_t channel_id, size_t offset, const void *payload, size_t size); @@ -219,16 +219,16 @@ struct mod_scmi_to_transport_api { * * \param channel_id Channel identifier. * \param payload Payload data to write, or NULL if a payload has already - * been written. + * 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 - * payload entry. + * payload entry. * \retval ::FWK_E_ACCESS No message is available to respond to. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*respond)(fwk_id_t channel_id, const void *payload, size_t size); }; @@ -257,7 +257,7 @@ struct mod_scmi_agent_to_transport_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*send)(fwk_id_t channel_id, struct mod_smt_command_config *cmd); @@ -267,11 +267,11 @@ struct mod_scmi_agent_to_transport_api { * \param channel_id Channel identifier. * \param[out] payload The pointer to the payload. * \param[out] size The payload size. May be NULL, in which case the - * parameter should be ignored. + * parameter should be ignored. * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_payload)(fwk_id_t channel_id, const void **payload, size_t *size); @@ -283,7 +283,7 @@ struct mod_scmi_agent_to_transport_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*put_channel)(fwk_id_t channel_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 e3ab1464..eb6b10c3 100644 --- a/product/n1sdp/module/scmi_agent/include/mod_scmi_agent.h +++ b/product/n1sdp/module/scmi_agent/include/mod_scmi_agent.h @@ -79,7 +79,7 @@ struct mod_scmi_agent_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_protocol_version)(fwk_id_t agent_id, uint32_t *version); @@ -91,7 +91,7 @@ struct mod_scmi_agent_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_clock_status)(fwk_id_t agent_id, uint32_t *clock_status); @@ -104,7 +104,7 @@ struct mod_scmi_agent_api { * * \retval ::FWK_SUCCESS The operation succeeded. * \return One of the standard error codes for implementation-defined - * errors. + * errors. */ int (*get_chipid_info)(fwk_id_t agent_id, uint8_t *multichip_mode, uint8_t *chipid); diff --git a/product/synquacer/include/system_clock.h b/product/synquacer/include/system_clock.h index aee178aa..9a05465f 100644 --- a/product/synquacer/include/system_clock.h +++ b/product/synquacer/include/system_clock.h @@ -12,7 +12,7 @@ /*! * \brief Calculates the necessary divider for obtaining a target frequency - * from a given clock. + * from a given clock. * * \param CLOCK_RATE The tick rate of the clock to be divided. * |