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

am64x/am243x: pruicss_pwm: update documentation

Browse Source 
-resolve reviewer comments

Fixes: PINDSW-7096

Signed-off-by: Manoj Koppolu <manoj_koppolu@ti.com>
This commit is contained in:
Manoj Koppolu 2023-12-18 14:01:21 +05:30
parent 1f21418819
commit 8fd2c8ce97
5 changed files with 11 additions and 9 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

@ -26,7 +26,9 @@ SysConfig can be used to configure things mentioned below:
## Features NOT Supported
Generate PWM outputs with distinct time period, which means all the PWM outputs will be in sync with respected to each other, without re-programming.
- Generate PWM outputs with distinct time period, which means all the PWM outputs will be in sync with respected to each other, without re-programming.
- Dead band(it will be added in future release)
## Important Note

4
docs_src/docs/api_guide/examples/pruicss_pwm_dutycycle.md
View File

@ -4,8 +4,8 @@
# Introduction
This example generates a signal for a specified time and duty cycle using
PRUICSS PWM. The time and duty cycle can be configured by the user.
This example generates a signal for a specified period and duty cycle using
PRUICSS PWM. The period and duty cycle can be configured by the user.
\cond SOC_AM243X

4
docs_src/docs/api_guide/examples/pruicss_pwm_epwm_sync.md
View File

@ -4,8 +4,8 @@
# Introduction
This example generates a signal for a specified time and duty cycle using
PRUICSS PWM and SOC EPWM. The time and duty cycle can be configured by the user.
This example generates a signal for a specified period and duty cycle using
PRUICSS PWM and SOC EPWM. The period and duty cycle can be configured by the user.
\cond SOC_AM243X

2
examples/pruicss_pwm/pruicss_pwm_epwm_sync/am243x-lp/r5fss0-0_freertos/pruicss_pwm_epwm_sync.c
View File

@ -1,5 +1,5 @@
/*
* Copyright (C) 2021 Texas Instruments Incorporated
* Copyright (C) 2023 Texas Instruments Incorporated
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions

6
source/pruicss_pwm/include/pruicss_pwm.h
View File

@ -236,7 +236,7 @@ extern "C" {
*
* \param handle PRUICSS_Handle returned from PRUICSS_open()
* \param iepInstance 0 for IEP0, 1 for IEP1
* \param value Iep count register lower 32bit value
* \param value IEP count register lower 32bit value
* \return SystemP_SUCCESS on success, SystemP_FAILURE on error
*
*/
@ -247,7 +247,7 @@ int32_t PRUICSS_PWM_setIepCounterLower_32bitValue(PRUICSS_Handle handle, uint8_t
*
* \param handle PRUICSS_Handle returned from PRUICSS_open()
* \param iepInstance 0 for IEP0, 1 for IEP1
* \param value Iep count register upper 32bit value
* \param value IEP count register upper 32bit value
* \return SystemP_SUCCESS on success, SystemP_FAILURE on error
*
*/
@ -510,7 +510,7 @@ int32_t PRUICSS_PWM_actionOnOutputCfgPwmSignalB2(PRUICSS_Handle handle, uint8_t
* \brief This API enables Efficiency mode
* In Efficiency mode Pwm state machine will go from Idle to
* Active and the same time Pwm output will get updated during this
* state transition And Iep Cmp flags will get auto HW cleared
* state transition And IEP Cmp flags will get auto HW cleared
*
* \param handle PRUICSS_Handle returned from PRUICSS_open()
* \param enable 0 for disable, 1 for enable