External/motor-control-sdk
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Pull request #89: am243x/am263x: docs: Fix build errors

Browse Source 
Merge in PINDSW/motor_control_sdk from PINDSW-7138_fix_docs to next

* commit '01ab30a8bb76035531f4a1a78d66be8f508ec20e':
  am243x/am263x: docs: Fix build errors
This commit is contained in:
Dhaval Khandla 2023-12-21 04:28:11 -06:00 committed by Pratheesh Gangadhar TK
commit 59537cb532
8 changed files with 49 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs_src/docs/api_guide/components/pruicss_pwm/pruicss_pwm.md
View File

@ -1,8 +1,8 @@
# PRUICSS PWM {#PRUICSS_PWM} # PRU-ICSS PWM {#PRUICSS_PWM}
[TOC] [TOC]
The PRUICSS PWM driver provides API to program Intial, Trip, Active states of PWM outputs. The PRU-ICSS PWM driver provides API to program Intial, Trip, Active states of PWM outputs.
Below are the high level features supported by the driver. Below are the high level features supported by the driver.
## Features Supported ## Features Supported

5
docs_src/docs/api_guide/components/transforms/transforms.md
View File

@ -67,16 +67,17 @@ A benchmark on R5F core has been conducted to observe the following results when
</tr> </tr>
</table> </table>
\* Note both PARK and IPARK does not include trigonometric calculations of phasor. For R5F core, it's recommened to leverage the fast ti_arm_sincos() function found in ti_arm_trig/mathlib of MCU+ SDK. \note both PARK and IPARK does not include trigonometric calculations of phasor. For R5F core, it's recommened to leverage the fast ti_arm_sincos() function found in ti_arm_trig/mathlib of MCU+ SDK.
- Ran with TI Clang Compiler v3.2.0.LTS, with -Os flag and functions force-inlined onto the benchmarking function placed in TCM memory. Obtained the average result from 600 consecutive loops of running transform functions with DPL CycleCountP, mimicking the usage of a control loop. - Ran with TI Clang Compiler v3.2.0.LTS, with -Os flag and functions force-inlined onto the benchmarking function placed in TCM memory. Obtained the average result from 600 consecutive loops of running transform functions with DPL CycleCountP, mimicking the usage of a control loop.
- Actual result may vary depending on provided datasets and memory configuration. For R5F, it is recommended for users to map control loops to TCM for the best performance. - Actual result may vary depending on provided datasets and memory configuration. For R5F, it is recommended for users to map control loops to TCM for the best performance.
## Provided Examples ## Provided Examples
The following examples has been provided to demonstrate transformation module: The following examples has been provided to demonstrate transformation module:
- \ref EXAMPLES_TRANSFORMS_TEST - \ref EXAMPLES_TRANSFORMS_TEST
## Additional References {#DCL_ADDITIONAL_REFERENCES} ## Additional References {#TRANSFORMS_ADDITIONAL_REFERENCES}
N/A N/A

1
docs_src/docs/api_guide/device/am243x/includes.cfg
View File

@ -14,6 +14,7 @@ INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/rele
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/examples.cfg @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/examples.cfg
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/components.cfg @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/components.cfg
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/dcl/dcl.cfg @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/dcl/dcl.cfg
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/transforms/transforms.cfg
# Used to selectively pick DEVICE specific sections within .md files # Used to selectively pick DEVICE specific sections within .md files
ENABLED_SECTIONS = SOC_AM243X ENABLED_SECTIONS = SOC_AM243X

1
docs_src/docs/api_guide/device/am263x/includes.cfg
View File

@ -14,6 +14,7 @@ INPUT += $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/rele
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/examples.cfg @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/examples.cfg
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/components.cfg @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/device/$(DEVICE)/components.cfg
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/dcl/dcl.cfg @INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/dcl/dcl.cfg
@INCLUDE = $(MOTOR_CONTROL_SDK_PATH)/docs_src/docs/api_guide/components/transforms/transforms.cfg
# Used to selectively pick DEVICE specific sections within .md files # Used to selectively pick DEVICE specific sections within .md files
ENABLED_SECTIONS = SOC_AM263X ENABLED_SECTIONS = SOC_AM263X

9
docs_src/docs/api_guide/doxygen.cfg
View File

@ -21,7 +21,7 @@
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
PROJECT_NUMBER = 09.00.00 PROJECT_NUMBER = 09.01.00
# Using the PROJECT_BRIEF tag one can provide an optional one line description # Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a # for a project that appears at the top of each page and should give viewer a
@ -1908,7 +1908,7 @@ ENABLE_PREPROCESSING = YES
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and # the macro expansion is limited to the macros specified with the PREDEFINED and
@ -1916,7 +1916,7 @@ MACRO_EXPANSION = NO
# The default value is: NO. # The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO EXPAND_ONLY_PREDEF = YES
# If the SEARCH_INCLUDES tag is set to YES the includes files in the # If the SEARCH_INCLUDES tag is set to YES the includes files in the
# INCLUDE_PATH will be searched if a #include is found. # INCLUDE_PATH will be searched if a #include is found.
@ -1951,7 +1951,8 @@ INCLUDE_FILE_PATTERNS = *.h
PREDEFINED = PTCP_SUPPORT \ PREDEFINED = PTCP_SUPPORT \
IRT_LEGACY_STARTUP_SUPPORT \ IRT_LEGACY_STARTUP_SUPPORT \
MRP_SUPPORT \ MRP_SUPPORT \
WATCHDOG_SUPPORT WATCHDOG_SUPPORT \
__attribute__(x)=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The # tag can be used to specify a list of macro names that should be expanded. The

