Starterware XX Migration Guide

Transcription

1 Starterware XX Migration Guide 1 Starterware XX Migration Guide Introduction This document is the Migration Guide for StarterWare from v02.00.xx.xx to v02.01.xx.xx. The purpose of this document is to: Explain differences between StarterWare v02.00.xx.xx to v02.01.xx.xx. Describe some of the architectural and functional improvements in StarterWare over the previous version and give information about why these changes are useful. Give information on how application writers can migrate to this version of StarterWare from the previous version. Terms and Abbreviations Abbreviation DAL SoC EVM ChipDB CCS Description Device Abstraction Layer System On Chip Evaluation Module Chip Database Code Composer Studio This bullet indicates important information. Please read such text carefully. Migration from StarterWare v02.00.xx.xx StarterWare provides a no-os platform support for ARM/DSP based SoCs. StarterWare provides Device Abstraction Layer (DAL) libraries and peripheral/board level sample/demo examples that demonstrate the capabilities of the peripherals. StarterWare v02.01.xx.xx provides a re-structured architecture that enables the following: Directory structure, build system improvements Avoid code repetition Use SoC, board modules to avoid repetition across multiple SoCs and EVMs Add utils for common IPs needed such as I2C, UART console Add app utils to extract out common utility code needed by multiple examples. E.g. MMU utils Auto-generate h/w specific details: IP specs, Chip specs, PRCM, pinmux Improve usability of DAL Clean interfaces, feature-based APIs, consistent APIs & parameters. Documentation improvements Quickly and easily portable to customer boards Examples portable, separate board module

2 Starterware XX Migration Guide 2 Single binary across EVMs of a single SoC Overview of differences The below table gives a high level overview of differences. Additional details are given in later sections. Feature StarterWare v02.00.xx.xx StarterWare v02.01.xx.xx Devices supported Single SoC only within a single package Multiple SoCs within a single package Board support Different binary for each board / EVM Single binary for multiple boards of a single SoC Build system build: Contains all makefiles, project files etc. for building all modules & examples build: Only contains common makerules, scripts etc. for build system. Make-based build system Needs to be built from within build folder Can be built from root folder Data Types Basic data types (e.g. unsigned int) C99 fixed size data types from stdint.h (e.g. uint32_t) Function/type names Inconsistent conventions utils are suffixed by Utils, apps by Apps, and DAL functions with no suffix. SoC specific information Distributed across, including within examples Contained within soc folder Board specific information Examples Pinmux configuration PRCM configuration Interrupt controllers in different SoCs Cache controller / mmu configuration Header files API naming across DAL, utils, examples Macros: Distributed across hw file & DAL. Macro usage API parameters Doxygen API reference documentation Distributed across, including within examples Categorized based on board - one for each soc-board combination Only few pinmux configurations as demonstrated in examples. Only few power sequences can be demonstrated. Remaining have to be figured out by user User calls different APIs for interrupt configuration User calls different APIs for different SoCs All header files, exported/internal in include folder. Difficult to differentiate module-specific headers and internal/exported. No convention followed. Difficult to find out what is in DAL, utils, or examples. Some APIs require user to shift & mask before passing to DAL, others do this in DAL. Hw file macros are directly exposed. Some macros are defined in DAL header. User chooses from macros in hw generated header file and/or dal header file Doxygen documentation for functions in the 'c' file Contained within board folder Categorized based on IP / use case, single for all SoCs & boards. Auto-generated pinmux database with easy-to-use GUI pinmux tool. Generic pinmux APIs Auto-generated PRCM/clock database with generic APIs to enable all scenarios. Generic PRCM APIs Single generic interrupt header file Single generic Cache / MMU header file All exported header files only in include/<module>, internal in module itself. Source files include as <module>/header.h Utils modules have Utils in name (e.g. I2CUtils). Apps have App in name (e.g. GPIOApp). Dals are just IP name (e.g. GPIO) Consistency across DALs, with shift & mask within DALs only. DAL redefines and classifies macros into enums to abstract out IP specific differences Enums are defined in dal header file to group together parameters that can go to specific function. Complete doxygen documentation in the header file. Enables complete definition of the interface within the header files. The below table gives a high level overview of changes in the folder structure

3 Starterware XX Migration Guide 3 StarterWare v2.00.xx.xx module/feature Folder name: drivers Folder name: system_config Folder name: platform Folder name: libs at root - e.g. mmcsdlib, nandlib etc. StarterWare v2.01.xx.xx module/feature Folder name: dal Folder name: soc Folder name: board Folder name: device libs within library folder - e.g. mmcsd, nand etc. Interface differences CACHE The below table lists the file name differences between the versions StarterWare v StarterWare v xx Reason for change \include\armv7a\cache.h include\cache.h The cache API's are made generic across different architectures. include\armv7a\pl310.h Added new file which contains API's for PL310 outer cache controller The below table lists API differences between the versions StarterWare v : API Name StarterWare v xx: API Name StarterWare v xx: Functionality StarterWare v xx: Changes Notes CacheEnable CACHEEnable Enables cache API name updated to follow coding Supports outer cache if registered. CacheDisable CACHEDisable Disables cache API name updated to follow coding Supports outer cache if registered. CacheInstInvalidateAll CACHEInstInvAll Invalidate complete instruction cache CacheInstInvalidateBuff ---- This API is deprecated in the current release CacheDataCleanInvalidateAll CACHEDataCleanInvAll Clean and invaldate complete data cache CacheDataCleanAll CACHEDataCleanAll Clean complete data cache CacheDataInvalidateAll CACHEDataInvAll Invalidate complete data cache API name updated to follow coding Supports outer cache if registered API name updated to follow coding Supports outer cache if registered. API name updated to follow coding Supports outer cache if registered. API name updated to follow coding Supports outer cache if registered. CacheDataCleanBuff CACHEDataCleanRange Clean part of data cache API name updated to follow coding Supports outer cache if registered. CacheDataInvalidateBuff CACHEDataInvRange Invalidate part of data cache API name updated to follow coding Supports outer cache if registered.

4 Starterware XX Migration Guide 4 CacheDataCleanInvalidateBuff CACHEDataCleanInvRange Clean and invalidate part of data cache API name updated to follow coding Supports outer cache if registered CACHERegisterOuterCache Register outer cache CACHELockByWay Lock cache contents by WAY ---- CACHEUnlockByWay Unloca cache contents by WAY The below table lists the deprecated APIs and their equivalent APIs in new starterware Deprecated API Equivalent API Reason for deprecating the API CacheInstInvalidateAll CACHEInstInvAll API name updated to follow coding CacheDataCleanInvalidateAll CACHEDataCleanInvAll API name updated to follow coding CacheDataCleanAll CACHEDataCleanAll API name updated to follow coding CacheDataInvalidateAll CACHEDataInvAll API name updated to follow coding CacheDataCleanBuff CACHEDataCleanRange API name updated to follow coding CacheDataInvalidateBuff CACHEDataInvRange API name updated to follow coding CacheDataCleanInvalidateBuff CACHEDataCleanInvRange API name updated to follow coding MMU The below table lists the file name differences between the versions StarterWare v StarterWare v xx Reason for change \include\armv7a\mmu.h include\mmu.h The cache API's are made generic across different architectures. The below table lists API differences between the versions StarterWare v : API Name StarterWare v xx: API Name StarterWare v xx: Functionality StarterWare v xx: Changes Notes MMUInit MMUInit Initialize the MMU The parameters to this API is changed to make it more generic MMUDisable Disable MMU This is the new API added DMTIMER The below table lists the file name differences between the versions

5 Starterware XX Migration Guide 5 StarterWare v StarterWare v xx Reason for change \drivers\dmtimer.c \dal\dmtimer.c This file provides a register level abstraction of the dmtimer hardware and is not a driver. \examples\dmtimer\dmtimer_app.h Added new file which contains generic API's and data structures for configuring the dmtimer \examples\dmtimer\dmtimer_app.c Added new file which contains generic API's for configuring the dmtimer \examples\dmtimer\countdown_timer\countdown_timer_app.h Added new file which contains count down timer API's \examples\evmam335x\dmtimercounter.c \examples\dmtimer\countdown_timer\countdown_timer_app_main.c. This file serves as the entry point into the count down timer application implements the cdt example. The below table lists API differences between the versions StarterWare v : API Name StarterWare v xx: API Name StarterWare v xx: Functionality StarterWare v xx: Changes Notes DMTimerEnable DMTIMEREnable This API will start/stop the timer depending on the enabledmtimer parameter. DMTimerDisable DMTIMEREnable This API will start/stop the timer depending on the enabledmtimer parameter. DMTimerModeConfigure DMTIMERSetMode Sets operational mode of the timer. DMTimerPreScalerClkEnable DMTIMERPrescalerClkEnable This API will configure and enable the pre-scaler clock. DMTimerCounterSet DMTIMERSetCounterVal Set/Write the Counter register with the counter value DMTimerPreScalerClkDisable DMTIMERPrescalerClkDisable This API will disable the pre-scaler clock. DMTimerCounterGet DMTIMERGetCounterVal Get/Read the counter value from the counter register. DMTimerReloadSet DMTIMERLoadReloadCount Set the reload count value in the timer load register. API name updated to follow coding Added param enabledmtimer so as to start or stop the dmtimer. API name updated to follow coding Added param enabledmtimerso as to start or stop the dmtimer. API name updated to follow coding The macros that can be passed to the parameter modecfg have been grouped into an enum dmtimermode_t. API name updated to follow coding The macros that can be passed to the parameter dividerratio have been grouped into an enum dmtimerprescalerclkdivratio_t. API name updated to follow coding API name updated to follow coding API name updated to follow coding API name updated to follow coding

6 Starterware XX Migration Guide 6 DMTimerReloadGet DMTIMERGetReloadCount Get the reload count value from the timer load register. DMTimerGPOConfigure DMTIMERGpoConfig Configure general purpose output pin DMTimerCompareSet DMTIMERSetCompareVal Set the match register with the compare value DMTimerCompareGet DMTIMERGetCompareVal Get the match register contents DMTimerIntRawStatusSet DMTIMERIntrTrigger Trigger IRQ event in Software DMTimerIntRawStatusGet DMTIMERIntrRawStatus Return the status of IRQSTATUS_RAW register DMTimerIntStatusGet DMTIMERIntrStatus Return the status of interrupts. DMTimerIntStatusClear DMTIMERIntrClear Clear the status of interrupt events DMTimerIntEnable DMTIMERIntrEnable Enable the DMTIMER interrupts DMTimerIntDisable DMTIMERIntrDisable Disable the DMTIMER interrupts DMTimerTriggerSet DMTIMERTriggerTcrrWrite Set/enable the trigger write access DMTimerIntEnableGet DMTIMERGetIntrEnableStatus Returns which of the interrupts are enabled. DMTimerResetConfigure DMTIMERResetEnable Enables or disables soft reset of DMTIMER module. DMTimerReset DMTIMERReset Reset the DMTIMER module. DMTimerContextSave DMTIMERContextSave Stores the context of the DMTIMER module DMTimerContextRestore DMTIMERContextRestore Restores the context of the DMTIMER module DMTimerPostedModeConfig DMTIMERPostedModeEnable Configure the posted mode of DMTIMER module API name updated to follow coding API name updated to follow coding The macros that can be passed to the parameter gpocfg have been grouped into an enum dmtimergpocfg_t. API name updated to follow coding API name updated to follow coding API name updated to follow coding The macros that can be passed to the parameter intrmask have been grouped into an enum dmtimerintrmask_t. API name updated to follow coding API name updated to follow coding API name updated to follow coding The macros that can be passed to the parameter intrmask have been grouped into an enum dmtimerintrmask_t. API name updated to follow coding The macros that can be passed to the parameter intrmaskhave been grouped into an enum dmtimerintrmask_t. API name updated to follow coding The macros that can be passed to the parameter intrmask have been grouped into an enum dmtimerintrmask_t. API name updated to follow coding API name updated to follow coding API name updated to follow coding The macros that can be passed to the parameter enablereset have been grouped into an enum dmtimerresetconfig_t. API name updated to follow coding API name updated to follow coding API name updated to follow coding API name updated to follow coding Added param enablepostedmodeso as to enable or disable the posted mode of the dmtimer.