14
source/current_sense/sdfm/include/sdfm_api.h
View File

@ -300,7 +300,8 @@ void SDFM_setFilterOverSamplingRatio(sdfm_handle h_sdfm, uint16_t nc_osr);
* *
*/ */
uint32_t SDFM_getFirmwareVersion(sdfm_handle h_sdfm); uint32_t SDFM_getFirmwareVersion(sdfm_handle h_sdfm);
/*
/**
* \brief This API Configure Fast detect block fields. * \brief This API Configure Fast detect block fields.
* *
* \param[in] h_sdfm SDFM handle * \param[in] h_sdfm SDFM handle
@ -312,18 +313,18 @@ uint32_t SDFM_getFirmwareVersion(sdfm_handle h_sdfm);
*/ */
void SDFM_configFastDetect(sdfm_handle h_sdfm, uint8_t ch, uint8_t *fdParms); void SDFM_configFastDetect(sdfm_handle h_sdfm, uint8_t ch, uint8_t *fdParms);
/* /**
* \brief This API returns the fast detect error status for specified SDFM channel number. * \brief This API returns the fast detect error status for specified SDFM channel number.
* *
* \param[in] h_sdfm SDFM handle * \param[in] h_sdfm SDFM handle
* \param[in] \param[in] chNum SDFM channel number : Channel0-Channel8 * \param[in] chNum SDFM channel number : Channel0-Channel8
* *
* \retval stauts of fd error: 1 means error available & 0 means no error, SystemP_FAILURE on not expected API parameters * \retval stauts of fd error: 1 means error available & 0 means no error, SystemP_FAILURE on not expected API parameters
* *
*/ */
int32_t SDFM_getFastDetectErrorStatus(sdfm_handle h_sdfm, uint8_t chNum); int32_t SDFM_getFastDetectErrorStatus(sdfm_handle h_sdfm, uint8_t chNum);
/* /**
* \brief Clear PWM trip status of the corresponding PWM trip zone block for specified SDFM channel number. * \brief Clear PWM trip status of the corresponding PWM trip zone block for specified SDFM channel number.
* *
* \param[in] h_sdfm SDFM handle * \param[in] h_sdfm SDFM handle
@ -332,6 +333,7 @@ int32_t SDFM_getFastDetectErrorStatus(sdfm_handle h_sdfm, uint8_t chNum);
* \retval SystemP_SUCCESS on success, SystemP_FAILURE on error or not expected API parameters * \retval SystemP_SUCCESS on success, SystemP_FAILURE on error or not expected API parameters
*/ */
int32_t SDFM_clearPwmTripStatus(sdfm_handle h_sdfm, uint8_t chNum); int32_t SDFM_clearPwmTripStatus(sdfm_handle h_sdfm, uint8_t chNum);
/** /**
* *
* \brief This API enables continuous normal current sampling * \brief This API enables continuous normal current sampling
@ -341,15 +343,17 @@ int32_t SDFM_clearPwmTripStatus(sdfm_handle h_sdfm, uint8_t chNum);
* *
*/ */
void SDFM_enableContinuousNormalCurrent(sdfm_handle h_sdfm); void SDFM_enableContinuousNormalCurrent(sdfm_handle h_sdfm);
/** /**
* *
* \brief This API enables load share mode * \brief This API enables load share mode
* *
* \param[in] h_sdfm SDFM handle * \param[in] h_sdfm SDFM handle
* \param[in] sliceID slice ID * \param[in] sliceId slice ID
* *
*/ */
void SDFM_enableLoadShareMode(sdfm_handle h_sdfm, uint8_t sliceId); void SDFM_enableLoadShareMode(sdfm_handle h_sdfm, uint8_t sliceId);
/** /**
* *
* \brief Measure Clock phase compensation * \brief Measure Clock phase compensation

4
source/position_sense/hdsl/include/hdsl_drv.h
View File

@ -461,7 +461,7 @@ int32_t HDSL_read_pc_short_msg(HDSL_Handle hdslHandle, uint8_t addr, uint8_t *da
* \param[in] addr 10 bit address for long message * \param[in] addr 10 bit address for long message
* \param[in] offsetEnable Addressing with offset enable/disable from \ref HDSL_LongMessageAddrOffsetModes * \param[in] offsetEnable Addressing with offset enable/disable from \ref HDSL_LongMessageAddrOffsetModes
* \param[in] addrType Addressing Type from \ref HDSL_LongMessageAddrTypes * \param[in] addrType Addressing Type from \ref HDSL_LongMessageAddrTypes
* \param[in] length Length from \ref HDSL_LongMessageLength * \param[in] length Length from \ref HDSL_LongMessageLengths
* \param[in] offset 15 bit address offset for long message (if offset is enabled in offsetEnable parameter) * \param[in] offset 15 bit address offset for long message (if offset is enabled in offsetEnable parameter)
* \param[in] timeout Timeout in microseconds * \param[in] timeout Timeout in microseconds
* *
@ -477,7 +477,7 @@ int32_t HDSL_write_pc_long_msg(HDSL_Handle hdslHandle, uint16_t addr, uint8_t of
* \param[in] addr 10 bit address for long message * \param[in] addr 10 bit address for long message
* \param[in] offsetEnable Addressing with offset enable/disable from \ref HDSL_LongMessageAddrOffsetModes * \param[in] offsetEnable Addressing with offset enable/disable from \ref HDSL_LongMessageAddrOffsetModes
* \param[in] addrType Addressing Type from \ref HDSL_LongMessageAddrTypes * \param[in] addrType Addressing Type from \ref HDSL_LongMessageAddrTypes
* \param[in] length Length from \ref HDSL_LongMessageLength * \param[in] length Length from \ref HDSL_LongMessageLengths
* \param[in] offset 15 bit address offset for long message * \param[in] offset 15 bit address offset for long message
* \param[in] timeout Timeout in microseconds * \param[in] timeout Timeout in microseconds
* *

8
source/transforms/svgen/svgen.h
View File

@ -40,7 +40,7 @@ extern "C"
/** /**
* \addtogroup TRANSFORMS_API_MODULE APIs for motor transformations * \addtogroup TRANSFORMS_API_MODULE APIs for motor transformations
* \@{ * @{
* *
* \file svgen.h * \file svgen.h
* \brief Contains svpwm generation implementation * \brief Contains svpwm generation implementation
@ -55,7 +55,7 @@ typedef float float32_t;
//! \brief Implements a SVM that subtracts common-mode term to achieve SV modulation. //! \brief Implements a SVM that subtracts common-mode term to achieve SV modulation.
//! \param[in] oneOverDcBUS_invV The inverse dc bus voltage scale factor, used to convert inputs to pu, use 1 if units are already in pu. //! \param[in] oneOverDcBus_invV The inverse dc bus voltage scale factor, used to convert inputs to pu, use 1 if units are already in pu.
//! \param[in] inValpha Input voltage value in alpha-axis, V or pu //! \param[in] inValpha Input voltage value in alpha-axis, V or pu
//! \param[in] inVbeta Input voltage value in beta-axis, V or pu //! \param[in] inVbeta Input voltage value in beta-axis, V or pu
//! \param[in] pVa Output pointer to voltage value in a-axis, pu //! \param[in] pVa Output pointer to voltage value in a-axis, pu
@ -121,7 +121,7 @@ void SVGEN_runCom(const float32_t oneOverDcBus_invV, const float32_t inValpha, c
} }
//! \brief Implements a DPWM that uses maximum modulation. //! \brief Implements a DPWM that uses maximum modulation.
//! \param[in] oneOverDcBUS_invV The inverse dc bus voltage scale factor, used to convert inputs to pu, use 1 if units are already in pu. //! \param[in] oneOverDcBus_invV The inverse dc bus voltage scale factor, used to convert inputs to pu, use 1 if units are already in pu.
//! \param[in] inValpha Input voltage value in alpha-axis, V or pu //! \param[in] inValpha Input voltage value in alpha-axis, V or pu
//! \param[in] inVbeta Input voltage value in beta-axis, V or pu //! \param[in] inVbeta Input voltage value in beta-axis, V or pu
//! \param[in] pVa Output pointer to voltage value in a-axis, pu //! \param[in] pVa Output pointer to voltage value in a-axis, pu
@ -176,7 +176,7 @@ void SVGEN_runMax(const float32_t oneOverDcBus_invV, const float32_t inValpha, c
} }
//! \brief Implements a DPWM that uses minimum modulation. //! \brief Implements a DPWM that uses minimum modulation.
//! \param[in] oneOverDcBUS_invV The inverse dc bus voltage scale factor, used to convert inputs to pu, use 1 if units are already in pu. //! \param[in] oneOverDcBus_invV The inverse dc bus voltage scale factor, used to convert inputs to pu, use 1 if units are already in pu.
//! \param[in] inValpha Input voltage value in alpha-axis, V or pu //! \param[in] inValpha Input voltage value in alpha-axis, V or pu
//! \param[in] inVbeta Input voltage value in beta-axis, V or pu //! \param[in] inVbeta Input voltage value in beta-axis, V or pu
//! \param[in] pVa Output pointer to voltage value in a-axis, pu //! \param[in] pVa Output pointer to voltage value in a-axis, pu