7 Starterware XX Migration Guide 7 DMTimerWritePostedStatusGet DMTIMERGetWritePostedStatus Read the status of Write Posted Status register API name updated to follow coding GPIO The below table lists the DAL file name differences between the versions StarterWare v StarterWare v xx Reason for change gpio_v2.c gpio.c GPIO v2 IP is present in AM335X and AM43XX. Going forward, only GPIO v2 will present in all further SoCs. Under this assumption, the version information is not needed and removed from the file name to make it generic. gpio_v2.h gpio.h Same as above. hw_gpio_v2.h hw_gpio.h Same as above. gpio.c gpio_v1.c DAL file corresponding to AM1808 GPIO IP. AM1808 is not supported in the current version of starterware. Since file names corresponding to v2 are changed from "gpio_v2" to "gpio", these file names are changed from "gpio" to "gpio_v1". This modification is done just to retain the GPIO v1 DAL, even though this version is not supported in the current starterware. gpio.h gpio_v1.h Same as above. hw_gpio.h hw_gpio_v1.h Same as above. The below table lists API differences between the versions StarterWare v : API Name StarterWare v xx: API Name StarterWare v : Functionality StarterWare v xx : Changes Notes GPIOModuleReset No Change This API performs the module reset of the GPIO module. GPIOModuleEnable GPIOModuleEnable This API is used to enable the GPIO module. GPIOModuleDisable GPIOModuleEnable This API is used to disable the GPIO module. GPIODirModeSet GPIOSetDirMode This API configures the direction of a specified GPIO pin as being either input or output GPIOPinWrite GPIOPinWrite This API drives an output GPIO pin to a logic HIGH or a logic LOW state. GPIOPinRead GPIOPinRead This API determines the logic level(value) on a specified GPIO pin. GPIOMultiplePinsWrite GPIOMultiplePinsWrite This API is used to collectively set and collectively clear the specified output pins of a GPIO instance. No Change The functionality of both enabling and disabling of GPIO module is combined into a single API. This new API takes a one more input parameter enablemodule which controls enabling and disabling. Same as above. follow the new coding The macros that can be passed to the parameter pindirection have been grouped into an enum gpiodirection_t. The macros that can be passed to the parameter pinvalue are GPIO_PIN_LOW, GPIO_PIN_HIGH. The possible return values from this API are GPIO_PIN_LOW, GPIO_PIN_HIGH. No change.

8 Starterware XX Migration Guide 8 GPIOMultiplePinsRead GPIOMultiplePinsRead This API reads the pin values of the specified pins of the GPIO instance. GPIOIntTypeSet GPIOSetIntrType This API configures the event type for a specified input GPIO pin, which when occurred will generate an interrupt. GPIOPinIntEnable GPIOIntrEnable This API enables the configured interrupt event on a specified input GPIO pin to trigger an interrupt request GPIOPinIntDisable GPIOIntrDisable This API disables interrupt generation due to the detection of any event on a specified input GPIO pin. GPIOPinIntStatus GPIOIntrStatus This API determines the enabled interrupt status of a specified pin. GPIOPinIntClear GPIOIntrClear This API clears the enabled interrupt status of a specified GPIO pin. GPIORawIntStatus GPIOIntrRawStatus This API determines the raw interrupt status of the specified GPIO pins in the instance corresponding to the specified interrupt line. GPIOTriggerPinInt GPIOIntrTrigger This API manually triggers an interrupt request due to a specified GPIO pin. GPIOPinIntWakeUpEnable GPIOWakeupIntrEnable This API enables the feature for the specified Input GPIO Pin (Interrupt Request Source) to generate an asynchronous wakeup signal to the CPU. GPIOPinIntWakeUpDisable GPIOWakeupIntrDisable This API disables the feature for the specified Input GPIO Pin (Interrupt Request Source) to generate an asynchronous wakeup signal to the CPU. GPIOWakeupGlobalEnable GPIOGlobalWakeupEnable This API enables the GPIO Wakeup Generation feature for all the pins of the GPIO module. GPIOWakeupGlobalDisable GPIOGlobalWakeupDisable This API disables the GPIO Wakeup generation feature for all the pins of the GPIO module. No change. follow the new coding The macros that can be passed to the parameter eventtype are grouped into an enum gpiointrmask_t. follow the new coding follow the new coding follow the new coding follow the new coding follow the new coding This new API accepts the gpio pin number as parameter and returns the raw status corresponding to that pin, where as old API is accepting input mask where status of more than one pin can be returned. follow the new coding follow the new coding This new API along with enabling specific wakeup event, it also enables global wakeup event. follow the new coding follow the new coding follow the new coding. GPIOAutoIdleModeControl GPIOAutoIdleModeEnable This API is used to control(enable/disable) the Auto-Idle mode for GPIO. follow the new coding This new API accepts the macros TRUE, FALSE for the parameter enableautoidle, where as old API is accepting the macros GPIO_AUTO_IDLE_MODE_EBLE, GPIO_AUTO_IDLE_MODE_DISABLE.

9 Starterware XX Migration Guide 9 GPIOIdleModeConfigure GPIOSetIdleMode This API is used to configure the Power Management Request/Acknowledgement process for GPIO. GPIOGatingRatioConfigure GPIOSetGatingRatio This API configures the clock gating ratio for the event detection logic. follow the new coding The macros that can be passed to the parameter idlemodetype are grouped into an enum gpioidlemode_t. follow the new coding The macros that can be passed to the parameter gatingratio are grouped into an enum gpioclkgr_t. GPIODebounceFuncControl GPIODebounceFuncEnable This API enables/disables debouncing feature for a specified input GPIO pin. follow the new coding The second parameter is renamed from controlflag to debounceenable and accepts the macros TRUE orfalse. GPIODebounceTimeConfig GPIOSetDebounceTime This API configures the debouncing time for all the input pins of a GPIO instance. GPIORevisionInfoGet GPIOGetRevision This API reads the contents in the Revision register of the GPIO module. follow the new coding follow the new coding gpiocontextsave GPIOContextSave This API stores the context of the gpio. follow the new coding gpiocontextrestore GPIOContextRestore This API restores the context of the GPIO. follow the new coding The below table lists the deprecated APIs and their equivalent APIs in new starterware Deprecated API Equivalent API Reason for deprecating the API GPIOIntTypeGet GPIOGetIntrType --- GPIODirModeGet GPIOGetDirMode --- The below table lists data structure / macro differences between the versions StarterWare v : StarterWare v xx: Reason for change GPIO_INT_TYPE_XX GPIO_IDLE_MODE_XX GPIO_GR_FUNC_CLK_INTER_CLK_BY_XX Macro names are updated to follow new coding guidelines and these macros are grouped into an enum gpiointrmask_t. Macro names remain same and they are grouped inside an enum gpioidlemode_t. Macro names are updated to follow new coding guidelines and they are grouped inside an enum gpioclkgr_t. Macros are logically grouped. Macros are logically grouped Macros are logically grouped GPIO_AUTO_IDLE_MODE_XX These macros are removed. Enabling and disabling of debounce functionality is done based on the enable flag which accepts TRUE or FALSE values. GPIO_DEBOUNCE_FUNC_XX These macros are removed. Enabling and disabling of debounce functionality is done based on the enable flag which accepts TRUE or FALSE values.

10 Starterware XX Migration Guide 10 GPIO_DIR_XX GPIO_INT_LINE_X, GPIO_INT_SWAKEUP_LINE_X Macro names are changed to "GPIO_DIRECTION_XX" and they are grouped inside an enum gpiodirection_t. These macros are removed. Macros are logically grouped Instead of macros, directly values are passed to the APIs. Structure Name: GPIOCONTEXT Structure name is changed to gpiocontext_t. New coding guide lines. --- The following macros are newly defined: GPIO_LEVEL_XX New macros PWMSS EPWM The below table lists the DAL file name differences between the versions StarterWare v StarterWare v xx: Reason for change ehrpwm.c epwm.c File name should contain the correct module name. Since EPWM is the module name, file is renamed to epwm.c ehrpwm.h ehrpwm.h Same as above. hw_ehrpwm.h hw_pwmss_epwm.h Same as above. epwm.h ---- This file is redundant file and is removed. The below table lists API differences between the versions StarterWare v : API Name StarterWare v xx: API Name StarterWare v xx: Functionality StarterWare v xx: Changes Notes EHRPWMTimebaseClkConfig EPWMTbTimebaseClkCfg This API configures the clock divider of the Time base module. EHRPWMPWMOpFreqSet EPWMTbPwmFreqCfg This API configures the PWM Time base counter Frequency/Period. EHRPWMTBEmulationModeSet EPWMTbSetEmulationMode This API configures emulation mode. This setting determines the behaviour of Timebase counter during emulation (debugging) follow the new coding guidelines and module name is updated from EHRPWM -> EPWM. follow the new coding guidelines and module name is updated from EHRPWM -> EPWM. The macros that can be passed to the parameter counterdir has been grouped into an enum epwmtbcounterdir_t and macros that can be passed to the parameter enableshadowwrite are grouped into an enum epwmshadowregctrl_t. follow new coding The macros that can be passed to the parameter mode are grouped into an enum epwmtbemumode_t.

11 Starterware XX Migration Guide 11 EHRPWMTimebaseSyncEnable EPWMTbSyncEnable This API enables the synchronization of time base sub-module and also configures the phase count value to be loaded after sync event, counter direction after sync event. EHRPWMTimebaseSyncDisable EPWMTbSyncDisable This API disables the synchronization. Even if sync-in event occurs the count value will not be reloaded. EHRPWMTriggerSWSync EPWMTbTriggerSwSync This API generates software triggered sync pulse. EHRPWMSyncOutModeSet EPWMTbSetSyncOutMode This API selects the source of the synchronization output signal. It determines on which of the supported events sync-out has to be generated. EHRPWMWriteTBCount EPWMTbWriteTbCount This API loads the Time base counter. EHRPWMReadTBCount EPWMTbReadTbCount This API gets the Time base counter current value. EHRPWMTBStatusGet EPWMTbGetStatus This API gets the Time Base status as indicated by the tbstatusmask parameter. EHRPWMTBClearStatus EPWMTbStatusClear This API clears the Time base status bits. follow the new coding The following parameter name is changed from phscountdir to counterdir and the macros that can be passed to this are grouped in to an enum epwmtbcntdiraftsync_t. follow the new coding follow the new coding follow the new coding The macros that are passed to the parameter syncoutmode are grouped into an enum epwmtbsyncoutevt_t. follow the new coding follow the new coding follow the new coding The macros that are passed to the parameter tbstatusmask are grouped into an enum epwmtbsts_t. follow the new coding The following parameter name is changed from tbstatusmask to tbstatusclrmask and the macros that can be passed to this are EPWM_TB_STS_CTR_MAX, EPWM_TB_STS_SYNCI.

12 Starterware XX Migration Guide 12 EHRPWMLoadCMPA EPWMCounterComparatorCfg This API loads the CMPA value. EHRPWMLoadCMPB EHRPWMLoadCMPB This API loads the CMPB value. EHRPWMConfigureAQActionOnA EPWMAqActionOnOutputCfg This API configures the action to be taken on A by the Action qualifier module upon receiving the events. EHRPWMConfigureAQActionOnB EPWMAqActionOnOutputCfg This API configures the action to be taken on B by the Action qualifier module upon receiving the events. follow the new coding guidelines and comparator configuration function is made generic such that it can accept pwm channel (either A or B) as a parameter and single API can be used for both comparator A and comparator B configurations. Following is the list of parameters and their associated enums which contains possible macro values for that parameter: cmptype : epwmcccmp_t enableshadowwrite : epwmshadowregctrl_t shadowtoactiveloadtrigger : epwmcccmploadmode_t overwriteshadow : TRUE or FALSE Same as above. follow the new coding guidelines and this API is made generic such that it can accept pwm channel (either A or B) as a parameter and single API can be used for both for A and B channel action qualifier configuration. The parameter pwmoutputch selects the pwm channel which accepts the macro vales from the enum epwmoutputch_t. All the action qualifier configuration parameters are grouped into a single structure epwmaqactioncfg_t and a pointer to this structure is passed to the API. Same as above.

13 Starterware XX Migration Guide 13 EHRPWMSWForceA EPWMAqSwTriggerOneTimeAction This API triggers the SW forced single event on A. This can be used for testing the AQ sub-module. Every call to this API will trigger a single event. EHRPWMSWForceB EPWMAqSwTriggerOneTimeAction This API triggers the SW forced single event on B. This can be used for testing the AQ sub-module. Every call to this API will trigger a single event. EHRPWMAQContSWForceOnA EPWMAqSwTriggerContAction This API forces a value continuously on A output channel. EHRPWMAQContSWForceOnB EPWMAqSwTriggerContAction This API forces a value continuously on A output channel. EHRPWMDBSourceSelect EPWMDeadbandCfg This API selects the source for delay blocks in dead band sub-module. follow the new coding The API made generic to accept pwm channel (either A or B) as a parameter and single API can be used to force the software events on both A and B channels. This new API accepts following two new parameters and their associated enums: pwmoutputch : epwmoutputch_t. swtrigaction : epwmaqswtrigotaction_t. Same as above. follow the new coding API is made generic to accept the pwm channel (either A or B)as a parameter and single API can be used for both A and B channel outputs. The new API accepts the following parameters and their associated enums which contain the supported macro values for that parameters: pwmoutputch : epwmoutputch_t swtrigaction : epwmaqswtrigcontaction_t activeregreloadmode : epwmaqcsfrcregreload_t Same as above All the dead band related configurations are done in a single API. This new API performs following dead band configurations: deadband source select, polarity select, output mode, rising edge delay, falling edge delay. All the deadband configuration parameters are grouped into a single structure epwmdeadbandcfg_t and the pointer to the structure is passed to the new API.

14 Starterware XX Migration Guide 14 EHRPWMDBPolaritySelect EPWMDeadbandCfg This API selects the polarity. This allows to selectively invert one of the delayed signals before it is sent out of the dead-band sub-module. EHRPWMDBOutput EPWMDeadbandCfg This API selects output mode. EHRPWMDBConfigureRED EPWMDeadbandCfg This API sets the raising edge delay. EHRPWMDBConfigureFED EPWMDeadbandCfg This API sets the Falling edge delay EPWMDeadbandBypass This API bypasses the Dead-band sub-module EHRPWMConfigureChopperDuty EPWMChopperCfg This API configures the chopper duty cyce. EHRPWMConfigureChopperFreq EPWMChopperCfg This API configures the chopper frequency. EHRPWMConfigureChopperOSPW EPWMChopperCfg This API configures one shot pulse width. EHRPWMChopperEnable EPWMChopperEnable This API enables the PWM chopper sub-module EHRPWMChopperDisable EPWMChopperEnable This API disables the PWM chopper sub-module EHRPWMTZTripEventEnable EPWMTzTripEventEnable This API enables the trip event EHRPWMTZTripEventDisable EPWMTzTripEventDisable This API disable the trip event. Same as above. Same as above. Same as above. Same as above. New API. All the chopper submodule configurations are done in a single API. This new API performs following chopper configurations: Chopper duty cycle, frequency, one shot pulse width. All the chopper related configuration parameters are grouped in to a single structure epwmchoppercfg_t and a pointer to the structure is passed to this API. Same as above. Same as above. The enable and disable functionality has been combined into single API, which accepts the enableflag as a parameter. Same as above. follow coding This new API accepts one more parameter 'pinnum' which controls on which Tripzone pin the event has to be enabled. The parameter tzeventtype which selects the type of trip zone event accepts values from the following enum epwmtzevent_t. Same as above.

15 Starterware XX Migration Guide 15 EHRPWMTZForceAOnTrip EPWMTzTriggerTripAction This API configures the o/p on PWM A channel when a trip event is recognized. EHRPWMTZForceBOnTrip EPWMTzTriggerTripAction This API configures the o/p on PWM B channel when a trip event is recognized. EHRPWMTZFlagGet EPWMTzEventStatus This API returns the selected trip zone event status EHRPWMTZFlagClear EPWMTzEventStatusClear This API clears the selected trip zone event status EHRPWMTZSWFrcEvent EPWMTzTriggerSwEvent This API enables to generate Software forced trip condition EHRPWMTZIntEnable EPWMTzIntrEnable This API enables the trip interrupt. EHRPWMTZIntDisable EPWMTzIntrDisable This API disables the trip interrupt. EHRPWMETIntDisable EPWMEtIntrDisable This API disables the epwm Event interrupt EHRPWMETIntEnable EPWMEtIntrEnable This API enables the epwm Event interrupt The new API is made generic such that it accepts the pwm channel (either A or B) as an input parameter and hence single API can be used to configure trip actions of both A and B channel. For the following parameters possible values are grouped into enums: tripaction : epwmtztripaction_t. pwmoutputch : epwmoutputch_t. Same as above. follow the new coding The parameter flagtoread is renamed as eventmask and accepts the values from the following enum epwmtzstsflg_t. follow the new coding The parameter flagtoclear is renamed as eventmask and accepts the values from the following enum epwmtzstsflg_t. follow the new coding The parameter osht_cbc is renamed as tzeventtype and accepts the values from the following enum epwmtzevent_t. follow the new coding The parameter osht_cbc is renamed as tzeventtype and accepts the values from the following enum epwmtzevent_t. follow the new coding The parameter osht_cbc is renamed as tzeventtype and accepts the values from the following enum epwmtzevent_t. follow the new coding follow the new coding

16 Starterware XX Migration Guide 16 EHRPWMETIntSourceSelect EPWMEtIntrCfg This API selects the interrupt source EHRPWMETIntPrescale EPWMEtIntrCfg This API prescales the event on which interrupt is to be generated EHRPWMETEventCount EPWMEtGetEventCount This API returns the number of events occurred EHRPWMETIntStatus EPWMEtIntrStatus This API returns the epwm event interrupt status EHRPWMETIntClear EPWMEtIntrClear This API clears the interrupt status. EHRPWMETIntSWForce EPWMEtIntrTrigger This API forces interrupt to be generated EHRPWMLoadTBPHSHR EPWMHrLoadTbPhaseHrValue This API loads the Timebase Phase high resolution register value EHRPWMLoadCMPAHR EPWMHrLoadCmpAHrValue This API loads Counter-Comparator A high resolution value EHRPWMConfigHR EPWMHighResolutionCfg This API configures control mode and edge mode of high resolution sub-module. In also enables the HR sub-module. EHRPWMHRDisable EPWMHighResolutionDisable This API disables the high-resolution feature of epwm. EHRPWMClockEnable EPWMClockEnable This functions enables clock for EPWM module in PWMSS subsystem. EHRPWMClockDisable EPWMClockDisable This functions disables clock for EPWM module in PWMSS subsystem. All the configurations corresponding to the event trigger interrupt configuration have been combined into single API. This API configures interrupt source and interrupt period. The following are the configuration parameters and thier respective enums which contains possible macro values for that parameter: intrevtsrc : epwmetintrevt_t. intrprd : epwmetintrperiod_t. Same as above follow the new coding follow the new coding follow the new coding follow the new coding follow the new coding follow the new coding The parameter ShadowToActiveLoadTrigger takes values from the enum epwmhrregactload_t. follow the new coding follow the new coding follow the new coding follow the new coding

17 Starterware XX Migration Guide 17 The below table lists the deprecated APIs and their equivalent APIs in new starterware Deprecated API Equivalent API Reason for deprecating the API EHRPWMClockEnableStatusGet EPWMClockEnableStatusGet ---- EHRPWMClockDisableStatusGet EPWMClockDisableStatusGet ---- The below table lists data structure / macro differences between the versions StarterWare v : StarterWare v xx: Reason for change ---- EHRPWM_COUNT_UP, EHRPWM_COUNT_DOWN, EHRPWM_COUNT_UP_DOWN,EHRPWM_COUNT_STOP ---- EHRPWM_COUNT_DOWN_AFTER_SYNC, EHRPWM_COUNT_UP_AFTER_SYNC EHRPWM_SYNCOUT_XX ---- EHRPWM_STOP_AFTER_NEXT_TB_INCREMENT, EHRPWM_STOP_AFTER_A_COMPLETE_CYCLE, EHRPWM_FREE_RUN ---- EHRPWM_COMPX_LOAD_XX Enum: epwmoutputch_t - Number of supported EPWM outputs in a single epwm channel These are grouped into enum epwmtbcounterdir_t and the macro names are also updated to follow the coding Enum: epwmshadowregctrl_t - Shadow register enable or disable control Enum: epwmtbcntdiraftsync_t - Counter directions after sync event These macros are grouped into an enum epwmtbsyncoutevt_t and the macro names are also updated to follow new coding Enum: epwmtbsts_t - Flags to get the different types of time base status These are grouped into an enum epwmtbemumode_t and macro names are also updated to follow new coding Enum: epwmcccmp_t - Comparator type either A or B. These macros are logically grouped into an enum epwmcccmploadmode_t and macro names are updated to follow new coding Enum: epwmaqaction_t - Types of Actions that Action Qualifier can take on the Output when the supported counter compare event occurs. Enum: epwmaqswtrigotaction_t - Actions to be taken on the output, when Software triggered one time events will occur Enum: epwmaqswtrigcontaction_t - Types of Continuous software forced actions on output. Enum: epwmaqcsfrcregreload_t - Action Qualifier Software Force Active Register Reload From Shadow Options Enum: epwmdbinmode_t - Dead Band Input Mode Control Enum: epwmdbpolsel_t - Dead band Polarity Select Control. New enum. Macros are grouped logically. New enum. Macros are grouped logically. Macros are grouped logically. New enum. Macros are grouped logically. New enum. New enum. New enum. New enum. New enum. New enum. New enum. New enum.

18 Starterware XX Migration Guide EHRPWM_CHP_DUTY_XX Enum: epwmdboutmode_t - Dead-band Output Mode Control These macros are logically grouped into an enum epwmchpdutycycle_t and the macro names are updated to follow coding Enum: epwmchpclkfreq_t - Chopping Clock Frequency values Enum: epwmchposhtwidth_t - One-Shot Pulse Width values. Enum: epwmtztripaction_t - Action to be taken on PWM output When a trip event occurs. New enum. Macros are grouped logically. New enum. New enum. New enum. EHRPWM_TZ_ONESHOT, EHRPWM_TZ_CYCLEBYCYCLE Enum: epwmtzevent_t - Type of trip zone events New enum Enum: epwmtzstsflg_t - Trip zone status flags New enum Enum: epwmetintrevt_t - epwm Interrupt (EPWMx_INT) Selection Options. Enum: epwmetintrperiod_t - epwm Interrupt (EPWMx_INT) Period Select Enum: epwmhrdelaybusselmode_t - Delay Bus Selection, that selects which bus is used to select the delay for the PWM pulse Enum: epwmhrdelayedgectrl_t - Delay Mode Configuration, that selects which edge of the PWM pulse the delay is inserted Enum: epwmhrregactload_t - Pulse selection, that selects which pulse to use for timing events in the HRPWM module. Structure: epwmtimebasecfg_t - Structure holding the TimeBase sub-module configuration parameters Structure: epwmcountercmpcfg_t - Structure holding the Counter Comparator values Structure: epwmaqactioncfg_t - Structure holding the Action Qualifier actions to be taken on the PWM output at the specific events. Structure: epwmdeadbandcfg_t - Structure holding the dead band generation sub-module configuration parameters. Structure: epwmchoppercfg_t - Structure holding the configuration parameters of Chopper sub-module. Structure: epwmtripzonecfg_t - Structure holding the trip-zone sub-module configuration parameters. Structure: epwmetcfg_t - Structure holding the Event Trigger Sub-Module configuration parameters. Structure: epwmhighresolutioncfg_t - Structure holding the configuration parameters of high resolution pwm pulse generation sub module. New enum. New enum. New enum. New enum. New enum. New structure. New structure. New structure. New structure. New structure. New structure. New structure. New structure.

19 Starterware XX Migration Guide 19 ECAP The below table lists the DAL file name differences between the versions StarterWare v : StarterWare v xx: Reason for change ecap.c ecap.c No Change. ecap.h ecap.h Same as above. hw_ecap.h hw_pwmss_ecap.h Renamed to reflect the subsystem and submodule names. The below table lists API differences between the versions StarterWare v : API Name StarterWare v xx: API Name StarterWare v : Functionality StarterWare v xx: Changes Notes ECAPClockEnable ECAPClkEnable This API enables the clock for ECAP sub-module in the PWM Subsystem. ECAPClockDisable ECAPClkEnable This API disables the clock for ECAP sub-module in the PWM Subsystem. ECAPCaptureLoadingEnable ECAPCaptureLoadEnable This API controls enabling of the Loading of the capture registers with the time stamp value on a capture event. ECAPCaptureLoadingDisable ECAPCaptureLoadEnable This API controls disabling of the Loading of the capture registers with the time stamp value on a capture event. Function name is updated to guidelines and both Enable and Disable functionality are handled within the same API. It accepts enableclk as a parameter to control enable/disable of the clocks. Function name is updated to guidelines and both Enable and Disable functionality are handled within the same API. It accepts enableclk as a parameter to control enable/disable of the clocks. Function name is updated to follow new coding guidelines and both Enable and Disable functionality are handled within the same API. It accepts enablecaptload as a parameter to control enable/disable of the clocks. Function name is updated to follow new coding guidelines and both Enable and Disable functionality are handled within the same API. It accepts enablecaptload as a parameter to control enable/disable of the clocks.

20 Starterware XX Migration Guide 20 ECAPPrescaleConfig ECAPSetEvtPrescale This API sets the prescale value for the input capture signal. ECAPOperatingModeSelect ECAPSetOperMode This API configures the operating mode of ECAP to either Capture or Auxiliary PWM mode. ECAPContinousModeConfig ECAPSetCaptureMode This API configures the ECAP in continuous mode. ECAPOneShotModeConfig ECAPSetCaptureMode This API configures the ECAP in one-shot mode. ECAPOneShotModeConfig ECAPSetStopWrapVal This function sets the Stop/Wrap Value for a capture Event in One-shot and Continuous modes. ECAPTimeStampRead ECAPGetTimeStamp This API returns the time stamp captured for a given capture event. ECAPCounterConfig ECAPSetCounterTimeBase This API sets the counter value in Time-Stamp Counter which serves as the capture time base. ECAPCapeEvtPolarityConfig ECAPSetCaptEvtPol This function sets the configures the capture event polarity for the specific event number. Function name is updated to Function name is updated to The macros that are passed to the parameter opermode are grouped into an enum ecapopermode_t Function name is updated to The macros that are passed to the parameter captmode are grouped into an enum ecapcaptmode_t. Function name is updated to Function name is updated to The feature of setting StopWrap value is handled within this API. The user has to configure the ECAP to capture before calling this API. Function name is updated to Function name is updated to Function name is updated to The API now accepts captevtnum and evtpol as the parameters to configure the polarity of a particular event. The ECAPSetCaptureMode API configures ECAP in one-shot mode, the setting of StopWrap value is done through ECAPSetStopWrapVal API

21 Starterware XX Migration Guide 21 ECAPCaptureEvtCntrRstConfig ECAPCaptEvtCounterResetConfig This API enables/disables reset of the time stamp counter after a capture event. Function name is updated to The API now accepts captevtnum and countercfg as the parameters to enable reset or no reset of the Capture event counter. ECAPOneShotREARM ECAPSetOneShotReArmingMode This function enables the One-shot Re-Arming feature. This sets Mod4 counter to zero, Unfreezes the counter and enables the capture loads. ECAPAPWMPolarityConfig ECAPSetApwmOutputPol This function configures the output polarity of the APWM pulse output. ECAPAPWMCaptureConfig ECAPApwmOutputConfig This API configures the Period and Compare Values in APWM mode to generate a PWM output. Function name is updated to Function name is updated to The API outputpol as a parameter which accepts the polarity setting to be done from the following enum ecapapwmoutputpol_t Function name is updated to ECAPAPWMShadowCaptureConfig ECAPApwmShadowModeConfig This API configures the Period and Compare Values in APWM mode in the Shadow registers to generate a PWM output. Same as above. ECAPCounterControl ECAPTimeStampCounterEnable This API controls the time-stamp counter by programming it to run in free run mode or stop it. ECAPCounterPhaseValConfig ECAPSetCounterPhaseVal This API forces a value continuously on A output channel. Same as above. The enablecounter parameter is updated to accept TRUE or FALSE as input to control the running of the timestamp counter. Function name is updated to

22 Starterware XX Migration Guide 22 ECAPSyncInOutSelect ECAPSyncInEnable This API controls enabling/disabling the Sync-In select mode.. Function name is updated to The enablesyncin parameter takes TRUE or FALSE as the input to control enabling/disabling of the SyncIn feature. ECAPSyncInOutSelect ECAPSyncOutSignalCtrl This API configures the Sync-Out Event features like Period Equal event to be Sync-out signal etc. The Sync-Out signal features which was handled within ECAPSyncInOutSelect API is now handled separtely with ECAPSyncOutSignalCtrl API. The syncoutctrl takes values from the following enum ecapsyncoutcfg_t for different synout signal properties. ECAPIntEnable ECAPIntrEnable This function enables the specified Interrupts for ECAP module. ECAPIntDisable ECAPIntrDisable This function enables the specified Interrupts for ECAP module. ECAPIntStatusClear ECAPIntrClear This API Clears the status of specified interrupts. ECAPIntStatus ECAPIntrStatus This API returns the status of all active and enabled interrupts. Function name is updated to The API accepts masks value of the interrupts to be enabled from the following enum ecapintrmask_t Function name is updated to The API accepts masks value of the interrupts to be disabled from the following enum ecapintrmask_t Function name is updated to The API accepts interrupt mask value as the parameter from the following enum ecapintrmask_t. It also clears the Global Interrupt bit to enable generation of further interrupts. Function name is updated to The API accepts interrupt mask value as the parameter from the following enum ecapintrmask_t.

23 Starterware XX Migration Guide ECAPIntrTrigger This API triggers an interrupt request for a specified event. ECAPPeripheralIdGet ECAPGetRevision This function returns the Revision ID of the ECAP module. EcapContextSave ECAPContextSave This API can be used to save the Register context of ECAP EcapContextRestore ECAPContextRestore This API can be used to restore the Register context of ECAP New API. Function name is updated to Same as above. The Interrupt Clear register is not saved in the context. The capture event3 and event4 registers are added to the existing registers which are saved. Same as above. The below table lists the deprecated APIs and their equivalent APIs in new starterware Deprecated API Equivalent API Reason for deprecating the API ECAPClockEnableStatusGet ECAPClockDisableStatusGet The below table lists data structure / macro differences between the versions StarterWare v : StarterWare v xx: Reason for change ECAP_CAPTURE_MODE, ECAP_APWM_MODE ECAP_CAPTURE_EVENT_1, ECAP_CAPTURE_EVENT_2, ECAP_CAPTURE_EVENT_3, ECAP_CAPTURE_EVENT_4 ECAP_CAPTURE_EVENT1_STOP, ECAP_CAPTURE_EVENT2_STOP, ECAP_CAPTURE_EVENT3_STOP, ECAP_CAPTURE_EVENT4_STOP ECAP_COUNTER_STOP, ECAP_COUNTER_FREE_RUNNING ECAP_SYNC_IN, ECAP_PRD_EQ, ECAP_SYNC_OUT_DISABLE, ECAP_SYNC_IN_DISABLE, ECAP_EBLE_Counter ECAP_CEVT1_INT, ECAP_CEVT2_INT, ECAP_CEVT3_INT, ECAP_CEVT4_INT, ECAP_CNTOVF_INT, ECAP_PRDEQ_INT, ECAP_CMPEQ_INT Enum: ecapopermode_t - The operating modes of the ECAP module are clubbed together in this enum. These are grouped into enum ecapcaptevt_tand the macro names are also updated to follow the coding They are grouped together in the Enum: ecapstopwrapevt_t - the macros are assigned auto generated values. These macros are not used by any APIs are replaced by TRUE, FALSE macros which decide the API behavior. These macros are grouped into an enum ecapsyncoutcfg_t and the macro names are also updated to follow new coding This macro is replaced by TRUE/FALSE macros to decide the API behavior. These are grouped into an enum ecapintrmask_t and macro names are also updated to follow new coding Macros are grouped logically and are defined as per latest coding standards. Macros are grouped logically. Macros are grouped logically. Macros are grouped logically. Macros are grouped logically. New enum. Macros are grouped logically.

24 Starterware XX Migration Guide 24 ECAPCONTEXT Register Context Structure The Register Context structure is renamed as ecapctx_t with ECAPCtrl2, ECAPEVT3, ECAPEVT4 registers added to it. Structure name updated as per coding I2C The below table lists the DAL file name differences between the versions StarterWare v StarterWare v xx: Reason for change hsi2c.c i2c.c I2C IP integrated in the AM335x and AM43xx does not support the High Speed Mode of I2C. The file is renamed to avoid ambiguity the DAL file is renamed to i2c.c hsi2c.h i2c.h Same as above. hw_hsi2c.h hw_i2c.h Same as above. The below table lists API differences between the versions. StarterWare v : API Name StarterWare v Functionality StarterWare v xx: API Name StarterWare v xx: Change Notes I2CMasterInitExpClk The API configures the prescalers to divide the internal clock to configure the bus speed. I2CClkConfig The name has been changed to make the API generic as Clock configuration is common to both Master and Slave modes of operation. I2CMasterEnable The API enables the I2C module. I2CModuleEnable The features of Enabling/Disabling the Module is combined into a single API "I2CModuleEnable". The New API takes one of the following macros TRUE/FALSE as a parameter to enable/disable the module. I2CMasterDisable The API disables the I2C module I2CModuleEnable Same as above I2CMasterBusBusy The API returns the status of the I2C bus whether it is busy or free. I2CBusBusyStatus The word "Master" is dropped from the API name to make it generic for both Master/Slave modes. I2CMasterErr I2CMasterStart I2CMasterStop The API returns the error status if an error has occurred during the I2C transaction. The API is used to generate a START condition on the I2C Bus. The API is used to generate a STOP condition on the I2C bus. I2CErrStatus Same as above. I2CStart Same as above. I2CStop Same as above.