starterware 02 01 00 xx migration guide - texas...

Starterware 02 01 00 XX Migration Guide 1

Starterware 02 01 00 XX Migration Guide

IntroductionThis 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 Description

DAL Device AbstractionLayer

SoC System On Chip

EVM Evaluation Module

ChipDB Chip Database

CCS Code Composer Studio

This bullet indicates important information. Please read such text carefully.

Migration from StarterWare v02.00.xx.xxStarterWare provides a no-OS platform support for ARM/DSP based SoCs. StarterWare provides DeviceAbstraction Layer (DAL) libraries and peripheral/board level sample/demo examples that demonstrate thecapabilities 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

http://ap-fpdsp-swapps.dal.design.ti.com/index.php?title=File:TIBanner.png


• Single binary across EVMs of a single SoC

Overview of differencesThe 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. forbuilding all modules & examples

build: Only contains common makerules, scripts etc. forbuild 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 DALfunctions with no suffix.

SoC specific information Distributed across, including within examples Contained within soc folder

Board specificinformation

Distributed across, including within examples Contained within board folder

Examples Categorized based on board - one for each soc-boardcombination

Categorized based on IP / use case, single for all SoCs &boards.

Pinmux configuration Only few pinmux configurations as demonstrated inexamples.

Auto-generated pinmux database with easy-to-use GUIpinmux tool. Generic pinmux APIs

PRCM configuration Only few power sequences can be demonstrated.Remaining have to be figured out by user

Auto-generated PRCM/clock database with generic APIs toenable all scenarios. Generic PRCM APIs

Interrupt controllers indifferent SoCs

User calls different APIs for interrupt configuration Single generic interrupt header file

Cache controller / mmuconfiguration

User calls different APIs for different SoCs Single generic Cache / MMU header file

Header files All header files, exported/internal in include folder.Difficult to differentiate module-specific headers andinternal/exported.

All exported header files only in include/<module>, internalin module itself. Source files include as <module>/header.h

API naming across DAL,utils, examples

No convention followed. Difficult to find out what is inDAL, utils, or examples.

Utils modules have Utils in name (e.g. I2CUtils). Apps haveApp in name (e.g. GPIOApp). Dals are just IP name (e.g.GPIO)

Macros: Distributedacross hw file & DAL.

Some APIs require user to shift & mask before passing toDAL, others do this in DAL.

Consistency across DALs, with shift & mask within DALsonly.

Macro usage Hw file macros are directly exposed. Some macros aredefined in DAL header.

DAL redefines and classifies macros into enums to abstractout IP specific differences

API parameters User chooses from macros in hw generated header fileand/or dal header file

Enums are defined in dal header file to group togetherparameters that can go to specific function.

Doxygen API referencedocumentation

Doxygen documentation for functions in the 'c' file Complete doxygen documentation in the header file.Enables complete definition of the interface within theheader files.

The below table gives a high level overview of changes in the folder structure


StarterWare v2.00.xx.xx module/feature StarterWare v2.01.xx.xx module/feature

Folder name: drivers Folder name: dal

Folder name: system_config Folder name: soc

Folder name: platform Folder name: board

Folder name: NA Folder name: device

libs at root - e.g. mmcsdlib, nandlib etc. libs within library folder - e.g. mmcsd, nandetc.

Interface differences

CACHE

The below table lists the file name differences between the versions

StarterWare v02.00.01.01 StarterWare v02.01.00.XX Reason for change

\include\armv7a\cache.h include\cache.h The cache API's are made generic across different architectures.

NA 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 v02.00.01.01: APIName

StarterWare v02.01.00.XX:API Name

StarterWarev02.01.00.XX:Functionality

StarterWare v02.01.00.XX: Changes Notes

CacheEnable CACHEEnable Enables cache API name updated to follow codingguidelines. Supports outer cache ifregistered.

NA

CacheDisable CACHEDisable Disables cache API name updated to follow codingguidelines. Supports outer cache ifregistered.

NA

CacheInstInvalidateAll CACHEInstInvAll Invalidate completeinstruction cache

API name updated to follow codingguidelines. Supports outer cache ifregistered.

NA

CacheInstInvalidateBuff --NA-- This API is deprecated inthe current release

--NA-- NA

CacheDataCleanInvalidateAll CACHEDataCleanInvAll Clean and invaldatecomplete data cache


NA

CacheDataCleanAll CACHEDataCleanAll Clean complete datacache


NA

CacheDataInvalidateAll CACHEDataInvAll Invalidate complete datacache


NA

CacheDataCleanBuff CACHEDataCleanRange Clean part of data cache API name updated to follow codingguidelines. Supports outer cache ifregistered.

NA

CacheDataInvalidateBuff CACHEDataInvRange Invalidate part of datacache


NA


CacheDataCleanInvalidateBuff CACHEDataCleanInvRange Clean and invalidate partof data cache


NA

--NA-- CACHERegisterOuterCache Register outer cache --NA-- NA

--NA-- CACHELockByWay Lock cache contents byWAY

--NA-- NA

--NA-- CACHEUnlockByWay Unloca cache contents byWAY

--NA-- NA

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 guidelines.

CacheDataCleanInvalidateAll CACHEDataCleanInvAll API name updated to follow coding guidelines.

CacheDataCleanAll CACHEDataCleanAll API name updated to follow coding guidelines.

CacheDataInvalidateAll CACHEDataInvAll API name updated to follow coding guidelines.

CacheDataCleanBuff CACHEDataCleanRange API name updated to follow coding guidelines.

CacheDataInvalidateBuff CACHEDataInvRange API name updated to follow coding guidelines.

CacheDataCleanInvalidateBuff CACHEDataCleanInvRange API name updated to follow coding guidelines.

MMU



\include\armv7a\mmu.h include\mmu.h The cache API's are made generic across different architectures.


StarterWare v02.00.01.01:API Name


StarterWare v02.01.00.XX:Functionality


MMUInit MMUInit Initialize the MMU The parameters to this API is changed tomake it more generic.

NA

--NA-- MMUDisable Disable MMU This is the new API added NA

DMTIMER




\drivers\dmtimer.c \dal\dmtimer.c This file provides a registerlevel abstraction of the dmtimerhardware and is not a driver.

NA \examples\dmtimer\dmtimer_app.h Added new file which containsgeneric API's and datastructures for configuring thedmtimer

NA \examples\dmtimer\dmtimer_app.c Added new file which containsgeneric API's for configuringthe dmtimer

NA \examples\dmtimer\countdown_timer\countdown_timer_app.h Added new file which containscount down timer API's

\examples\evmAM335x\dmtimerCounter.c \examples\dmtimer\countdown_timer\countdown_timer_app_main.c. This file serves as the entrypoint into the count down timerapplication implements the cdtexample.



StarterWare v02.01.00.XX: APIName



DMTimerEnable DMTIMEREnable This API will start/stopthe timer depending onthe enableDmtimerparameter.

API name updated to follow codingguidelines. Addedparam enableDmtimer so as to start or stopthe dmtimer.

NA

DMTimerDisable DMTIMEREnable This API will start/stopthe timer depending onthe enableDmtimerparameter.

API name updated to follow codingguidelines.Added param enableDmtimersoas to start or stop the dmtimer.

NA

DMTimerModeConfigure DMTIMERSetMode Sets operational modeof the timer.

API name updated to follow codingguidelines. The macros that can be passedto the parameter modeCfg have beengrouped into an enum dmtimerMode_t.

NA

DMTimerPreScalerClkEnable DMTIMERPrescalerClkEnable This API will configureand enable thepre-scaler clock.

API name updated to follow codingguidelines. The macros that can be passedto the parameter dividerRatio have beengrouped into an enumdmtimerPrescalerClkDivRatio_t.

NA

DMTimerCounterSet DMTIMERSetCounterVal Set/Write the Counterregister with thecounter value

API name updated to follow codingguidelines.

NA

DMTimerPreScalerClkDisable DMTIMERPrescalerClkDisable This API will disablethe pre-scaler clock.


NA

DMTimerCounterGet DMTIMERGetCounterVal Get/Read the countervalue from the counterregister.


NA

DMTimerReloadSet DMTIMERLoadReloadCount Set the reload countvalue in the timer loadregister.


NA


DMTimerReloadGet DMTIMERGetReloadCount Get the reload countvalue from the timerload register.


NA

DMTimerGPOConfigure DMTIMERGpoConfig Configure generalpurpose output pin

API name updated to follow codingguidelines.The macros that can be passed tothe parameter gpoCfg have been groupedinto an enum dmtimerGpoCfg_t.

NA

DMTimerCompareSet DMTIMERSetCompareVal Set the match registerwith the compare value


NA

DMTimerCompareGet DMTIMERGetCompareVal Get the match registercontents


NA

DMTimerIntRawStatusSet DMTIMERIntrTrigger Trigger IRQ event inSoftware

API name updated to follow codingguidelines.The macros that can be passed tothe parameter intrMask have been groupedinto an enum dmtimerIntrMask_t.

NA

DMTimerIntRawStatusGet DMTIMERIntrRawStatus Return the status ofIRQSTATUS_RAWregister


NA

DMTimerIntStatusGet DMTIMERIntrStatus Return the status ofinterrupts.


NA

DMTimerIntStatusClear DMTIMERIntrClear Clear the status ofinterrupt events


NA

DMTimerIntEnable DMTIMERIntrEnable Enable the DMTIMERinterrupts

API name updated to follow codingguidelines.The macros that can be passed tothe parameter intrMaskhave been groupedinto an enum dmtimerIntrMask_t.

NA

DMTimerIntDisable DMTIMERIntrDisable Disable the DMTIMERinterrupts


NA

DMTimerTriggerSet DMTIMERTriggerTcrrWrite Set/enable the triggerwrite access


NA

DMTimerIntEnableGet DMTIMERGetIntrEnableStatus Returns which of theinterrupts are enabled.


NA

DMTimerResetConfigure DMTIMERResetEnable Enables or disables softreset of DMTIMERmodule.

API name updated to follow codingguidelines.The macros that can be passed tothe parameter enableReset have beengrouped into an enumdmtimerResetConfig_t.

NA

DMTimerReset DMTIMERReset Reset the DMTIMERmodule.


NA

DMTimerContextSave DMTIMERContextSave Stores the context ofthe DMTIMER module


NA

DMTimerContextRestore DMTIMERContextRestore Restores the context ofthe DMTIMER module


NA

DMTimerPostedModeConfig DMTIMERPostedModeEnable Configure the postedmode of DMTIMERmodule

API name updated to follow codingguidelines. Added paramenablePostedModeso as to enable ordisable the posted mode of the dmtimer.

NA


DMTimerWritePostedStatusGet DMTIMERGetWritePostedStatus Read the status of WritePosted Status register


NA

GPIO

The below table lists the DAL file name differences between the versions

StarterWarev02.00.01.01

StarterWarev02.01.00.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 furtherSoCs. Under this assumption, the version information is not needed and removed from the file name to makeit 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 ofstarterware. Since file names corresponding to v2 are changed from "gpio_v2" to "gpio", these file namesare changed from "gpio" to "gpio_v1". This modification is done just to retain the GPIO v1 DAL, eventhough 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.



StarterWarev02.01.00.XX: API Name

StarterWare v02.00.01.01:Functionality

StarterWare v02.01.00.XX : Changes Notes

GPIOModuleReset No Change This API performs the module reset ofthe GPIO module.

No Change NA

GPIOModuleEnable GPIOModuleEnable This API is used to enable the GPIOmodule.

The functionality of both enabling anddisabling of GPIO module is combinedinto a single API. This new API takes aone more input parameter enableModulewhich controls enabling and disabling.

NA

GPIOModuleDisable GPIOModuleEnable This API is used to disable the GPIOmodule.

Same as above. NA

GPIODirModeSet GPIOSetDirMode This API configures the direction of aspecified GPIO pin as beingeither input or output

Function name is updated to follow thenew coding guidelines. The macros thatcan be passed tothe parameter pinDirection have beengrouped into an enum gpioDirection_t.

NA

GPIOPinWrite GPIOPinWrite This API drives an output GPIO pin to alogic HIGH or a logic LOWstate.

The macros that can be passed to theparameter pinValue are GPIO_PIN_LOW, GPIO_PIN_HIGH.

NA

GPIOPinRead GPIOPinRead This API determines the logiclevel(value) on a specified GPIO pin.

The possible return values from this APIare GPIO_PIN_LOW,GPIO_PIN_HIGH.

NA

GPIOMultiplePinsWrite GPIOMultiplePinsWrite This API is used to collectively set andcollectively clear thespecified output pins of a GPIOinstance.

No change. NA


GPIOMultiplePinsRead GPIOMultiplePinsRead This API reads the pin values of thespecified pins of the GPIOinstance.

No change. NA

GPIOIntTypeSet GPIOSetIntrType This API configures the event type for aspecified input GPIO pin, which whenoccurred will generate an interrupt.

Function name is updated to follow thenew coding guidelines. The macros thatcan be passed to the parameter eventTypeare grouped into an enumgpioIntrMask_t.

NA

GPIOPinIntEnable GPIOIntrEnable This API enables the configuredinterrupt event on aspecified input GPIO pin to trigger aninterrupt request

Function name is updated to follow thenew coding guidelines.

NA

GPIOPinIntDisable GPIOIntrDisable This API disables interrupt generationdue to the detection of any event on aspecified input GPIO pin.


NA

GPIOPinIntStatus GPIOIntrStatus This API determines the enabledinterrupt status of a specified pin.


NA

GPIOPinIntClear GPIOIntrClear This API clears the enabled interruptstatus of a specified GPIO pin.


NA

GPIORawIntStatus GPIOIntrRawStatus This API determines the raw interruptstatus of the specified GPIO pins in theinstance corresponding to the specifiedinterrupt line.

Function name is updated to follow thenew coding guidelines. This newAPI accepts the gpio pin number asparameter and returns the raw statuscorresponding to that pin, where as oldAPI is accepting input mask where statusof more than one pin can be returned.

NA.

GPIOTriggerPinInt GPIOIntrTrigger This API manually triggers an interruptrequest due to a specified GPIO pin.


NA

GPIOPinIntWakeUpEnable GPIOWakeupIntrEnable This API enables the feature for thespecified Input GPIO Pin (InterruptRequest Source) to generate anasynchronous wakeup signal to theCPU.

Function name is updated to follow thenew coding guidelines. This new APIalong with enabling specific wakeupevent, it also enables global wakeup event.

NA

GPIOPinIntWakeUpDisable GPIOWakeupIntrDisable This API disables the feature for thespecified Input GPIO Pin (InterruptRequest Source) to generate anasynchronous wakeup signal to theCPU.


NA

GPIOWakeupGlobalEnable GPIOGlobalWakeupEnable This API enables the GPIO WakeupGeneration feature for all the pins of theGPIO module.


NA

GPIOWakeupGlobalDisable GPIOGlobalWakeupDisable This API disables the GPIO Wakeupgeneration feature for all the pins of theGPIO module.


NA

GPIOAutoIdleModeControl GPIOAutoIdleModeEnable This API is used tocontrol(enable/disable) the Auto-Idlemodefor GPIO.

Function name is updated to follow thenew coding guidelines. This new APIaccepts the macros TRUE, FALSE for theparameter enableAutoIdle, where as oldAPI is accepting the macrosGPIO_AUTO_IDLE_MODE_ENABLE,GPIO_AUTO_IDLE_MODE_DISABLE.

NA


GPIOIdleModeConfigure GPIOSetIdleMode This API is used to configure the PowerManagement Request/Acknowledgementprocess for GPIO.

Function name is updated to follow thenew coding guidelines. The macros thatcan be passed to the parameteridleModeType are grouped into an enumgpioIdleMode_t.

NA

GPIOGatingRatioConfigure GPIOSetGatingRatio This API configures the clock gatingratio for the event detection logic.

Function name is updated to follow thenew coding guidelines. The macros thatcan be passed to the parametergatingRatio are grouped into an enumgpioClkGr_t.

NA

GPIODebounceFuncControl GPIODebounceFuncEnable This API enables/disables debouncingfeature for a specified input GPIO pin.

Function name is updated to follow thenew coding guidelines. The secondparameter is renamed from controlFlag todebounceEnable and accepts the macrosTRUE orFALSE.

NA

GPIODebounceTimeConfig GPIOSetDebounceTime This API configures the debouncingtime for all the input pins of a GPIOinstance.


NA

GPIORevisionInfoGet GPIOGetRevision This API reads the contents in theRevision register of the GPIO module.


NA

gpioContextSave GPIOContextSave This API stores the context of the gpio. Function name is updated to follow thenew coding guidelines.

NA

gpioContextRestore GPIOContextRestore This API restores the context of theGPIO.


NA



GPIOIntTypeGet GPIOGetIntrType ---

GPIODirModeGet GPIOGetDirMode ---

The below table lists data structure / macro differences between the versions

StarterWare v02.00.01.01: StarterWare v02.01.00.XX: Reason for change

GPIO_INT_TYPE_XX Macro names are updated to follow new codingguidelines and these macros are grouped into anenum gpioIntrMask_t.

Macros are logically grouped.

GPIO_IDLE_MODE_XX Macro names remain same and they are groupedinside an enum gpioIdleMode_t.

Macros are logically grouped

GPIO_GR_FUNC_CLK_INTER_CLK_BY_XX Macro names are updated to follow new codingguidelines and they are grouped inside an enumgpioClkGr_t.


GPIO_AUTO_IDLE_MODE_XX These macros are removed. Enabling and disabling of debouncefunctionality is done based on the enableflag which accepts TRUE or FALSEvalues.

GPIO_DEBOUNCE_FUNC_XX These macros are removed. Enabling and disabling of debouncefunctionality is done based on the enableflag which accepts TRUE orFALSE values.


GPIO_DIR_XX Macro names are changed to"GPIO_DIRECTION_XX" and they are groupedinside an enum gpioDirection_t.


GPIO_INT_LINE_X,GPIO_INT_SWAKEUP_LINE_X

These macros are removed. Instead of macros, directly values arepassed 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



StarterWarev02.01.00.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.





StarterWare v02.01.00.XX:Changes

Notes

EHRPWMTimebaseClkConfig EPWMTbTimebaseClkCfg This API configures theclock divider of theTime base module.

Function name is updated to followthe new coding guidelines andmodule name is updated fromEHRPWM -> EPWM.

NA

EHRPWMPWMOpFreqSet EPWMTbPwmFreqCfg This API configures thePWM Time basecounterFrequency/Period.

Function name is updated to followthe new coding guidelines andmodule name is updated fromEHRPWM -> EPWM. Themacros that can be passed tothe parameter counterDir has beengrouped into anenum epwmTbCounterDir_t andmacros that can be passed to theparameter enableShadowWrite aregrouped into anenum epwmShadowRegCtrl_t.

NA

EHRPWMTBEmulationModeSet EPWMTbSetEmulationMode This API configuresemulation mode. Thissetting determines thebehaviour of Timebasecounter duringemulation (debugging)

Function name is updated to follownew coding guidelines. The macrosthat can be passed to the parametermode are grouped into an enumepwmTbEmuMode_t.

NA


EHRPWMTimebaseSyncEnable EPWMTbSyncEnable This API enables thesynchronization of timebase sub-moduleand also configures thephase count value to beloaded after syncevent, counter directionafter sync event.

Function name is updated to followthe new coding guidelines. Thefollowing parameter name ischanged from phsCountDir tocounterDir and the macros that canbe passed to this are grouped in toan enumepwmTbCntDirAftSync_t.

NA

EHRPWMTimebaseSyncDisable EPWMTbSyncDisable This API disables thesynchronization. Even ifsync-in event occurs thecount value will not bereloaded.

Function name is updated to followthe new coding guidelines.

NA

EHRPWMTriggerSWSync EPWMTbTriggerSwSync This API generatessoftware triggered syncpulse.


NA

EHRPWMSyncOutModeSet EPWMTbSetSyncOutMode This API selects thesource of thesynchronization outputsignal. It determines onwhich of the supportedevents sync-out has tobe generated.

Function name is updated to followthe new coding guidelines. Themacros that are passed to theparameter syncOutMode aregrouped into an enumepwmTbSyncOutEvt_t.

NA

EHRPWMWriteTBCount EPWMTbWriteTbCount This API loads the Timebase counter.


NA

EHRPWMReadTBCount EPWMTbReadTbCount This API gets the Timebase counter currentvalue.


NA

EHRPWMTBStatusGet EPWMTbGetStatus This API gets the TimeBase status as indicatedby thetbStatusMask parameter.

Function name is updated to followthe new coding guidelines. Themacros that are passed to theparameter tbStatusMask aregrouped into an enumepwmTbSts_t.

NA

EHRPWMTBClearStatus EPWMTbStatusClear This API clears theTime base status bits.

Function name is updated to followthe new coding guidelines. Thefollowing parameter name ischanged from tbStatusMask totbStatusClrMask and the macrosthat can be passed to this areEPWM_TB_STS_CTR_MAX,EPWM_TB_STS_SYNCI.

NA


EHRPWMLoadCMPA EPWMCounterComparatorCfg This API loads theCMPA value.

Function name is updated to followthe new coding guidelines andcomparator configuration functionis made generic such that it canaccept pwm channel (either A or B)as a parameter and single API canbe used for both comparator A andcomparator B configurations.Following is the list of parametersand their associated enums whichcontains possible macro values forthat parameter:

cmpType : epwmCcCmp_t

enableShadowWrite :epwmShadowRegCtrl_t

shadowToActiveLoadTrigger :epwmCcCmpLoadMode_t

overwriteShadow : TRUE orFALSE

NA

EHRPWMLoadCMPB EHRPWMLoadCMPB This API loads theCMPB value.

Same as above. NA

EHRPWMConfigureAQActionOnA EPWMAqActionOnOutputCfg This API configures theaction to be taken on Aby the Action qualifiermodule upon receivingthe events.

Function name is updated to followthe new coding guidelines and thisAPI is made generic such that it canaccept pwm channel (either A or B)as a parameter and single API canbe used for both for A and Bchannel action qualifierconfiguration. The parameterpwmOutputCh selects the pwmchannel which accepts the macrovales from the enumepwmOutputCh_t. All the actionqualifier configuration parametersare grouped into a single structureepwmAqActionCfg_t anda pointer to this structure is passedto the API.

NA

EHRPWMConfigureAQActionOnB EPWMAqActionOnOutputCfg This API configures theaction to be taken on Bby the Action qualifiermodule upon receivingthe events.

Same as above. NA


EHRPWMSWForceA EPWMAqSwTriggerOneTimeAction This API triggers theSW forced single eventon A. This can be usedfor testing the AQsub-module. Every callto this API will trigger asingle event.

Function name is updated to followthe new coding guidelines. The APImade generic to accept pwmchannel (either A or B) as aparameter and single API can beused to force the software events onboth A and B channels. This newAPI accepts following two newparameters and their associatedenums:

pwmOutputCh :epwmOutputCh_t.

swTrigAction :epwmAqSwTrigOtAction_t.

NA

EHRPWMSWForceB EPWMAqSwTriggerOneTimeAction This API triggers theSW forced single eventon B. This can be usedfor testing the AQsub-module. Every callto this API will trigger asingle event.

Same as above. NA

EHRPWMAQContSWForceOnA EPWMAqSwTriggerContAction This API forces a valuecontinuously on Aoutput channel.

Function name is updated to followthe new coding guidelines. API ismade generic to accept the pwmchannel (either A or B)as aparameter and single API can beused for both A and B channeloutputs. The new API accepts thefollowing parameters and theirassociated enums which contain thesupported macro values for thatparameters:

pwmOutputCh :epwmOutputCh_t

swTrigAction :epwmAqSwTrigContAction_t

activeRegReloadMode : epwmAqCsfrcRegReload_t

NA

EHRPWMAQContSWForceOnB EPWMAqSwTriggerContAction This API forces a valuecontinuously on Aoutput channel.

Same as above NA

EHRPWMDBSourceSelect EPWMDeadbandCfg This API selects thesource for delay blocksin dead bandsub-module.

All the dead band relatedconfigurations are done in a singleAPI. This new API performsfollowing dead bandconfigurations: deadband sourceselect, polarity select, output mode,rising edge delay, falling edgedelay. All the deadbandconfiguration parameters aregrouped into a single structureepwmDeadbandCfg_t and thepointer to the structure is passed tothe new API.

NA


EHRPWMDBPolaritySelect EPWMDeadbandCfg This API selects thepolarity. This allows toselectively invertone of the delayedsignals before it is sentout of the dead-bandsub-module.

Same as above. NA

EHRPWMDBOutput EPWMDeadbandCfg This API selects outputmode.

Same as above. NA

EHRPWMDBConfigureRED EPWMDeadbandCfg This API sets the raisingedge delay.

Same as above. NA

EHRPWMDBConfigureFED EPWMDeadbandCfg This API sets the Fallingedge delay.

Same as above. NA

--NA--- EPWMDeadbandBypass This API bypasses theDead-band sub-module

New API. NA

EHRPWMConfigureChopperDuty EPWMChopperCfg This API configures thechopper duty cyce.

All the chopper submoduleconfigurations are done in a singleAPI. This new API performsfollowing chopper configurations:Chopper duty cycle, frequency, oneshot pulse width. All the chopperrelated configuration parametersare grouped in to a single structureepwmChopperCfg_t and a pointerto the structure is passed to thisAPI.

NA

EHRPWMConfigureChopperFreq EPWMChopperCfg This API configures thechopper frequency.

Same as above. NA

EHRPWMConfigureChopperOSPW EPWMChopperCfg This API configures oneshot pulse width.

Same as above. NA

EHRPWMChopperEnable EPWMChopperEnable This API enables thePWM choppersub-module

The enable and disablefunctionality has been combinedinto single API, which accepts theenableFlag as a parameter.

NA

EHRPWMChopperDisable EPWMChopperEnable This API disables thePWM choppersub-module

Same as above. NA

EHRPWMTZTripEventEnable EPWMTzTripEventEnable This API enables thetrip event

Function name is updated to followcoding guidelines. This new APIaccepts one more parameter'pinNum' which controls on whichTripzone pin the event has to beenabled. The parametertzEventType which selects thetype of trip zone event acceptsvalues from the following enumepwmTzEvent_t.

NA

EHRPWMTZTripEventDisable EPWMTzTripEventDisable This API disable the tripevent.

Same as above. NA


EHRPWMTZForceAOnTrip EPWMTzTriggerTripAction This API configures theo/p on PWM A channelwhen a trip eventis recognized.

The new API is made generic suchthat it accepts the pwm channel(either A or B) as an inputparameter and hence single API canbe used to configure trip actions ofboth A and B channel. For thefollowing parameters possiblevalues are grouped into enums:

tripAction : epwmTzTripAction_t.

pwmOutputCh : epwmOutputCh_t.

NA

EHRPWMTZForceBOnTrip EPWMTzTriggerTripAction This API configures theo/p on PWM B channelwhen a trip event isrecognized.

Same as above. NA

EHRPWMTZFlagGet EPWMTzEventStatus This API returns theselected trip zone eventstatus

Function name is updated to followthe new coding guidelines. Theparameter flagToRead is renamedas eventMask and accepts thevalues from the following enumepwmTzStsFlg_t.

NA

EHRPWMTZFlagClear EPWMTzEventStatusClear This API clears theselected trip zone eventstatus

Function name is updated to followthe new coding guidelines. Theparameter flagToClear is renamedas eventMask and accepts thevalues from the following enumepwmTzStsFlg_t.

NA

EHRPWMTZSWFrcEvent EPWMTzTriggerSwEvent This API enables togenerate Softwareforced trip condition

Function name is updated to followthe new coding guidelines. Theparameter osht_CBC is renamed astzEventType and accepts thevalues from the following enumepwmTzEvent_t.

NA

EHRPWMTZIntEnable EPWMTzIntrEnable This API enables thetrip interrupt.


NA

EHRPWMTZIntDisable EPWMTzIntrDisable This API disables thetrip interrupt.


NA

EHRPWMETIntDisable EPWMEtIntrDisable This API disables theePWM Event interrupt


NA

EHRPWMETIntEnable EPWMEtIntrEnable This API enables theePWM Event interrupt


NA


EHRPWMETIntSourceSelect EPWMEtIntrCfg This API selects theinterrupt source

All the configurationscorresponding to the event triggerinterrupt configuration have beencombined into single API. ThisAPI configures interrupt source andinterrupt period. The following arethe configuration parameters andthier respective enums whichcontains possible macro values forthat parameter:

intrEvtSrc : epwmEtIntrEvt_t.

intrPrd : epwmEtIntrPeriod_t.

NA

EHRPWMETIntPrescale EPWMEtIntrCfg This API prescales theevent on which interruptis to be generated

Same as above NA

EHRPWMETEventCount EPWMEtGetEventCount This API returns thenumber of eventsoccurred


NA

EHRPWMETIntStatus EPWMEtIntrStatus This API returns theePWM event interruptstatus


NA

EHRPWMETIntClear EPWMEtIntrClear This API clears theinterrupt status.


NA

EHRPWMETIntSWForce EPWMEtIntrTrigger This API forcesinterrupt to be generated


NA

EHRPWMLoadTBPHSHR EPWMHrLoadTbPhaseHrValue This API loads theTimebase Phase highresolution register value


NA

EHRPWMLoadCMPAHR EPWMHrLoadCmpAHrValue This API loadsCounter-Comparator Ahigh resolution value

Function name is updated to followthe new coding guidelines. TheparameterShadowToActiveLoadTriggertakes values from the enumepwmHrRegActLoad_t.

NA

EHRPWMConfigHR EPWMHighResolutionCfg This API configurescontrol mode and edgemode of high resolutionsub-module. In alsoenables the HRsub-module.


NA

EHRPWMHRDisable EPWMHighResolutionDisable This API disables thehigh-resolution featureof ePWM.


NA

EHRPWMClockEnable EPWMClockEnable This functions enablesclock for EPWMmodule in PWMSSsubsystem.


NA

EHRPWMClockDisable EPWMClockDisable This functions disablesclock for EPWMmodule in PWMSSsubsystem.


NA




EHRPWMClockEnableStatusGet EPWMClockEnableStatusGet --NA--

EHRPWMClockDisableStatusGet EPWMClockDisableStatusGet --NA--


StarterWare v02.00.01.01: StarterWare v02.01.00.XX: Reason forchange

--NA-- Enum: epwmOutputCh_t - Number of supportedEPWM outputs in a single epwm channel

New enum.

EHRPWM_COUNT_UP, EHRPWM_COUNT_DOWN,

EHRPWM_COUNT_UP_DOWN,EHRPWM_COUNT_STOP

These are grouped into enumepwmTbCounterDir_t and the macro names arealso updated to follow the coding guidelines.

Macros aregroupedlogically.

--NA-- Enum: epwmShadowRegCtrl_t - Shadow registerenable or disable control

New enum.

EHRPWM_COUNT_DOWN_AFTER_SYNC,EHRPWM_COUNT_UP_AFTER_SYNC

Enum: epwmTbCntDirAftSync_t - Counterdirections after sync event


EHRPWM_SYNCOUT_XX These macros are grouped into an enumepwmTbSyncOutEvt_t and the macro names arealso updated to follow new coding guidelines.


--NA-- Enum: epwmTbSts_t - Flags to get the differenttypes of time base status

New enum.

EHRPWM_STOP_AFTER_NEXT_TB_INCREMENT,EHRPWM_STOP_AFTER_A_COMPLETE_CYCLE,EHRPWM_FREE_RUN

These are grouped into an enumepwmTbEmuMode_t and macro names are alsoupdated to follow new coding guidelines.


--NA-- Enum: epwmCcCmp_t - Comparator type either Aor B.

New enum.

EHRPWM_COMPX_LOAD_XX These macros are logically grouped into an enum epwmCcCmpLoadMode_t and macro names areupdated to follow new coding guidelines.

New enum.

--NA-- Enum: epwmAqAction_t - Types of Actions thatAction Qualifier can take on the Output when thesupported counter compare event occurs.

New enum.

--NA-- Enum: epwmAqSwTrigOtAction_t - Actions to betaken on the output, when Software triggered onetime events will occur

New enum.

--NA-- Enum: epwmAqSwTrigContAction_t - Types ofContinuous software forced actions on output.

New enum.

--NA-- Enum: epwmAqCsfrcRegReload_t - ActionQualifier Software Force Active Register ReloadFrom Shadow Options

New enum.

--NA-- Enum: epwmDbInMode_t - Dead Band Input ModeControl

New enum.

--NA-- Enum: epwmDbPolSel_t - Dead band PolaritySelect Control.

New enum.


--NA-- Enum: epwmDbOutMode_t - Dead-band OutputMode Control

New enum.

EHRPWM_CHP_DUTY_XX These macros are logically grouped into an enumepwmChpDutyCycle_t and the macro names areupdated to follow coding guidelines.


--NA-- Enum: epwmChpClkFreq_t - Chopping ClockFrequency values

New enum.

--NA-- Enum: epwmChpOshtWidth_t - One-Shot PulseWidth values.

New enum.

--NA-- Enum: epwmTzTripAction_t - Action to be takenon PWM output When a trip event occurs.

New enum.

EHRPWM_TZ_ONESHOT, EHRPWM_TZ_CYCLEBYCYCLE Enum: epwmTzEvent_t - Type of trip zone events New enum.

--NA-- Enum: epwmTzStsFlg_t - Trip zone status flags New enum.

--NA-- Enum: epwmEtIntrEvt_t - ePWM Interrupt(EPWMx_INT) Selection Options.

New enum.

--NA-- Enum: epwmEtIntrPeriod_t - ePWM Interrupt(EPWMx_INT) Period Select

New enum.

--NA-- Enum: epwmHrDelayBusSelMode_t - Delay BusSelection, that selects which bus is used to select thedelay for the PWM pulse

New enum.

--NA-- Enum: epwmHrDelayEdgeCtrl_t - Delay ModeConfiguration, that selects which edge of the PWMpulse the delay is inserted

New enum.

--NA-- Enum: epwmHrRegActLoad_t - Pulse selection,that selects which pulse to use for timing events inthe HRPWM module.

New enum.

--NA-- Structure: epwmTimebaseCfg_t - Structure holdingthe TimeBase sub-module configuration parameters

Newstructure.

--NA-- Structure: epwmCounterCmpCfg_t - Structureholding the Counter Comparator values

Newstructure.

--NA-- Structure: epwmAqActionCfg_t - Structure holdingthe Action Qualifier actions to be taken on the PWMoutput at the specific events.

Newstructure.

--NA-- Structure: epwmDeadbandCfg_t - Structure holdingthe dead band generation sub-module configurationparameters.

Newstructure.

--NA-- Structure: epwmChopperCfg_t - Structure holdingthe configuration parameters of Chopper sub-module.

Newstructure.

--NA-- Structure: epwmTripzoneCfg_t - Structure holdingthe trip-zone sub-module configuration parameters.

Newstructure.

--NA-- Structure: epwmEtCfg_t - Structure holding theEvent Trigger Sub-Module configuration parameters.

Newstructure.

--NA-- Structure: epwmHighResolutionCfg_t - Structureholding the configuration parameters of highresolution pwm pulse generation sub module.

Newstructure.


ECAP


StarterWarev02.00.01.01:

StarterWare v02.01.00.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.




StarterWarev02.00.01.01:Functionality

StarterWarev02.01.00.XX: Changes

Notes

ECAPClockEnable ECAPClkEnable This API enablesthe clock forECAPsub-module in thePWM Subsystem.

Function name is updatedto follow the new codingguidelines and bothEnable and Disablefunctionality are handledwithin the same API. Itaccepts enableClk as aparameter to controlenable/disable of theclocks.

NA

ECAPClockDisable ECAPClkEnable This API disablesthe clock forECAPsub-module in thePWM Subsystem.

Function name is updatedto follow the new codingguidelines and bothEnable and Disablefunctionality are handledwithin the same API. Itaccepts enableClk as aparameter to controlenable/disable of theclocks.

NA

ECAPCaptureLoadingEnable ECAPCaptureLoadEnable This API controlsenabling of theLoading ofthe captureregisters with thetime stamp valueon a captureevent.

Function name is updatedto follow new codingguidelines and bothEnable and Disablefunctionality are handledwithin the same API. Itaccepts enableCaptLoadas a parameter to controlenable/disable of theclocks.

NA

ECAPCaptureLoadingDisable ECAPCaptureLoadEnable This API controlsdisabling of theLoading of thecapture registerswith the timestamp value on acapture event.

Function name is updatedto follow new codingguidelines and bothEnable and Disablefunctionality are handledwithin the same API. Itaccepts enableCaptLoadas a parameter to controlenable/disable of theclocks.

NA


ECAPPrescaleConfig ECAPSetEvtPrescale This API sets theprescale value forthe input capturesignal.

Function name is updatedto follow the new codingguidelines.

NA

ECAPOperatingModeSelect ECAPSetOperMode This APIconfigures theoperating modeof ECAP to eitherCapture orAuxiliary PWMmode.

Function name is updatedto follow the new codingguidelines. The macrosthat are passed to theparameter operMode aregrouped into an enumecapOperMode_t

NA

ECAPContinousModeConfig ECAPSetCaptureMode This APIconfigures theECAP incontinuous mode.

Function name is updatedto follow the new codingguidelines. The macrosthat are passed to theparameter captMode aregrouped into an enumecapCaptMode_t.

NA

ECAPOneShotModeConfig ECAPSetCaptureMode This APIconfigures theECAPin one-shot mode.


TheECAPSetCaptureMode API configures ECAP inone-shot mode, thesetting of StopWrapvalue is done throughECAPSetStopWrapValAPI

ECAPOneShotModeConfig ECAPSetStopWrapVal This function setsthe Stop/WrapValue for acapture Event inOne-shot andContinuousmodes.

Function name is updatedto follow the new codingguidelines. The feature ofsetting StopWrap value ishandled within this API.The user has to configurethe ECAP to capturebefore calling this API.

NA

ECAPTimeStampRead ECAPGetTimeStamp This API returnsthe time stampcaptured for agivencapture event .


NA

ECAPCounterConfig ECAPSetCounterTimeBase This API sets thecounter value inTime-StampCounter which serves as thecapture timebase.


NA

ECAPCapeEvtPolarityConfig ECAPSetCaptEvtPol This function setsthe configures thecapture eventpolarity for thespecific eventnumber.

Function name is updatedto follow the new codingguidelines. The API nowaccepts captEvtNumand evtPol as theparameters to configurethe polarity of a particularevent.

NA


ECAPCaptureEvtCntrRstConfig ECAPCaptEvtCounterResetConfig This APIenables/disablesreset of the timestampcounter after acapture event.

Function name is updatedto follow the new codingguidelines. The API nowaccepts captEvtNum andcounterCfg as theparameters to enable resetor no reset of the Captureevent counter.

NA

ECAPOneShotREARM ECAPSetOneShotReArmingMode This functionenables theOne-shotRe-Armingfeature. Thissets Mod4counter to zero,Unfreezes thecounter andenablesthe capture loads.


NA

ECAPAPWMPolarityConfig ECAPSetApwmOutputPol This functionconfigures theoutput polarity ofthe APWMpulse output.

Function name is updatedto follow the new codingguidelines. The APIoutputPol as a parameterwhich accepts thepolarity setting to be donefrom the following enumecapAPWMOutputPol_t

NA

ECAPAPWMCaptureConfig ECAPApwmOutputConfig This APIconfigures thePeriod andCompare Valuesin APWM modeto generate aPWM output.


NA

ECAPAPWMShadowCaptureConfig ECAPApwmShadowModeConfig This APIconfigures thePeriod andCompare Valuesin APWM modein the Shadowregisters togenerate a PWMoutput.

Same as above. NA

ECAPCounterControl ECAPTimeStampCounterEnable This API controlsthe time-stampcounter byprogramming itto run in free runmode or stop it.

Same as above. TheenableCounter parameteris updated to acceptTRUE or FALSE as inputto control the running ofthe timestamp counter.

NA

ECAPCounterPhaseValConfig ECAPSetCounterPhaseVal This API forces avaluecontinuously onA output channel.


NA


ECAPSyncInOutSelect ECAPSyncInEnable This API controlsenabling/disablingthe Sync-In selectmode..

Function name is updatedto follow the new codingguidelines. TheenableSyncIn parametertakes TRUE or FALSE asthe input to controlenabling/disabling of theSyncIn feature.

NA

ECAPSyncInOutSelect ECAPSyncOutSignalCtrl This APIconfigures theSync-Out Eventfeatures likePeriod Equalevent to beSync-out signaletc.

The Sync-Out signalfeatures which washandled withinECAPSyncInOutSelectAPI is now handledsepartely withECAPSyncOutSignalCtrlAPI. The syncOutCtrltakes values from thefollowing enumecapSyncOutCfg_t fordifferent synout signalproperties.

NA

ECAPIntEnable ECAPIntrEnable This functionenables thespecifiedInterrupts forECAP module.

Function name is updatedto follow the new codingguidelines. The APIaccepts masks value ofthe interrupts to beenabled from thefollowing enumecapIntrMask_t

NA

ECAPIntDisable ECAPIntrDisable This functionenables thespecifiedInterrupts forECAP module.

Function name is updatedto follow the new codingguidelines. The APIaccepts masks value ofthe interrupts to bedisabled from thefollowing enumecapIntrMask_t

NA

ECAPIntStatusClear ECAPIntrClear This API Clearsthe status ofspecifiedinterrupts.

Function name is updatedto follow the new codingguidelines. The APIaccepts interrupt maskvalue as the parameterfrom the following enumecapIntrMask_t. It alsoclears the Global Interruptbit to enable generation offurther interrupts.

NA

ECAPIntStatus ECAPIntrStatus This API returnsthe status of allactive andenabledinterrupts.

Function name is updatedto follow the new codingguidelines. The APIaccepts interrupt maskvalue as the parameterfrom the following enumecapIntrMask_t.

NA


--NA--- ECAPIntrTrigger This API triggersan interruptrequest for aspecified event.

New API. NA

ECAPPeripheralIdGet ECAPGetRevision This functionreturns theRevision ID ofthe ECAPmodule.


NA

EcapContextSave ECAPContextSave This API can beused to save theRegister contextof ECAP

Same as above. TheInterrupt Clear register isnot saved in the context.The capture event3 andevent4 registers are addedto the existing registerswhich are saved.

NA

EcapContextRestore ECAPContextRestore This API can beused to restorethe Registercontext of ECAP

Same as above. NA



ECAPClockEnableStatusGet --NA-- --NA--

ECAPClockDisableStatusGet --NA-- --NA--



ECAP_CAPTURE_MODE, ECAP_APWM_MODE Enum: ecapOperMode_t - The operating modesof the ECAP module are clubbed together in thisenum.

Macros are groupedlogically and are definedas per latest codingstandards.

ECAP_CAPTURE_EVENT_1, ECAP_CAPTURE_EVENT_2,

ECAP_CAPTURE_EVENT_3, ECAP_CAPTURE_EVENT_4

These are grouped into enum ecapCaptEvt_tandthe macro names are also updated to follow thecoding guidelines.

Macros are groupedlogically.

ECAP_CAPTURE_EVENT1_STOP,ECAP_CAPTURE_EVENT2_STOP,ECAP_CAPTURE_EVENT3_STOP,ECAP_CAPTURE_EVENT4_STOP

They are grouped together in the Enum: ecapStopWrapEvt_t - the macros are assignedauto generated values.


ECAP_COUNTER_STOP ,ECAP_COUNTER_FREE_RUNNING

These macros are not used by any APIs arereplaced by TRUE, FALSE macros which decidethe API behavior.


ECAP_SYNC_IN, ECAP_PRD_EQ,ECAP_SYNC_OUT_DISABLE, ECAP_SYNC_IN_DISABLE,

These macros are grouped into an enumecapSyncOutCfg_t and the macro names are alsoupdated to follow new coding guidelines.


ECAP_ENABLE_Counter This macro is replaced by TRUE/FALSE macrosto decide the API behavior.

New enum.

ECAP_CEVT1_INT, ECAP_CEVT2_INT, ECAP_CEVT3_INT,ECAP_CEVT4_INT, ECAP_CNTOVF_INT,ECAP_PRDEQ_INT, ECAP_CMPEQ_INT

These are grouped into an enum ecapIntrMask_tand macro names are also updated to follow newcoding guidelines.



ECAPCONTEXT Register Context Structure The Register Context structure is renamed asecapCtx_t with ECAPCtrl2, ECAPEVT3,ECAPEVT4 registers added to it.

Structure name updatedas per coding guidelines.

I2CThe below table lists the DAL file name differences between the versions


StarterWarev02.01.00.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. Thefile 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.


StarterWarev02.00.01.01Functionality


StarterWare v02.01.00.XX: Change Notes

I2CMasterInitExpClk The API configures theprescalers to divide theinternal clock toconfigure the bus speed.

I2CClkConfig The name has been changed to make theAPI generic as Clock configuration iscommon to both Master and Slave modesof operation.

NA

I2CMasterEnable The API enables the I2Cmodule.

I2CModuleEnable The features of Enabling/Disabling theModule is combined into a single API"I2CModuleEnable". The New API takesone of the following macros TRUE/FALSEas a parameter to enable/disable themodule.

NA

I2CMasterDisable The API disables theI2C module

I2CModuleEnable Same as above NA

I2CMasterBusBusy The API returns thestatus of the I2C buswhether it is busy orfree.

I2CBusBusyStatus The word "Master" is dropped from theAPI name to make it generic for bothMaster/Slave modes.

NA

I2CMasterErr The API returns theerror status if an errorhas occurred during theI2C transaction.

I2CErrStatus Same as above. NA

I2CMasterStart The API is used togenerate a STARTcondition on the I2CBus.

I2CStart Same as above. NA

I2CMasterStop The API is used togenerate a STOPcondition on the I2Cbus.

I2CStop Same as above. NA


I2CMasterIntEnableEx The API is used toenable specific interruptsof the module.

I2CIntrEnable The name of the API is changed accordingto new StarterWare coding guidelines.Macros that can be passed to the API areupdated and grouped together in an enumi2cIntr_t.

NA

I2CMasterIntDisableEx The API is used todisable specificinterrupts of the module

I2CIntrDisable Functionality remains the same. Rest of thechange Same as applicable forI2CIntrEnable API.

NA

I2CMasterIntStatus The API is used toreturn the Status of allactive and enabledinterrupts

I2CIntrStatus The name of the API is changed accordingto new StarterWare coding guidelines.

NA

I2CMasterIntStatusEx The API is used toreturn the status ofspecific interruptsspecified as a flagthrough one of the inputparameter.

I2CIntrStatus The feature of returning the Status ofspecific interrupt is merged intoI2CIntrStatus API.

NA

I2CMasterIntRawStatus The API is used toreturn the Status of allinterrupts (both enabledand not enabled).

I2CIntrRawStatus The name of the API is changed as per newStarterWare coding guideline.

NA

I2CMasterIntRawStatusEx The API is used toreturn the Status ofspecific interrupts (bothenabled and notenabled).

I2CIntrRawStatus The feature of getting the status of specificinterrupts is merged into I2CIntrRawStatus.

NA

I2CMasterIntClearEx The API clears the statusof specific interruptsaccording to the macrovalue passed by the user.

I2CIntrClear The API name is updated according to thelatest StarterWare coding guideline. Itaccepts the macros from the enumi2cIntr_t as an input parameter.

NA

I2CMasterIntRawStatusClearEx The API can be used totrigger an interrupt eventfor debug purpose.

I2CIntrTrigger The API name is updated to reflect thefunctionality it provides. And is as per thelatest StarterWare coding guideline. Itaccepts the macros from the enumi2cIntr_t as an input parameter.

NA

I2CMasterSlaveAddrSet The API is used to setthe Slave address of thedevice to which weintend to communicate.

I2CMasterSetSlaveAddr The API name is updated according to thelatest StarterWare coding guideline

NA

I2CMasterSlaveAddrGet The API returns theaddress of the slavedevice with which I2Cwants to communicate

I2CMasterGetSlaveAddr Same as above. NA

I2CSetDataCount The API configures thenumber of bytes that hasto be transferred in anI2C transaction.

I2CSetDataCount No Change NA

I2CDataCountGet The API gets the numberof bytes that has to bereceived or sent.

I2CGetDataCount The API name is updated is updated as perlatest StarterWare coding guideline.

NA


I2CFIFOThresholdConfig This API configures thethreshold value for FIFObuffer.

I2CFifoThresholdConfig Same as above NA

I2CFIFOClear This API Clears theTransmit and ReceiveFIFOs based on the userpassed parameter.

I2CFifoFlush Same as above. NA

I2CDMATxEventEnable The API enables theTransmit DMA channelof the module.

I2CDMATxEventEnable The new API is updated to accept a macro(TRUE/FALSE) as a user parameter toenable/disable the Tx DMA channel of theI2C.

NA

I2CDMATxEventDisable The API disables theTransmit DMA channelof the module.

I2CDMATxEventEnable The new API combines the feature todisable the Tx DMA channel which can beused by passing the macro (FALSE) to theAPI.

NA

I2CDMARxEventEnable The API enables theReceive DMA channelof the module.

I2CDMARxEventEnable The new API is updated to accept a macro(TRUE/FALSE) as a user parameter toenable/disable the Receive DMA channelof the I2C.

NA

I2CDMARxEventDisable The API disables theReceive DMA channelof the module.

I2CDMARxEventEnable The new API combines the feature todisable the Rx DMA Channel which can beused by passing the macro (FALSE) to theAPI.

NA

I2CBufferStatus The API returns thestatus of the I2C moduleFifos (Tx and Rx).

I2CBufStatus The API name is updated as per the latestStarterWare coding guidelines. The macroswhich can be passed to these functions aregrouped together in an enum i2cFifo_t.

NA

I2CActiveOwnAddressGet The API returns one ofthe module's four ownaddresses, which theexternal master usedwhen addressing themodule.

I2CSlaveGetActiveOwnAddr The API name is updated as per the latestStarterWare coding guidelines.

NA

I2COwnAddressSet This API configures anyone of the own addressfield out of four presentin I2C controller.

I2CSlaveSetOwnAddr The API parameters are updated to acceptthe address to be set, addr mode and addrindex separately. The addr mode and addrindex accept values from the followingenums i2cAddrMode_t andi2cOwnAddrIndex_t

NA

I2CClockBlockingControl This API blocks orunblocks the clock forany of the module's fourown addresses.

I2CSlaveClockBlockingEnable The API parameters are updated to acceptaddr index and a user flag to verify whetherClock Blocking should be enabled/disabled.

NA

I2CSoftReset It performs the Soft resetof the module.

I2CSoftReset No Change NA

I2CAutoIdleEnable Enables the AutoIdlefeature

I2CAutoIdleEnable The API is updated to enable/disable theAutoIdle mode according to the parameterpassed by the user. It accepts one of the twovalues (TRUE/FALSE).

NA

I2CAutoIdleDisable Disables the AutoIdlefeature

I2CAutoIdleEnable Same as above. NA


I2CIdleModeSelect Selects one of the idlemode operationmechanism.

I2CIdleModeSelect It is updated to accept one of the followingmacros from the followingenumi2cIdleMode_t

NA

I2CClockActivitySelect Disables external clockgating mechanism.

I2CClockActivitySelect It is updated to accept one of the followingmacros from the followingenumi2cClkAct_t

NA

I2CSystemStatusGet Indicates the state ofreset in case of hardwarereset, global reset orpartial reset.

I2CSystemStatus The API name is updated as per the latestStarterWare coding guidelines.

NA

I2CMasterDataPut Puts the byte in the Dataregister of the I2Cmodule.

I2CPutTxData Same as above NA

I2CMasterDataGet Gets the byte from theData register of the I2C.

I2CGetRxData Same as above NA

I2CWakeUpEnable Enables the specificIRQ/DMA requestsource to generate awakeup signal.

I2CWakeupEnable The API is now updated to enable thewakeup mechanism if the feature is notenabled before. It takes the macros from thefollowing enums to identify the wakesources and events i2cWakeupSrc_t andi2cWakeupEvt_t respectively.

NA

I2CGlobalWakeUpEnable Enables the wakeupmechanism.

I2CWakeupEnable The feature to enable the wakeupmechanism is handled internally within theI2CWakeUpEnable API.

NA

I2CWakeUpDisable Disables the specificIRQ/DMA requestsource which generate awakeup signal.

I2CWakeupDisable The API is now updated to disable thewakeup mechanism if the feature is notenabled before. It takes the macros from thefollowing enums to identify the wakesources and events i2cWakeupSrc_t andi2cWakeupEvt_t respectively.

NA

I2CGlobalWakeUpDisable Disables the wakeupmechanism.

I2CWakeupDisable The feature to disable the wakeupmechanism is handled internally within theI2CWakeUpEnable API.

NA

I2CMasterControl Configures the modulein different modes as perthe user passedparameters.

I2CSetMode The API name is updated as per the latestStarterWare guidelines. It takes macrovalues from the following enum i2cMode_t

NA

I2CContextSave This API can be used tosave the register contextof I2C

I2CContextSave No change. NA

I2CContextRestore This API can be used torestore the registercontext of I2C

I2CContextRestore No change. NA

--NA-- --NA-- I2CStartByteModeEnable This API enables the Start Byte mode of theI2C.

NewAPI


DeprecatedAPI

Equivalent API Reason for deprecating the API

I2CMasterBusy I2CMasterBusy ---


The macros and newly defined enum differences are highlighted below.

StarterWare 02.00.01.01 Macros StarterWare 02.01.00.XX Enums and Macros

Module configuration macros like I2C_CFG_XX The macro names remain the same but are grouped together in a enum i2cMode_t

--NA-- New enum defined to group possible addressing modes i2cAddrMode_t.

Interrupt related macros like I2C_INT_XX Macro name is updated to I2C_INTR_XX as per the latest StarterWare coding guideline and aregrouped together in the enum i2cIntr_t

Macros related to specifying wakeup eventsI2C_WAKE_UP_XX

Macro name is updated to I2C_WAKEUP_EVT_XX and are grouped together in the enumi2cWakeupEvt_t

Macros specifying wakeup sources Macro name changed to I2C_WAKEUP_SRC_XX and grouped together in the enumi2cWakeupSrc_t

Macros specifying own addresses likeI2C_OWN_ADDR_X

Macro name is updated to I2C_OWN_ADDR_INDEX_X and are grouped together in the enumi2cOwnAddrIndex_t

Macros specifying the different Idle modes macro name changed to I2C_IDLE_MODE_XX and grouped together under the following enumi2cIdleMode_t

Macros specifying the fifo types macros are grouped together under i2cFifo_t

Macros listing clock blocking activity Macros are grouped under i2cClkAct_t

Context structure: I2CCONTEXT Context structure is renamed to i2cCtx_t to follow coding guidelines.

WDTThe below table lists the DAL file name differences between the versions

StarterWare v02.00.01.01 StarterWare v02.01.00.XX: Reason for change

watchdog.c wdt.c WDT is followed for file, API, macro and enum names. Hence the name is changed.

watchdog.h wdt.h Same as above.

hw_watchdog.h hw_wdt.h Same as above.



StarterWare v02.00.01.01Functionality

StarterWare02.01.00.XX API

StarterWare 02.01.00.XX : Change Notes

WatchdogTimerRevisionIDGet The API returns the revisionID of WDT.

WDTGetRevision The API is updated to followStarterWare coding guidelines. Nofunctionality change is made.

NA

WatchdogTimerEnable The API enables the WDT. WDTEnable The API is updated to followStarterWare coding guidelines.Functionality change is this API alsocan disable the WDT by passing theparameter FALSE.

NA

WatchdogTimerDisable The API disables the WDT WDTEnable This API is removed since disable isalso done using WDTEnable API.

NA

WatchdogTimerReset This API shall reset theWDT

WDTReset The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerPreScalerClkEnable The API enables/configuresand also can disable theprescaler clock of WDT.

WDTPrescalerClkEnable The API is updated to followStarterWare coding guidelines.Functionality change is the same API isused to disable the prescaler clock.

NA


WatchdogTimerPreScalerClkDisable The API disables theprescaler clock of WDT.

WDTPrescalerClkDisable Same as above. NA

WatchdogTimerCounterSet The API is used to configurethe counter value of WDT.

WDTSetCounter The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerCounterGet The API is used to read thecounter value of WDT.

WDTGetCounter The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerReloadSet The API is used to set thereload value of WDT

WDTSetReloadVal The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerReloadGet The API is used to read thereload value of WDT

WDTGetReloadVal The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerTriggerSet The API is used to set thetrigger value of WDT.

WDTTriggerReload The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerDelaySet The API is used to set thedelay value

WDTSetDelayVal The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerDelayGet The API is used to read thedelay value.

WDTGetDelayVal The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerIntRawStatusSet This API is used to triggerthe raw interrupts of WDT.

WDTIntrTrigger The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerIntRawStatusGet The API is used to read theraw interrupt status of WDT.

WDTIntrRawStatus The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerIntStatusGet The API is used to read theinterrupt status of WDT.

WDTIntrStatus The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerIntStatusClear The API is used to clear theinterrupts of WDT

WDTIntrClear The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerIntEnable The API will enable theinterrupts of WDT.

WDTIntrEnable The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerIntDisable The API will disable theinterrupts of WDT.

WDTIntrDisable The API is updated to followStarterWare coding guidelines.

NA

WatchdogTimerWritePostedStatusGet This API is discarded. NA The functionality of this API is nowhandled using macro internally in anAPI.

NA

NA This API will set the idlemode for WDT.

WDTSetIdleMode This API is newly added. NA

NA This API will enable/disablethe emulation mode ofWDT.

WDTEmulationEnable This API is newly added. NA

NoteThe API WatchdogTimerIntEnableStatusGet() has been discarded since it is not longer needed.The macros and newly defined enum differences are highlighted below.



Prescaler configuration macros likeWDT_PRESCALER_CLK_DIV_XX

The macro names remain the same but are grouped together in a enumwdtPrescalerClkDiv_t

Interrupt related macros like WDT_INT_XX Macro name is updated to WDT_INTR_TYPE_XX as per the latest StarterWarecoding guideline and are grouped together in the enum wdtIntrMask_t

Macros related to configure the posted mode likeWDT_WRITE_PENDING_XX

Macro name is updated to WDT_WRITE_POST_XX and are grouped together in theenum wdtWritePost_t

Macros specifying enable interrupts likeWDT_INT_ENABLE_XX

Macro name is updated to WDT_INTR_TYPE_XX as per the latest StarterWarecoding guideline and are grouped together in the enum wdtIntrMask_t

Macros specifying disable interrupts likeWDT_INT_DISABLE_DELAY

Macro name is updated to WDT_INTR_TYPE_XX as per the latest StarterWarecoding guideline and are grouped together in the enum wdtIntrMask_t

TSCADCThe below table lists API differences between the versions

StarterWare v02.00.xx.xx: API Name StarterWare v02.01.xx.xx: API Name StarterWarev02.00.xx.xx:Functionality

StarterWare v02.01.xx.xx: Changes Notes

TSCADCTSChargeStepOpenDelayConfig TSCADCTsSetChargeStepDelay Configure the opendelay for charge step

API name is not following the codingguidelines.

NA

TSCADCBiasConfig TSCADCSetBias Set the ADC bias API name is not following the codingguidelines.

NA

TSCADCIntStatusClear TSCADCIntrClear Clear the interruptstatus

API name is not following the codingguidelines. Intr is the convention to befollowed for interrupts. Also status isnot used in Interrupt clear APIs.

NA

TSCADCIntStatus TSCADCIntrStatus Get the interrupt status API name is not following the codingguidelines. Intr is the convention to befollowed for interrupts

NA

TSCADCEventInterruptEnable TSCADCIntrEnable Enable interrupts API name is not following the codingguidelines. Intr is the convention to befollowed for interrupts.

NA

TSCADCHWEventMapSet TSCADCSetHwEventMap Configure Hw event toeither pen IRQ or HWevent signal

Only change is HW -> Hw NA

TSCADCEventInterruptDisable TSCADCIntrDisable Disable interrupts API name is not following the codingguidelines. Intr is the convention to befollowed for interrupts.

NA

TSCADCTSTransistorConfig NA Enable/Disabletouchsceen transistors

This API is removed and is notneeded. Transistor configuration isautomatically handled whentouchscreen mode is used.

NA

TSCADCTSModeConfig TSCADCSetMode Configure controllerfor 4/5 wire or GPmode

TS is removed NA

TSCADCSetADCPowerDown TSCADCAfePowerDown Power down the AFEof ADC

Set is not required in the API. NA


TSCADCSetADCPowerUp TSCADCAfePowerUp Power up the AFE ofADC

Set is not required in the API. NA

TSCADCStepConfigProtectionDisable TSCADCStepConfigWrProtectEnable Disable the step configwrite protectionfeature.

Disable feature is incorporated inTSCADCStepConfigProtectionEnable.FALSE needs to be passed as thesecond parameter.

NA

TSCADCStepIDTagConfig TSCADCStepIdTagEnable Enable/disable the stepid tag

ID -> Id. TRUE/FALSE values as theparameters.

NA

TSCADCModuleStateSet TSCADCEnable Enable/DisableTSCADC

API name was not matching thefunctionality.

NA

TSCADCSequencerFSMBusyStatus TSCADCStatus Check the TSCADCFSM busy status

The new API will send the status ofentire register and it is responsibilityof application to check the requiredstatus. In the case the app can use theentryTSCADC_STATUS_FSM_BUSYfrom tscAdcStatus_t enum.

NA

TSCADCSequencerCurrentStepID TSCADCStatus Check the TSCADCcurrent step ID

The new API will send the status ofentire register and it is responsibilityof application to check the requiredstatus. In the case the app can use theentry TSCADC_STATUS_STEP_IDfrom tscAdcStatus_t enum.

NA

TSCADCSequencerPenIrqStatusRead TSCADCStatus Check the TSCSDCIRQ0 or IRQ1 status

The new API will send the status ofentire register and it is responsibilityof application to check the requiredstatus. In the case the app can use theentry TSCADC_PEN_IRQ0 andTSCADC_PEN_IRQ1 fromtscAdcStatus_t enum.

NA

TSCADCConfigureAFEClock TSCADCClkDivConfig Configure theTSCADC clockdivider.

The new API represents thefunctionality better and also followsthe coding guidelines.

NA

TSCADCIdleModeSet TSCADCSetIdleMode Configure the Idlemode of TSCADCmodule

API name is updated to follow codingguidelines.

NA

TSCADCRawIntStatusSet TSCADCIntrTrigger Trigger the TSCADCRaw interrupts

API name is updated to follow codingguidelines.

NA


TSCADCRawIntStatusRead TSCADCIntrRawStatus Read the TSCADCRaw interrupt status.This API would readthe interrupt statusgiven by flag.However according tocoding convention thisis not followed andhence theTSCADCIntrRawStatusAPI needs to be usedwhich shall pass theoverall registercontents andapplication needs tocheck the specificstatus.

This API is removed. NA

TSCADCRawIntStatus TSCADCIntrRawStatus Read the TSCADCRaw interrupt status

New API follows the codingguidelines.

NA

TSCADCIntStatusRead TSCADCIntrStatus Read the TSCADCinterrupt status. ThisAPI would read theinterrupt status givenby flag. Howeveraccording to codingconvention this is notfollowed and hencetheTSCADCIntrRawStatusAPI needs to be usedwhich shall pass theoverall registercontents andapplication needs tocheck the specificstatus.

This API is removed. NA

TSCADCWakeUpPenEventConfig TSCADCTsWakeUpPenEventEnable Enable/Disable thewakeup HW pen eventof TSCADC.


NA

TSCADCDMAFIFOEnable TSCADCDmaFifoEnable API signature ischanged. To disableDMA for FIFO thesame API will be usedby using the entryFALSE fordmaEnable.


NA

TSCADCDMAFIFODisable TSCADCDmaFifoEnable Disable the DMA forFIFO.

This API is discarded. Disablefunctionality is handled inTSCADCDMAFIFOEnable API.

NA

TSCADCIsDMAFIFOEnabled NA Check the DMA status This API is discarded. Not usedanywhere. Not required.

NA

TSCADCConfigHWEventPrempt TSCADCHwPreemptEnable Enable/Disable thehardware preemptfunctionality.

API name is changed to follow codingguidelines.

NA


TSCADCOutputRangeConfig TSCADCSetRange Configue the high andlow range values.


NA

TSCADCConfigureMisc TSCADCMiscConfig Configure the spareinput and outputvalues


NA

TSCADCConfigureStepEnable TSCADCStepEnable Enable/Disable therequired step


NA

TSCADCIdleStepOperationModeControl TSCADCTsIdleStepConfig Configure the modefor TSCADC. Eithersingle ended ordifferential.

All Idle step configurations arecombined into a single APIs. AlsoAPI is made to touchscreen specific.

NA

TSCADCIdleStepConfig TSCADCTsIdleStepConfig Configure the Idle stepof TSCADC.

API name is changed to make itTouch screen specific and also theAPI parameter order is updated.

NA

TSCADCIdleStepAnalogSupplyConfig TSCADCTsIdleStepConfig Provide analog supplyfor the Idle step.


NA

TSCADCIdleStepAnalogGroundConfig TSCADCTsIdleStepConfig Provide analog groundfor the idle step.


NA

TSCADCChargeStepOperationModeControl TSCADCTsChargeStepConfig Configure the modefor TSCADC. Eithersingle ended ordifferential.

API is discarded and all charge stepfunctionality is added in a single API.

NA

TSCADCChargeStepConfig TSCADCTsChargeStepConfig Configure the chargestep of ADC

API name is changed to follow codingguidelines and also to make itTouchscreen specific

NA

TSCADCChargeStepAnalogSupplyConfig TSCADCTsChargeStepConfig Provide analog supplyfor the charge step


NA

TSCADCChargeStepAnalogGroundConfig TSCADCTsChargeStepConfig Provide analog groundfor the charge step


NA

TSCADCChargeStepOpenDelayConfig TSCADCTsChargeStepDelayConfig Configure the opendelay value for Chargestep

API name is changed to follow codingguidelines and also to make itTouchscreen specific

NA

TSCADCTSStepOperationModeControl TSCADCStepConfig Configure the step forsingle ended ordifferential.

API is discarded and all stepfunctionality is added in a single API.

NA

TSCADCTSStepConfig TSCADCStepConfig Configure theTSCADC step

API name is updated to not make itTouchscreen specific. Paramter orderis updated.

NA

TSCADCTSStepAnalogSupplyConfig TSCADCStepConfig Configure the Analogsupply for the step


NA

TSCADCTSStepAnalogGroundConfig TSCADCStepConfig Configure the Analogground supply for thestep


NA

TSCADCTSStepOutOfRangeCheckEnable TSCADCStepRangeCheckEnable Enable/Disable out ofrange check

API name is updated to not make itTouchscreen specific. TRUE needs tobe used to enable.

NA


TSCADCTSStepFIFOSelConfig TSCADCStepFifoConfig Configure the FIFOfor the correspondingstep.

API name is updated to not make itTouchscreen specific.

NA

TSCADCTSStepAverageConfig TSCADCStepSamplesAvg Configure the numberof samples to beconfigured.


NA

TSCADCTSStepOutOfRangeCheckDisable TSCADCStepOutOfRangeCheckEnable Enable/Disable out ofrange check

API name is updated to not make itTouchscreen specific. FALSE needsto be used to disable.

NA

TSCADCTSStepModeConfig TSCADCStepMode Configure the Stepmode


NA

TSCADCTSStepSampleDelayConfig TSCADCSetStepDelay Configure the samplead open delay for thestep

API name is updated to not make itTouchscreen specific and the APItakes 2 parameters which canconfigure sample and open delay.

NA

TSCADCTSStepOpenDelayConfig TSCADCSetStepDelay Configure the samplead open delay for thestep

API name is updated to not make itTouchscreen specific and the APItakes 2 parameters which canconfigure sample and open delay.

NA

TSCADCFIFOChannelIDRead TSCADCGetFifoStepId Read the channelnumber whose data isbeing captured in thecorresponding FIFO.


NA

TSCADCFIFOADCDataRead TSCADCGetFifoData Read the capturedFIFO data


NA

TSCADCFIFOWordCountRead TSCADCGetFifoWordCount Read the FIFO wordcount


NA

TSCADCFIFOIRQThresholdLevelConfig TSCADCStepFifoConfig Configure the FIFOthreshold level togenerate interruptrequest


NA

TSCADCFIFODMAThresholdLevelConfig TSCADCStepFifoConfig Configure the FIFOthreshold level togenerate DMA request


NA

TSCADCStepConfigProtectionEnable TSCADCStepConfigWrProtectEnable Enable the step configwrite protectionfeature.

API name is changed NA



StarterWare v02.00.xx.xx: StarterWare v02.01.xx.xx: Reason forchange

TSCADC_XX_INT Macro names are updated to follow coding guidelines andare grouped inside the enum tscAdcIntrMask_t

Follow codingguidelines andmacros arelogically grouped

TSCADC_HW_INPUT_EVENT, TSCADC_PEN_TOUCH Macro names are updated to follow coding guidelines andare grouped inside the enum tscAdcHwEventMap_t


TSCADC_TRANSISTOR_DISABLE,TSCADC_TRANSISTOR_ENABLE

Macros are discarded. Follow codingguidelines.TRUE/FALSEwould do.

TSCADC_X_WIRE_MODE,TSCADC_GENERAL_PURPOSE_MODE

Macro names are updated to follow coding guidelines andare grouped inside the enum tscAdcMode_t


TSCADC_MODULE_ENABLE,TSCADC_MODULE_DISABLE

These macros are deleted. Macro was used with the API""TSCADCModuleStateSet"". The API is updated toTSCADCEnable which will take TRUE/FALSE instead ofTSCADC_MODULE_ENABLE orTSCADC_MODULE_DISABLE

Follow codingguidelines

TSCADC_PEN_IRQ_0, TSCADC_PEN_IRQ_1 The macros are represented in tscAdcStatus_t enum. Follow codingguidelines andmacros arelogically grouped

TSCADC_FORCE_IDLE, TSCADC_NO_IDLE,TSCADC_SMART_IDLE,TSCADC_SMART_IDLE_WAKEUP

This macro is replaced with entries present intscAdcIdleMode_t enum..


TSCADC_WAKEUP_DISABLE,TSCADC_WAKEUP_ENABLE

These macros are discarded since it is not required. Thismacro was being used in the APITSCADCWakeUpPenEventConfig(). The API is updated toTSCADCWakeUpPenEventEnable which takes valuesTRUE/FALSE to enable/disable the wakeup for TSCADCrespectively.


TSCADC_FIFO_0, TSCADC_FIFO_1 These macros are updated to entries present intscAdcFifoSel_t enum.


TSCADC_INTERNAL_AC_BIAS,TSCADC_EXTERNAL_AC_BIAS

These macros are updated to entries present in tscAdcBias_tenum.


TSCADC_POSITIVE_INP_CHANNELX,TSCADC_NEGATIVE_INP_CHANNELX,TSCADC_POSITIVE_INP_ADCREFM

The macro set is made as a part of enumtscAdcPositiveInput_t


TSCADC_NEGATIVE_INP_ADCREFM The macro is updated toTSCADC_NEGATIVE_INP_VREFN to match conventiongiven in TRM and is a part of enum tscAdcNegativeInput_t


TSCADC_ADC_SINGLE_ENDED_OPER_MODE,TSCADC_ADC_DIFFERENTIAL_OPER_MODE

These macro values are converted to a enum entry of enumtscAdcDiffCtrl_t



TSCADC_XPPSW_PIN_ON, TSCADC_XPPSW_PIN_OFF These macro values are represented byTSCADC_XPPSW_PIN_CFG_ON entry ontscAdcXppswPinCfg_t enum


TSCADC_XNPSW_PIN_ON, TSCADC_XNPSW_PIN_OFF These macro values are represented by entries intscAdcXnpswPinCfg_t enum


TSCADC_YPPSW_PIN_ON, TSCADC_YPPSW_PIN_OFF These macro values are represented by entries present intscAdcYppswPinCfg_t enum


TSCADC_XNNSW_PIN_ON, TSCADC_XNNSW_PIN_OFF The macro value are represented by entries present intscAdcXnnswPinCfg_t enum


TSCADC_YPNSW_PIN_ON, TSCADC_YPNSW_PIN_OFF These macro values are represented by entries present intscAdcYpnswPinCfg_t enum


TSCADC_YNNSW_PIN_ON, TSCADC_YNNSW_PIN_OFF These macro values are represented by entries present intscAdcYnnswPinCfg_t enum


TSCADC_WPNSW_PIN_ON, TSCADC_WPNSW_PIN_OFF These macro values are represented by entries present intscAdcWpnswPinCfg_t enum


TSCADC_TWO_SAMPLES_AVG,TSCADC_FOUR_SAMPLES_AVG,TSCADC_SIXTEEN_SAMPLES_AVG,TSCADC_EIGHT_SAMPLES_AVG

These macro values are represented by entries present intscAdcSamplesAvg_t enum


TSCADC_ONE_SHOT_SOFTWARE_ENABLED,TSCADC_CONTINUOUS_SOFTWARE_ENABLED,TSCADC_ONE_SHOT_HARDWARE_SYNC,TSCADC_CONTINIOUS_HARDWARE_SYNC

The macro values are represented by entries present intscAdcStepMode_t enum


TSCADC_HW_EVENT_MAP_HW_EVENT This macro is updated toTSCADC_HW_EVENT_MAP_HW_INPUT member oftscAdcHwEventMap_t enum


TSCADC_MODE_GP This macro is updated to TSCADC_MODE_GP_ADCmember of tscAdcMode_t enum


TSCADC_STEP_ID_TAG_CFG_WRITE_ZEROES Macros are discarded since not required. Follow codingguidelines

TSCADC_STEP_ID_TAG_CFG_STORE_CHAN_ID Macros are discarded since not required. Follow codingguidelines

MCSPIThe below table lists API differences between the versions





Notes

MCSPIClkConfig MCSPIClkConfig Configures the clock. No changes done NA

McSPIWordLengthSet MCSPISetWordLength Configure the word length. No functionality changes done.API name is updated to followcoding guidelines.

NA

McSPICSEnable MCSPICsEnable Enable/Disable the chipselect pin.

Same API is used toenable/disable the chip selectby passing TRUE/FALSErespectively.

NA

McSPICSTimeControlSet MCSPISetCsTimeControl Configure the chip selecttime control value.

API name updated to followcoding guidelines. Alsoparameter order is changed.

NA


McSPICSAssert MCSPICsAssert Assert the chip select line. API name updated to followcoding guidelines.

NA

McSPICSDeAssert MCSPICsDeAssert Deassert the chip select line. API name updated to followcoding guidelines.

NA

McSPIStartBitEnable MCSPIStartBitEnable Enable/Disable start bit forSPI transfer.

Same API shall be used toenable/disable the functionalityby passing TRUE/FALSErespectively

NA

McSPIStartBitPolarityConfig MCSPISetStartBitPol Configure the start bitpolarity.

API name updated to followcoding guidelines. Alsoparameter order is changed.

NA

McSPIMasterModeEnable MCSPIModeConfig Configure the MCSPIcontroller in Master/Slavemodes and other requiredparameters of the mode.

Master/Slave mode can beconfigured using this API. APIname is updated accordingly.

NA

McSPISlaveModeEnable MCSPIModeConfig Configure the MCSPIcontroller in Slave modesand other requiredparameters of the mode.

Slave mode can be configuredusing this API. API name isupdated accordingly.

NA

McSPISlaveModeConfig MCSPIModeConfig Configure the MCSPIcontroller in Slave modesand other requiredparameters of the mode.

Slave mode can be configuredusing this API. API name isupdated accordingly.

NA

McSPIChannelEnable MCSPIChEnable Enable/Disable the channelof MCSPI controller.

Same API shall be used toenable/disable the functionalityby passing TRUE/FALSErespectively. API nameupdated.

NA

McSPIReset MCSPIReset Reset the MCSPI controller. API name updated to followcoding guidelines.

NA

McSPITurboModeEnable MCSPITurboModeEnable Enable/Disable TURBOmode of operation.

Same API is used toenable/disable the functionalityby passing TRUE/FALSErespectively

NA

McSPITxFIFOConfig MCSPITxFifoEnable Enable/disable the Tx FIFO. API name is updated as percoding guidelines

NA

McSPIRxFIFOConfig MCSPIRxFifoEnable Enable/disable the Rx FIFO. API name is updated as percoding guidelines

NA

McSPIFIFOTrigLvlSet MCSPISetFifoTriggerLvl Set the transfer levels usedby FIFO depending on thevarious MCSPItransmit/receive modes.

API name is updated as percoding guidelines

NA

McSPIWordCountSet MCSPISetWordCount Configure the SPI wordcount.


NA

McSPIDMAEnable MCSPIDmaEnable Enable/Disable the MCSPIDMA events.

Same API shall be used toenable/disable the functionalityby passing TRUE/FALSErespectively

NA

McSPIIntEnable MCSPIIntrEnable Enable the MCSPI Interrupts. API name is updated as percoding guidelines

NA


McSPIIntDisable MCSPIIntrDisable Disable the MCSPIInterrupts.


NA

McSPIInitDelayConfig MCSPISetInitialDelay Configure delay for the firsttransfer from MCSPIperipheral.


NA

McSPITransmitData MCSPITransmitData Configure data to betransmitted.


NA

McSPIReceiveData MCSPIReceiveData Read received data. API name is updated as percoding guidelines

NA

McSPIIntStatusGet MCSPIIntrStatus Return the status of theMCSPI interrupts.


NA

McSPIIntStatusClear MCSPIIntrClear Clear the MCSPI Interruptstatus.


NA

McSPIChannelStatusGet MCSPIChStatus Read the MCSPI channelstatus.


NA

McSPIMultipleWordAccessConfig MCSPIMultipleWordAccessEnable Enable/disable the multiword OCP access feature ofMCSPI.


NA

McSPIFIFODatManagementConfig MCSPIFifoDataMgmtEnable Enable/Disable the FIFO datamanagement feature.


NA

McSPICSPolarityConfig MCSPISetCsPol Set the chip select polarity. API name is updated to followcoding guidelines. Parameterorder is changed.

NA



McSPICSDisable MCSPICsEnable Coding guidelines follow single API to enable/disable a feature

McSPIStartBitDisable MCSPIStartBitEnable Coding guidelines follow single API to enable/disable a feature

McSPIChannelDisable MCSPIChEnable Coding guidelines follow single API to enable/disable a feature

McSPITurboModeDisable MCSPITurboModeEnable Coding guidelines follow single API to enable/disable a feature

McSPIDMADisable MCSPIDmaEnable Coding guidelines follow single API to enable/disable a feature



MCSPI_CHANNEL_X Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiChNum_t

Follow coding guidelines and macrosare logically grouped

MCSPI_MAX_CH Macro discarded since not required. Follow coding guidelines

MCSPI_CLK_GRAN_X Macro discarded since not required. Follow coding guidelines

MCSPI_CLK_MODE_X Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiClkMode_t.

Follow coding guidelines

MCSPI_X_CH Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiCh_t.


MCSPI_CS_TCS_XPNT5_CLK Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiCsTimeCtrl_t.


MCSPI_START_BIT_POL_X Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiStartBitPol_t.



MCSPI_DATA_LINE_COMM_MODE_X Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiDataLineCommMode_t.


MCSPI_INITDLY_X Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiInitDelayCfg_t.


MCSPI_X_MODE Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiTransferMode_t.


MCSPI_INT_X Macro names are updated as MCSPI_INTR_X Follow coding guidelines

MCSPI_CH_X Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiChStatus_t.


MCSPI_WORD_LENGTH(n) This macro is deleted. Better way is to directly pass thenumber instead of representing itthrough macro.

MCSPI_CS_POL_X Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiCsPol_t.


MCSPI_DMA_X_EVENT Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiDmaEvent_t.


MCSPI_SET_STATUS_BIT This macro is deleted. Not required

MCSPI_CLK_X This macro is deleted. Not required

MCSPI_MOA_X Macro names are updated to follow coding guidelines and aregrouped inside the enum mcspiMultiWordAccess_t.


MCSPI_RX_FIFO_X Macros are deleted. Feature is handled using valuesTRUE/FALSE

MCSPI_FDAA_X This macro is deleted. Mode is not supported

MCSPI_TX_FIFO_X Macros are deleted. Feature is handled using valuesTRUE/FALSE

UARTThe below table lists the DAL file name differences between the versions



Reason for change

uart_irda_cir.c uart.c The IRDA and CIR features are not supported by StarterWare and the file is renamed toreflect the same.

uart_irda_cir.h uart.h Same as above.

hw_uart.h hw_uart.h Same as above.

uart.h and uart.c uart_v1.h and uart_v1.c These files related to AM1808 are redundant and are renamed as per latest guidelines.



StarterWare v02.00.01.01: API Name StarterWare v02.01.00.XX:API Name



UARTModuleVersionNumberGet UARTGetRevision This API returns theRevision Number of theUART module.


NA

UARTModuleReset UARTModuleReset This API performs a modulereset of the UART instance.It also waits until the resetprocess is complete.

No Change with previous API. NA

UARTRegConfigModeEnable UARTSetRegAccessMode This API configures thespecified Register Accessmode of UART to allowaccess to certain registers.

Function name is updated to follownew coding guidelines. The APIaccepts the register mode value as aparameter from the following enumuartRegAccessMode_t

NA

UARTDivisorLatchWrite, UARTDivisorLatchEnable,

UARTDivisorLatchDisable andUARTDivisorValCompute

UARTSetBaudRate This API sets the baud ratevalue for the UARToperation according to thevalue passed by the user.

Function name is updated to follow thenew coding guidelines. The APIcombines the features of enablingaccess to divisor latch register,computing divisor value and settingbaudRate in to a single API. The APItakes baudrate input from the followingenum uartBaudRate_t

NA

UARTIntEnable UARTIntrEnable This API disables thesynchronization. Even ifsync-in event occurs thecount value will not bereloaded.

Function name is updated to follow thenew coding guidelines. The API returnsone of the macros from the followingenum uartIntrMask_t to indicate theinterrupt to be enabled.

NA

UARTIntDisable UARTIntrDisable This API disables thespecified interrupts in theUART mode ofoperation.

Function name is updated to follow thenew coding guidelines. The API returnsone of the macros from the followingenum uartIntrMask_t to indicate theinterrupt to be disabled.

NA

UARTIntIdentityGet UARTIntrStatus This API returns the status ofUART Interrupts.

Function name is updated to follow thenew coding guidelines. The API returnsone of the macros from the followingenum uartIntrMask_t to indicate theinterrupt status.

NA

UARTIntPendingStatusGet UARTIsIntrPending This API determines whetherany UART interruptcondition is pending to beserviced.

Function name is updated to follow thenew coding guidelines. The API returnsTRUE/FALSE to indicate if aninterrupt is pending or not.

NA

UARTTxEmptyIntControl UARTTxEmptyIntrEnable This API is used toenable/disable the feature toget Transmit interrupts when both the TxFIFO and the Shift registerbecome empty.

Function name is updated to follow thenew coding guidelines. The APIaccepts enableTxEmptyIntr as aparameter which acceptsTRUE/FALSE to control the feature.

NA

UARTRxErrorGet UARTLineStatus This API returns the Linestatus of UART includingerrors and FIFO status.

Function name is updated to follow thenew coding guidelines. The API returnsthe Line Status of UART Line with themacros from the following enumuartLineSts_t .

NA


UARTLineCharacConfig UARTLineCharacteristicConfig The API configures the linecharacteristic required for aUART frametransmission/reception.

Function name is updated to follow thenew coding guidelines. The APIaccepts stop bits and character length asa separate parameter compared to theprevious API.

NA

UARTFIFOConfig UARTFifoConfig This API configures theFIFO settings for the UARTinstance.

This API provides a commoninterface for configuring theFIFO related settings throughboth the FCR and TLR/TCRregisters.The following Fifo relatedconfiguration are done by theAPI.- Enables the FIFO mode ofUART- Transmitter and ReceiverFIFO Trigger Levelgranularity setting- Transmitter and ReceiverFIFO Trigger Levelconfiguration- Clearing of the Tx and RxFIFOs- Enables/Disables the DMAmode of operation

The API accepts a structureuartFifoCfg_t as a parameter forconfiguring the FIFO in differentsettings. This API does not provide theoption of configuring FIFO triggerlevel settings only through the FCRregister. The FIFO trigger levels areconfigured either through TLR or acombination of FCR and TLR registers.

NA

UARTFIFOEnableStatusGet UARTIsFifoEnabled This API determines whetherFIFO mode of operation isenabled for the UARTinstance or not.

Function name is updated to follow thenew coding guidelines. The API returnsTRUE/FALSE to indicate if the FIFOmode is enabled or not.

NA

UARTWakeUpEventsEnable UARTWakeupEventEnable This API enable the Wakeupcapability for the specifiedevents.

Function name is updated to follow thenew coding guidelines. The APIparameter wakeupEvent takes one ofthe macros as input from the followingenum uartWakeupEvent_t

NA

UARTWakeUpEventsDisable UARTWakeupEventDisable This API disable the Wakeupcapability for the specifiedevents.

Function name is updated to follow thenew coding guidelines. The APIparameter wakeupEvent takes one ofthe macros as input from the followingenum uartWakeupEvent_t

NA

NA UARTWakeupIntrEnable This API enables/disables thewakeup interrupt feature..

. Function name is updated to followthe new coding guidelines.

NA

UARTAutoIdleModeControl UARTAutoIdleEnable This API is used tocontrol(enable/disable) theAuto-Idle mode of operationof the UART.

Function name is updated to follow thenew coding guidelines. TheAPI parameter takes TRUE/FALSE toenable/disable the idle mode.

NA

UARTIdleModeConfigure UARTSetIdleMode This API sets UART to oneof the idle mode mechanism.

Function name is updated to follow thenew coding guidelines. The APIparameter idleMode takes any of themacros from the following enumuartIdleMode_t

NA


UARTLoopbackModeControl UARTLoopbackEnable This APIcontrols(enables/disables) theLoopback mode of operation for the UART instance.

SaFunction name is updated to followcoding guidelines. The API parameterenableLoopBack takes TRUE orFALSE to control the Loopback mode.

NA

UARTBreakCtl UARTBreakCtrlEnable This API is used toenable/disable a Breakcondition where thetransmitter output goes lowto alert the communicationterminal.

Function name is updated to followcoding guidelines. The API parameterenableBrkCtrl takes TRUE or FALSEto control the Break Control feature.

NA

UARTTxFIFOLevelGet UARTGetFifoLevel This API determines thecurrent level of theTransmitter FIFO.

Function name is updated to followcoding guidelines. The API returns thelevel of FIFO in bytes.

NA

UARTTxFIFOFullStatusGet UARTIsTxFifoFull This API determines whetherthe Transmitter FIFO is fullor not.

Function name is updated to followcoding guidelines. The API returnsTRUE/FALSE to indicate the status ofthe Tx FIFO.

NA

UARTCharsAvail UARTIsCharAvail This API checks if the RXFIFO has atleast one byte ofdata to be read.

Function name is updated to followcoding guidelines. The API returnsTRUE/FALSE to indicate that there isatleast one byte of data to be read.

NA

UARTSpaceAvail UARTIsSpaceAvail This API checks whether theTX FIFO is empty or not.

Function name is updated to followcoding guidelines. The API returnsTRUE/FALSE to indicate that there isspace available in the FIFO to read ornot.

NA

UARTCharGet UARTGetChar This API reads a characterfrom the UART.

The UARTGetChar API provides acommon interface to read a characterfrom UART in the following differentways

1: Blocking - it waits indefinitely untila character arrives

2: Non-Blocking - it checks once if acharacter arrived and

returns the character or returns error.

3: Timeout - it waits til the occurenceof a timeout for the

arrival of a character and returns thecharacter else

returns a Timeout error.

NA

UARTCharPut UARTPutChar This API puts a character tothe UART FIFO fortransmission.

The UARTPutChar API provides acommon interface to write a characterto UART in the following differentways 1: Blocking - it waits indefinitelyuntil there is space to

write a character.

2: Non-Blocking - it checks onceif there is space in the FIFO to write acharacter.

3: Timeout - it waits til the occurenceof a timeout for a

space in the FIFO to write a characteror else returns a timeout error.

NA


UARTCharGetNonBlocking, UARTCharGet,UARTCharPutNonBlocking

UARTGetChar andUARTPutChar

Refer above explaination forUARTGetChar andUARTPutChar

Refer above explaination forUARTGetChar and UARTPutChar.

UARTFIFOWrite UARTFifoWrite This API copies therequested amount of datafrom the specified data blockto the UART Transmit FIFO.

Function name is updated to followcoding guidelines. The API does notreturn any value indicating the numberof bytes returned, as the API does notcheck emptiness of the FIFO beforewriting.

NA

UARTDMAEnable UARTDmaEnable This API Enables the DMAmode and configures theDMA mode for the UARTmodule.

Function name is updated to followcoding guidelines. The API takesdmaMode as a parameter from thefollowing enum uartDmaMode_t

NA

UARTDMADisable UARTDmaDisable This API disables the DMAmode of operation and clearsthe DMA mode set for theUART instance.

Function name is updated to followcoding guidelines.

NA

UARTTxDMAThresholdControl UARTDmaTxThresholdEnable This functionenables/disables the settingthe TX_DMA_THRESHOLDregister which holdsTransmit DMA Thresholdvalue to be used.

Function name is updated to followcoding guidelines. TheenableTxThreshold parameter takesTRUE/FALSE to controlenabling/disabling of the feature.

NA

UARTTxDMAThresholdValConfig UARTSetDmaTxThreshold This function sets theTransmit DMA Thresholdvalue to be used. This is usedwhen Direct method ofsetting Tx DMA threshold isused.

Function name is updated to followcoding guidelines.

NA

UARTDMACounterResetControl UARTDmaCounterResetEnable This API controlsenabling/disabling the DMACounter Reset when theFIFO reset option is selected.

Function name is updated to follow thenew coding guidelines. TheenableCounterReset parameter takesTRUE/FALSE to controlenabling/disabling of the feature.

NA

UARTAutoRTSAutoCTSControl UARTAutoRtsEnable This API enables/disables theAuto-RTS (Request to Send)hardware flow controlfeature.

Function name is updated to follow thenew coding guidelines. TheenableRtsCtrl parameter can takeeither TRUE/FALSE to controlenabling/disabling of the Auto-RTSfeature.

NA

UARTAutoRTSAutoCTSControl UARTAutoCtsEnable This API enables/disables theAuto-CTS (Clear to Send)hardware flow controlfeature.

Function name is updated to follow thenew coding guidelines. TheenableCtsCtrl parameter can takeeither TRUE/FALSE to controlenabling/disabling of the Auto-CTSfeature.

NA

UARTFlowCtrlTrigLvlConfig UARTSetFlowCtrlTriggerLvl This API configures theReceiver FIFO trigger levelstostart/stop transmission whenflow control feature ofUART is enabled.

Function name is updated to follow thenew coding guidelines. The APIparameters rxHaltTriggerLvl andrxStartTriggerLvl to configuresoftware flow control.

NA


UARTSoftwareFlowCtrlOptSet UARTSwFlowCtrlConfig This API configures thedifferent Software FlowControl combinations.

Function name is updated to follow thenew coding guidelines. The APIparameter flowCtrlCfg takes valuesfrom the following enumuartSwFlowCtrlCfg_t

NA

UARTXON1XOFF1ValProgram UARTSetXon1Xoff1Char This API sets the XON1 andXOFF1 characters requiredto indicate the Start/Stop oftransmission when softwareflow control is enabled.


NA

UARTXON2XOFF2ValProgram UARTSetXon2Xoff2Char This API sets the XON2 andXOFF2 characters requiredto indicate the Start/Stop oftransmission when softwareflow control is enabled.


NA

UARTXONAnyFeatureControl UARTXonAnyFeatureEnable This API Enables/Disablesthe XON any feature ofSoftware Flow Control.

Function name is updated to follow thenew coding guidelines. The APIparameter enableXonAnyFeaturetakes TRUE/FALSE to controlenabling/disabling of the SpecialCharacter Detect feature.

NA

UARTSpecialCharDetectControl UARTSpecialCharDetectEnable This API controlsenabling/disabling the featureof detecting SpecialCharacter through the UARTreceiver.

Function name is updated to follow thenew coding guidelines. The API takesTRUE/FALSE to controlenabling/disabling of the SpecialCharacter Detect feature.

NA

UARTPulseShapingControl UARTPulseShapingEnable This API controlsenabling/disabling the PulseShaping feature of theUART.

Function name is updated to follow thenew coding guidelines. The API takesTRUE/FALSE to controlenabling/disabling of the Pulse Shapingfeature.

NA

UARTResumeOperation UARTResumeOper This API clears the interruptflags to resume UARTtransmission when halted dueto overflow/underrun errors.


NA

UARTModemControlSet UARTModemCtrlEnable This API switches thespecified Modem ControlSignals to active statedepending on the optionpassed by user.

Function name is updated to follow thenew coding guidelines. The API takesmodemPin and enableCtrlPin as theparameter to set the modem ctrl pins toactive and inactive state.

NA

UARTModemControlClear UARTModemCtrlEnable This API switches thespecified Modem ControlSignals to inactive statedepending on the optionpassed by user.

Same as above

UARTModemStatusGet UARTModemStatus This API provides the currentstate of the control lines fromthe modem, data set orperipheral device.

Function name is updated to follow thenew coding guidelines. The functionreturns the status of UART Modemcontrol lines through mask valuesgrouped together as the following enumuartModemSts_t

NA

UARTModemStatusChangeCheck UARTModemStatus Same as above This functionality is provided throughUARTModemStatus API.


UARTDSRInterruptControl UARTDsrPinIntrEnable This API enables/disables theDSR(Data Set Ready) pinstatus Interrupt feature.

Function name is updated to follow thenew coding guidelines. The APIaccepts TRUE/FALSE macro throughenableDsrIntr parameter to control theinterrupt feature.

NA

UARTRXCTSDSRTransitionStatusGet UARTRxCtsDsrTransitionStatus This API returns the status offalling edge signal status onthe Receive, CTSn(Clear toSend) and DSRn(Data SetReady) lines.

Function name is updated to follow thenew coding guidelines. The API returnsa TRUE/FALSE depending onoccurence of an event on CTS, DSRlines.

NA

UARTOperatingModeSelect UARTEnableAutobaudMode This API enables/disables theAuto-Baud mode of theUART module.

Function name is updated to follow thenew coding guidelines.The API UARTEnableAutobaudModetakes enableAutoBaud as a parameterand enables/disables the AutoBaudmode.

NA

UARTAutobaudParityGet UARTGetAutoBaudParity This API returns the Paritymode detected by UART inAutobaud mode.


NA

UARTAutobaudWordLenGet UARTGetAutoBaudWordLen This API returns the wordlength per frame(characterlength) detected by UART inAutobaud mode.


NA

UARTAutobaudSpeedGet UARTGetAutoBaudSpeed This API returns the baudrate detected by UART inAuto baud mode.


NA

UARTScratchPadRegWrite UARTSetScratchPadValue This API programs theScratch pad Register with thespecified value.


NA

UARTScratchPadRegRead UARTGetScratchPadValue This API reads the value inScratch pad Register.


NA


Deprecated API Reason for deprecating the API

UARTSubConfigTCRTLRModeEn The functionality is handled within the other APIs

UARTSubConfigXOFFModeEn The functionality is handled within the other APIs

UARTSubConfigMSRSPRModeEn The functionality is handled within the other APIs

UARTTCRTLRBitValRestore The functionality is handled within the other APIs

UARTEnhanFuncEnable The functionality is handled within the other APIs

UARTEnhanFuncBitValRestore The functionality is handled within the other APIs




UART_FIFO_CONFIG, UART_FCR_PROGRAM The macros are removed. the functionalityhandled within otherAPIs. The parametersare handled throughuartFifoCfg_tstructure.

--NA-- Baud rate values grouped into enum uartBaudRate_t andthe macro names are also updated to follow the codingguidelines.

New Enum

UART_FRAME_WORD_LENGTH_N,UART_FRAME_NUM_STB_N, UART_PARITY_XX

Enum: uartCharLength_t, uartStopBit_t, uartParity_t - Macros are groupedlogically.

UART_DMA_MODE_0_ENABLE,UART_DMA_MODE_1_ENABLE,

UART_DMA_MODE_2_ENABLE,UART_DMA_MODE_2_ENABLE

Enum: uartDmaMode_t - Different DMA modes Macros are groupedlogically.

UART_IDLEMODE_FORCE_IDLE,UART_IDLEMODE_NO_IDLE,UART_IDLEMODE_SMART_IDLE and others

Idle mode macros are grouped into an enumuartIdleMode_t


UART_INTID_MODEM_STAT,UART_INTID_TX_THRES_REACH,UART_INTID_RX_THRES_REACH,UART_INTID_RX_LINE_STAT_ERROR

Enum: uartIntrMask_t - Mask value representing interruptmasks.


UART_OVERRUN_ERROR, UART_PARITY_ERROR,UART_BREAK_DETECTED_ERROR and other linestatus

These are grouped into an enum uartLineSts_t and macronames are also updated to follow new coding guidelines.


UART_NO_SOFTWARE_FLOW_CONTROL,UART_TX_RX_XON1_XOFF1,UART_TX_RX_XON2_XOFF2

Enum: uartSwFlowCtrlCfg_t - different software flowcontrol configurations


UART_TRIG_LVL_GRANULARITY_1,UART_TRIG_LVL_GRANULARITY_4

Trigger level granularities uartTriggerLvlGran_t. Macros are goupedlogically.

UART_REG_CONFIG_MODE_A,UART_REG_CONFIG_MODE_B,UART_REG_OPERATIONAL_MODE

Enum: uartRegAccessMode_t - Different register accessmodes.


Modem control macros like UART_DCD_VALUE,UART_RI_VALUE, UART_CTS_VALUE,UART_DSR_VALUE

Enum: uartModemSts_t Macros are groupedlogically.

Wakeup event macros likeUART_WAKEUP_RI_ACTIVITY,UART_WAKEUP_RX_ACTIVITY

Enum: uartWakeupEvent_t'- ' Different wakeup events Macros are groupedlogically.

UART_AUTOBAUD_SPEED_XX,UART_AUTOBAUD_CHAR_LENGTH_X,

UART_AUTOBAUD_XX_PARITY macros

Enum: uartAutoBaudSpeed_t,uartAutoBaudWordLen_t, uartAutoBaudParity_tAutoBaud setting macros



RTCThe below table lists API differences between the versions





Notes

RTCRevisionIDGet RTCGetRevision This API returns therevision Id of the module

Function name is updated tofollow the new codingguidelines

NA

RTCWriteProtectEnable RTCWriteProtectEnable This API enables/disablesthe write-protection forRTC registers

Single API to enable &disable WriteProtect, alsotakes an additional parameterto select enable/disable

NA

RTCWriteProtectDisable RTCWriteProtectEnable This API enables/disablesthe write-protection forRTC registers

Single API to enable &disable WriteProtect, alsotakes an additional parameterto select enable/disable

NA

RTC32KClkSourceSelect RTCClkSrcSelect This API selects the clocksource for the RTC module

Same as above. NA

RTCRun RTCEnable This API enables/disablesthe RTC module.

Only one API to enable anddisable RTC.The new APIalso takes a parameterenable/disable.

NA

RTCStop RTCEnable This API enables/disablesthe RTC module.


NA

RTCDisable RTCEnable This API enables/disablesthe RTC module.


NA

RTCEnable RTCEnable This API enables/disablesthe RTC module.


NA

RTCOscillatorStateControl RTCXtalOutPinEnable This API is used toconfigure the XTALOUTPin to connect it to anexternal crystal.

Same as above NA

RTCRun RTCRun This API sets the RTC torun with the programmeddate and time information.

No change NA

RTCStop RTCStop This API stops the RTC. No change. NA

RTCIntTimerEnable RTCTimerIntrEnable This API enables theperiodic timer interrupts.

Function name is updated tofollow the new codingguidelines.

NA

RTCIntTimerDisable RTCTimerIntrDisable This API disables theperiodic timer interrupts.


NA

RTCEventUpdateGet RTCTimerIntrStatus This API returns the statusof TIMER interrupt events.

Function name updated tofollow the new codingguidelines.

NA


RTCIntAlarm2Enable RTCAlarmIntrEnable This API enables ALARMinterrupts.


NA

RTCIntAlarmEnable RTCAlarmIntrEnable This API enables ALARMinterrupts.


NA

RTCIntAlarmDisable RTCAlarmIntrDisable This API disables ALARMinterrupts.


NA

RTCAlarm2IntStatusGet RTCAlarmIntrStatus This API returns the statusof ALARM interrupt events.


NA

RTCAlarmIntStatusGet RTCAlarmIntrStatus This API returns the statusof ALARM interrupt events.


NA

RTCAlarmIntStatusClear RTCAlarmIntrClear This API clears theALARM interrupt status.


NA.

RTCAlarm2IntStatusClear RTCAlarmIntrClear This API clears theALARM interrupt status.


NA.

RTCBusyStatusGet RTCIsBusy This API returns the statusof RTC module.


NA

RTCMinRoundingEnable RTCRoundingEnable This API Enables/Disablesthe feature of minuterounding.


NA

RTCMinRoundingDisable RTCRoundingEnable This API Enables/Disablesthe feature of minuterounding.

Single API to enable anddisable minute roundingfeature. New API takes anadditional parameter to selectenable/disable.

NA

RTCTimeSet RTCSetTime This API programs thespecified time informationthe Time registers.

Function name is updated tofollow the new codingguidelines, Single API to setall 'Time' relatedinformation.

NA

RTCHourModeSet RTCSetTime This API programs thespecified time modeinformation in the Timeregisters.


NA

RTCSecondSet RTCSetTime This API programs thespecified time informationthe Time registers.


NA

RTCMinuteSet RTCSetTime This API programs thespecified time informationthe Time registers.


NA


RTCHourSet RTCSetTime This API programs thespecified time informationthe Time registers.


NA

RTCMeridiemSet RTCSetTime This API programs thespecified time meridiemmode information the Timeregisters.


NA

RTCTimeGet RTCGetTime This API reads the currenttime from the registersholding time information.

Function name is updated tofollow the new codingguidelines, Single API to getall 'Time' relatedinformation.

NA

RTCHourModeGet RTCGetTime This API reads the currenttime from the registersholding time information.


NA

RTCSecondGet RTCGetTime This API reads the currenttime from the registersholding time information.


NA

RTCMinuteGet RTCGetTime This API reads the currenttime from the registersholding time information.


NA

RTCHourGet RTCGetTime This API reads the currenttime from the registersholding time information.


NA

RTCMeridiemGet RTCGetTime This API reads the currenttime mode from theregisters holding timeinformation.


NA

RTCDayOfMonthSet RTCSetDate This API sets the specifieddate information in registersholding date information..

Function name is updated tofollow the new codingguidelines, Single API to setall 'Date' related information

NA

RTCMonthSet RTCSetDate This API sets the specifieddate information in registersholding date information..


NA

RTCYearSet RTCSetDate This API sets the specifieddate information in registersholding date information..


NA


RTCDayOfTheWeekSet RTCSetDate This API sets the specifieddate information in registersholding date information..


NA

RTCCalendarSet RTCSetDate This API sets the specifieddate information in registersholding date information..


NA

RTCDayOfMonthGet RTCGetDate This API reads the calendarinformation from relevantregisters holding dateinformation.

Function name is updated tofollow the new codingguidelines, Single API to getall 'Date' related information

NA

RTCMonthGet RTCGetDate This API reads the calendarinformation from relevantregisters holding dateinformation.


NA

RTCYearGet RTCGetDate This API reads the calendarinformation from relevantregisters holding dateinformation.


NA

RTCDayOfTheWeekGet RTCGetDate This API reads the calendarinformation from relevantregisters holding dateinformation.


NA

RTCCalendarGet RTCGetDate This API reads the calendarinformation from relevantregisters holding dateinformation.


NA

RTCAlarm2TimeSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.

Function name is updated tofollow the new codingguidelines, Single API to setall alarm time & date relatedinformation.

NA

RTCAlarm2CalendarSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.


NA

RTCAlarmSecondSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.


NA

RTCAlarmMinuteSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.


NA

RTCAlarmHourSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.


NA


RTCAlarmHourMeridiemSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.


NA

RTCAlarmTimeSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.


NA

RTCAlarmDayOfMonthSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.


NA

RTCAlarmMonthSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.


NA

RTCAlarmYearSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.


NA

RTCAlarmCalendarSet RTCSetAlarm This API sets the specifiedalarm register with Alarminformation including Timeand Date.


NA

RTCAlarmSecondGet RTCGetAlarm This API reads theprogrammed Alarminformation including Timeand Date from the specifiedalarm register.

Function name is updated tofollow the new codingguidelines, single API to getall alarm time & date relatedinformation.

NA

RTCAlarmMinuteGet RTCGetAlarm This API reads theprogrammed Alarminformation including Timeand Date from the specifiedalarm register.


NA

RTCAlarmHourGet RTCGetAlarm This API reads theprogrammed Alarminformation including Timeand Date from the specifiedalarm register.


NA

RTCAlarmHourMeridiemGet RTCGetAlarm This API reads theprogrammed Alarminformation including Timeand Date from the specifiedalarm register.


NA


RTCAlarmTimeGet RTCGetAlarm This API reads theprogrammed Alarminformation including Timeand Date from the specifiedalarm register.


NA

RTCAlarmDayOfMonthGet RTCGetAlarm This API reads theprogrammed Alarminformation including Timeand Date from the specifiedalarm register.


NA

RTCAlarmMonthGet RTCGetAlarm This API reads theprogrammed Alarminformation including Timeand Date from the specifiedalarm register.


NA

RTCAlarmYearGet RTCGetAlarm This API reads theprogrammed Alarminformation including Timeand Date from the specifiedalarm register.


NA

RTCAlarmCalendarGet RTCGetAlarm This API reads theprogrammed Alarminformation including Timeand Date from the specifiedalarm register.


NA

RTCScratchPadSet RTCSetScratchPadVal This API writes thespecified arbitrary value tothe specified scratchregister.


NA

RTCScratchPadGet RTCGetScratchPadVal This API writes thespecified arbitrary value tothe specified scratchregister.


NA

RTCIdleModeConfigure RTCSetIdleMode This API configures the IdleMode for the RTC.


NA

RTCWakeUpAlarmEventControl RTCWakeupEnable This API is used to Enablethe Alarm and Timer eventWakeup signal to the CPU.


NA

RTCWakeUpTimerEventControl RTCWakeupEnable This API is used to Enablethe Alarm and Timer eventWakeup signal to the CPU.


NA

RTCWakeUpAlarmEventControl RTCWakeupDisable This API is used to Disablethe Alarm and Timer eventWakeup signal to the CPU.


NA

RTCWakeUpTimerEventControl RTCWakeupDisable This API is used to Disablethe Alarm and Timer eventWakeup signal to the CPU.


NA

RTCConfigPmicPowerEnable RTCPmicPowerEnable This API controls the PMICpower enable signal whichcan be used to control anexternal PMIC.


NA


RTCConfigPmicExtWake RTCPmicExtWakeupEnable This API Enables the PMICExternal Wakeup feature.

Function name is updated tofollow the new codingguidelines. 2 new APIs forenable & disable.

NA

RTCConfigPmicExtWake RTCPmicExtWakeupDisable This API Disables thePMIC External Wakeupfeature.

Function name is updated tofollow the new codingguidelines. 2 new APIs forenable & disable.

NA

RTCConfigPmicExtWakePolarity RTCPmicExtWakeupPol This API configures thePolarity of PMIC ExternalWakeup Pin


NA

RTCPmicExtWakeStatusClear RTCPmicExtWakeupClear This API clears the PMICExternal Wakeup Status


NA

RTCFeedbackResistanceSelect RTCFeedbackResistorSel This API selects the modeof the Oscillator Feedbackresistor to either internal orexternal of the SOC


NA

RTCConfigPmicExtWakeDebounce RTCPmicExtWakeupDebounceEnable This API Enables theExternal Wakeup Debouncefeature.

Function name is updated tofollow the new codingguidelines.Separate APIs forenable & disable.

NA

RTCConfigPmicExtWakeDebounce RTCPmicExtWakeupDebounceDisable This API Disables theExternal Wakeup Debouncefeature

Function name is updated tofollow the new codingguidelines.Separate APIs forenable & disable.

NA

-NA- RTCSetDebounceTime This API sets the debouncetime for the RTC module.

New API NA

RTCAutoCompEnableRTCTestModeControl

RTCTestModeEnable This API is used toEnable/Disable the Testmode of the RTC.

Function name is updated tofollow the new codingguidelines, renamed andsingle API to both enableand disable.

NA

RTCAutoCompDisableRTCTestModeControl

RTCTestModeEnable This API is used toEnable/Disable the Testmode of the RTC.

Function name is updated tofollow the new codingguidelines, renamed andsingle API to both enableand disable.

NA

RTCSet32CounterEnable RTCCompensationEnable This API Enable/DisableCrystal Compensationfeature to account for anyinaccuracy in 32Koscillator.

Function name is updated tofollow the new codingguidelines, single API toenable/disable RTCcompensation.

NA

RTCSet32CounterDisable RTCCompensationEnable This API Enable/DisableCrystal Compensationfeature to account for anyinaccuracy in 32Koscillator.

Function name is updated tofollow the new codingguidelines,single API toenable/disable RTCcompensation.

NA


RTCCompensationSet RTCSetCompensationVal This API sets thecompensation registers withthe specified driftcompensation value versusone hour period of theoscillator frequency


NA

RTCCompensationGet RTCGetCompensationVal This API reads thecompensation value beingset in the compensationregisters.


NA



RTCEnableStatus None ---

RTCRunStatusGet None ---

Note1: The following APIs have been removed as these are valid only on AM1808 SOC and are not supported onAM335x and AM43xx SOCs.RTCSplitPwrEnable RTCSplitPwrDisable RTCSoftwareResetThe below table lists data structure / macro differences between the versions


RTC_POST_MERIDIEM, RTC_ANTE_MERIDIEM,RTC_DOTW_SUN,RTC_DOTW_MON and other macros related toDate and time information

The macros are removed. These macros areredefined in date_time.hfile as per new codingguidelines.

RTC_INT_EVERY_SECOND, RTC_INT_EVERY_MINUTE,RTC_INT_EVERY_HOUR , RTC_INT_EVERY_DAY

Timer Interrupt mask values are grouped intoenum rtcTimerIntrMask_t and the macronames are also updated to follow the codingguidelines.


RTC_DAY_EVENT, RTC_HOUR_EVENT,RTC_MINUTE_EVENT, RTC_SECOND_EVENT

RTC event status macros are grouped intoenum rtcTimerIntrSts_t and the macro namesare also updated to follow the coding guidelines.


RTC_IDLEMODE_FORCE_IDLE, RTC_IDLEMODE_NO_IDLE,RTC_IDLEMODE_SMART_IDLE,RTC_IDLEMODE_SMART_IDLE_WAKEUP

RTC event status macros are grouped into enumrtcIdleMode_t and the macro names are alsoupdated to follow the coding guidelines.


RTC_EXT_WAKEUP_ENABLE, RTC_EXT_WAKEUP_DISABLE,RTC_EXT_WAKEUP_POL_ACTIVE_HIGH,RTC_EXT_WAKEUP_POL_ACTIVE_LOW

Wakeup feature related macros are grouped intofollowing enums rtcWakeupEvtSrc_t andrtcWakeupEvtPol_t enums.


DCANThe below table lists the DAL file name differences between the versions


StarterWare v02.00.01.01 StarterWare v02.01.00.XX: Reason for change

dcan.c dcan.c No change.

dcan.h dcan.h No change.

hw_dcan.h hw_dcan.h No change.



StarterWarev02.00.01.01Functionality

StarterWare 02.01.00.XX API StarterWare 02.01.00.XX : Change Notes

DCANInitModeSet Configure DCAN inInitialization mode.

DCANSetMode API name is changed to followStarterWare coding guideline."DCANSetMode" API shall be used toconfigure DCAN in Init/Normal mode.

NA

DCANNormalModeSet Configure DCAN inNormal mode.

DCANSetMode API name is changed to followStarterWare coding guideline."DCANSetMode" API shall be used toconfigure DCAN in Init/Normal mode.

NA

DCANBitTimingConfig Configure the DCANbit-time values.

DCANBitTimeConfig API name is changed to followStarterWare coding guideline.

NA

DCANReset Reset the DCANmodule

DCANReset No change. NA

DCANIntEnable Enable the DCANinterrupts.

DCANIntrEnable The API is updated to followStarterWare coding guidelines. Nofunctionality change.

NA

DCANIntDisable Disable the DCANinterrupts.

DCANIntrDisable The API is updated to followStarterWare coding guidelines. Nofunctionality change.

NA

DCANAutoReTransmitControl The APIenables/disables theauto retransmissionof DCAN messages.

DCANAutoReTransmissionEnable The API is updated to followStarterWare coding guidelines. Macrosare discarded and TRUE/FALSE valuesare used to enable/disable.

NA

DCANTestModeControl This API is used toenable/disable the testmodes of DCAN.

DCANTestModeEnable This API is discarded and functionalityis merged with DCANTestModeEnableAPI.

NA

DCANAutoBusOnControl This API is used toenable/disable theAuto bus on featureof DCAN.

DCANAutoBusOnEnable The API is updated to followStarterWare coding guidelines. Macrosare discarded and TRUE/FALSE valuesare being used.

NA

DCANParityControl The API is used toenable/disable theDCAN parity

DCANParityEnable The API is updated to followStarterWare coding guidelines. Macrosare discarded and TRUE/FALSE valuesare used to enable/disable parity.

NA

DCANIntLineEnable The API is used toenable the interruptlines

DCANIntrLineEnable The API is updated to followStarterWare coding guidelines.Enable/Disable is done in the same APIusing TRUE/FALSE values. Additionalparameter will define the interrupt linenumber.

NA


DCANIntLineDisable The API is used todisable the interruptlines.

DCANIntrLineEnable The API is discarded sinceenable/disable part is done byDCANIntrLineEnable API.

NA

DCANDmaRequestLineEnable The API is used toconfigure DMArequest for IF registertransfer

DCANDmaRequestLineEnable The API is updated to followStarterWare coding guidelines.Enable/Disable is done within the sameAPI using TRUE/FALSE values.

NA

DCANDmaRequestLineDisable Disable the DMArequest for IF registertransfer.

DCANDmaRequestLineEnable This API is discarded sinceDCANDmaRequestLineEnable will dothe work.

NA

DCANIntRegStatusGet Read the DCANinterrupt line status.

DCANIntrStatus The API is updated to followStarterWare coding guidelines. Macrosused are updated.

NA

DCANErrAndStatusRegInfoGet The API is used toread the DCAN errorand status info.

DCANErrorAndStatusInfoGet The API is updated to followStarterWare coding guidelines.

NA

DCANErrCntrRegStatusGet The API is used toread the DCAN errorcounter value.

DCANErrorCounterStatus The API is updated to followStarterWare coding guidelines.

NA

DCANTestModesEnable The API is used toenable the DCAN testmodes

DCANTestModeEnable The API is updated to followStarterWare coding guidelines.Enable/disable is done in the same APIand parameter is added which shalldeduce the test mode to be selected.

NA

DCANTestModesDisable The API will disablethe DCAN test modes

DCANTestModeEnable This API is discarded sinceDCANTestModeEnable will disable thetest modes by taking parameter asFALSE.

NA

DCANTxPinControl The API will controlthe functioning ofDCAN TX pin.

NA This API is discarded since feature isnot supported..

NA

DCANRxPinStatusGet This API will readthe status of DCANRX pin.

NA This API is discarded since feature isnot supported.

NA

DCANParityErrCdRegStatusGet This API will returnthe parity error codestatus

DCANParityErrorStatus API name updated to followStarterWare coding guidelines

NA

DCANAutoBusOnTimeValSet This API willconfigure the DCANAuto bus on timevalue

DCANSetAutoBusOnTimeVal API name updated to followStarterWare coding guidelines

NA

DCANAutoBusOnTimeValGet This API will returnthe DCAN auto buson time value

DCANGetAutoBusOnTimeVal API name is updated to followStarterWare coding guidelines.

NA

DCANTxRqstXStatusGet This API will returnthe DCAN TXRQ_Xregister status

DCANTxRequestXStatus API name is updated to followStarterWare coding guidelines.

NA

DCANTxRqstStatusGet This API will returnthe DCAN TXRQ(n)register status. Wheren = 12, 34, 56, 78.

DCANTxRequestStatus API name is updated to followStarterWare coding guidelines.

NA


DCANTxRqstStatGet This API will returnthe least messageobject number whosetransmit requeststatus is not set.

DCANTxRqstLeastMsgObjStatus API name is updated to followStarterWare coding guidelines. Nofunctionality change is done.

NA

DCANNewDataXStatusGet This API will returnthe DCANNEWDAT_X registerstatus.

DCANNewDataXStatus API name is updated to followStarterWare coding guidelines.

NA

DCANNewDataStatusGet This API will returnthe DCANNEWDAT(n) registerstatus. Where n = 12,34, 56, 78.

DCANNewDataStatus API name is updated to followStarterWare coding guidelines.

NA

DCANNewDataStatGet This API will returnthe least messageobject number whosenew data status is notset.

DCANNewDataLeastMsgObjStatus API name is updated to followStarterWare coding guidelines. Nofunctionality change is done.

NA

DCANIntPendingXStatusGet This API will returnthe DCANINTPND_X registerstatus.

DCANIntrPendingXStatus API name is updated to followStarterWare coding guidelines.

NA

DCANIntPendingStatusGet This API will returnthe DCANINTPND(n) registerstatus. Where n = 12,34, 56, 78.

DCANIntrPendingStatus API name is updated to followStarterWare coding guidelines.

NA

DCANMsgValidXStatusGet This API will returnthe DCANMSGVAL_X registerstatus.

DCANMsgValidXStatus API name is updated to followStarterWare coding guidelines.

NA

DCANMsgValidStatusGet This API will returnthe DCANMSGVAL(n) registerstatus. Where n = 12,34, 56, 78.

DCANMsgValidStatus API name is updated to followStarterWare coding guidelines.

NA

DCANMsgObjValidate This API willvalidate the DCANmessage object.

DCANValidateMsgObj API name is updated to followStarterWare coding guidelines.

NA

DCANCommandRegSet This API willconfigure the IFcommand register

DCANSetCommand API name is updated to followStarterWare coding guidelines.

NA

DCANIFBusyStatusGet This API will checkthe busy status of IFregisters

NA API is discarded since the required bitwill be checked inside the necessaryAPIs

NA

DCANMsgIdSet Set the CAN messageID.

DCANSetMsgId API name is updated to followStarterWare coding guidelines.

NA

DCANMsgDirectionSet Set the DCANmessage direction

DCANSetMsgDirection API name is updated to followStarterWare coding guidelines.

NA

DCANDataWrite Program the DCANdata to be transferred.

DCANWriteData API name is updated to followStarterWare coding guidelines.

NA


DCANDataRead API to read thereceived DCAN data.

DCANReadData API name is updated to followStarterWare coding guidelines.

NA

DCANDataLengthCodeSet Configure the DCANdata length code

DCANSetDataLengthCode API name is updated to followStarterWare coding guidelines.

NA

DCANMsgObjIntEnable Enable the DCANmessage objectinterrupts

DCANMsgObjIntrEnable API name is updated to followStarterWare coding guidelines.

NA

DCANMsgObjIntDisable Disable the DCANmessage objectinterrupts

DCANMsgObjIntrDisable API name is updated to followStarterWare coding guidelines.

NA

DCANMsgObjectMskConfig This API willconfigure themessage object masksettings

DCANMsgObjectMaskConfig API name is updated to followStarterWare coding guidelines.

NA

DCANIF3RegUpdateEnableSet This API willconfigure the IF3register set so that itautomatically updatesthe received value inthe message RAM.

DCANSetIf3RegUpdateEnable API name is updated to followStarterWare coding guidelines.

NA

DCANIF3ObservationFlagSet Set the observationfields of DCANobservation register.

DCANSetIf3ObservationSet API name is updated to followStarterWare coding guidelines

NA

DCANIF3ObservationFlagClear Clear the observationfields of DCANobservation register.

DCANClearIf3Observation API name is updated to followStarterWare coding guidelines

NA

DCANIF3ObservationFlagStatGet Read the observationstatus of DCANobservation register.

DCANIf3ObservationStatus API name is updated to followStarterWare coding guidelines

NA

DCANIFMaskStatusGet Read the DCAN IFmask status

DCANIfMaskStatus API name is updated to followStarterWare coding guidelines

NA

DCANIFArbStatusGet Read the DCAN IFarbitration status

DCANIfArbitrationStatus API name is updated to followStarterWare coding guidelines

NA

DCANClrIntPnd Clear the DCANinterrupt pending bit

DCANClearPendingIntr API name is updated to followStarterWare coding guidelines

NA

DCANUseAcceptanceMaskControl Enable/disable theacceptance mask forDCAN

DCANAcceptanceMaskEnable API name is updated to followStarterWare coding guidelines.

NA

DCANTransmitRequestControl Enable/disable thetransmit request forDCAN

DCANTransmitRequestEnable API name is updated to followStarterWare coding guidelines.

NA

DCANNewDataControl Set/Clear the DCANnew data bit

DCANNewDataConfig API name is updated to followStarterWare coding guidelines.

NA

The macros and newly defined enum differences are highlighted below.



Interrupt mask values like DCAN_STATUS_CHANGE_INT & DCAN_ERROR_INT The macro names are updated and are groupedtogether in a enum dcanIntrMask_t

Macros pertaining to enable/disable auto retransmission mode likeDCAN_AUTO_RETXN_XX

Macros are discarded and TRUE/FALSE is used.

Macros related to configuration change enable like DCAN_CONF_REG_WR_ACCESS_XX These macros are discarded since API using thesemacros is discarded.

Macros used to enable/disable the test modes of DCAN like DCAN_TEST_MODE_XX. Macros discarded since TRUE/FALSE values arebeing used now.

Macros used to enable/disable the Auto bus on feature like DCAN_AUTO_BUS_ON_XX Macros discarded since TRUE/FALSE values arebeing used now.

Macros used to enable/disable DCAN parity like DCAN_PARITY_FUNC_XX Macros discarded since TRUE/FALSE values arebeing used now.

Macros used to specify the DCAN interrupt lines like DCAN_INT_LINEX These macros are updated and are grouped togetherin a enum dcanIntrLineNum_t

Macros used to specify the DMA request line for IF regs likeDCAN_DMA_REQUEST_LINE_IFX

These macros are updated and are grouped togetherin a enum dcanIfRegNum_t

Macros used to specify the DCAN interrupt line status DCAN_INT_LINEX_STAT Macros are discarded since not required

Macros used to specify the DCAN error and status information DCAN_LST_ERRCODE_Xand other macros.

Macros are updated and grouped along withdcanStsErrCodeMask_t enum.

Macros used to specify DCAN error counter status like DCAN_X_ERR_CNTR andDCAN_RX_ERR_PASSIVE

Macros are updated and are grouped in enumdcanCntrMask_t.

Macros used to specify the DCAN test modes like DCAN_TST_X Macros are updated and grouped under the enumdcanTestModeMask_t.

Macros used to deduce the parity error code status like DCAN_PARITY_ERR_X_NUM Macros are updated and grouped under the enumdcanParityErrSts_t.

Macros used to deduce the maximum message objects for that SOC likeDCAN_MSG_OBJS_(n)

Macro is discarded and direct values shall be passedto the API.

Macros used to configure the DCAN command register like DCAN_DMA_ACTIVE,DCAN_DAT_A_ACCESS etc.

Macros are updated and grouped under the enumdcanCmd_t.

Macros used to configure the DCAN message transfer like DCAN_X_DIR. Macros are updated and are grouped under the enumdcanMsgDir_t.

Macro DCAN_IDENTIFIER_MSK Updated to DCAN_IDENTIFIER_MASK

Macros DCAN_ID_MSK_11_BIT and DCAN_ID_MSK_29_BIT Updated to DCAN_ID_MASK_11_BIT andDCAN_ID_MASK_11_BIT

Macros DCAN_MSK_MSGDIR_ENABLE and DCAN_MSK_MSGDIR_DISABLE Updated and grouped in the enumdcanMsgDirMask_t

Macros DCAN_MSK_EXT_ID_ENABLE and DCAN_MSK_EXT_ID_DISABLE Updated and grouped in the enum dcanExtIdMask_t

Macros used to set/clear the observation fields like DCAN_MASK_DATA,DCAN_ARB_DATA etc

Updated and grouped in the enum dcanObsField_t

Macros used to read the status of observation register like DCAN_IF3_MASK_STATUS,DCAN_IF3_ARB_STATUS etc

Updated and grouped in the enum dcanObsSts_t

Macros used to read the IF mask status register like DCAN_ID_MSK_READ,DCAN_MSK_MSG_DIR_READ, DCAN_MSK_EXT_ID_READ

Macros are updated and grouped in the enumdcanMaskSts_t

Macros used to read the IF Arbitration register status like DCAN_MSG_ID_READ,DCAN_MSG_DIR_READ, DCAN_EXT_ID_READ, DCAN_MSGVAL_READ

Macros are updated and grouped in the enumdcanArbSts_t


Macros used to read the IF message control status like DCAN_DAT_LEN_CODE_READ,DCAN_END_OF_BLOCK_READ etc.

Macros are updated and grouped in the enumdcanMsgCtlSts_t

Macros used to configure the Acceptance mask like DCAN_MASK_USED andDCAN_MASK_IGNORED.

Macros are discarded since not required andTRUE/FALSE values are being used.

Macros used to configure the transmit request feature likeDCAN_TRANSMIT_REQUESTED and DCAN_TRANSMIT_NOT_REQUESTED

Macros are discarded since not required andTRUE/FALSE values are being used.

Macros used to configure the DCAN new data control like DCAN_NEW_DAT_SET andDCAN_NEW_DAT_CLR

Macros are updated using the enumdcanNewDataCfg_t.

GPMCThe below table lists the DAL file name differences between the versions

StarterWare v02.01.00.XX StarterWare v02.00.01.01 Reason for change

gpmc.c gpmc.c No Change

gpmc.h gpmc.h No Change

hw_gpmc.h hw_gpmc.h No Change


StarterWare v02.00.01.01: API Name StarterWare v02.01.00.XX: API

Name

StarterWare v02.01.00.XX: Functionality StarterWare v02.01.00.XX:

Changes Notes

GPMCRevisionGet GPMCGetRevision This API returns the Revision Number of theGPMC module.


NA

GPMCModuleSoftReset GPMCModuleReset This API performs a module reset of the GPMCmodule.


NA

GPMCModuleResetStatusGet GPMCIsModuleResetDone This API checks if the Module Reset is completeand returns TRUE/FALSE to indicate the same.

Function name is updated tofollow new coding guidelines.

NA

GPMCAddrDataMuxProtocolSelect GPMCSetAddrDataMuxType This API sets the Address/Data pin multiplex(protocol) type.

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgroupedunder in the following enumgpmcChipSel_t and muxTypeinput in the following enumgpmcMuxType_t

NA

GPMCSetDevType GPMCSetDevType This API sets the Device type for a particularchip select of the the GPMC module

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_t anddevType input in the followingenum gpmcDevType_t

NA


GPMCDevSizeSelect GPMCSetDevSize This API sets the Device size for a particular chipselect of the the GPMC module.

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_t anddevSize input in the followingenum gpmcDevSize_t

NA

GPMCDevPageLenSet GPMCSetDevPageLength This API sets the device Page Length. Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_t

and pageLen input inthe following enumgpmcDevPageLen_t

NA

GPMCAccessTypeSelect GPMCSetAccessMode This API sets the GPMC access modeto Single/Multiple Access for the Read/Writeoperations of the GPMC.

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_t

and accessMode input in thefollowing enumgpmcAccessMode_t

NA

GPMCWriteTypeSelect and GPMCReadTypeSelect GPMCSetAccessType This API sets the access type to either theSynchronous orAsynchronous for the Read/Write operations ofthe GPMC.

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_t andaccessType input in thefollowing enumgpmcAccessType_t

NA

GPMCSyncWrapBurstConfig GPMCSyncWrapBurstEnable This API enables/disables the Synchronous Wrapburst capability.

Function name is updated tofollow the new codingguidelines. The API takescsNum as input for identifyingthe chip select number fromenum gpmcChipSel_t. Itaccepts TRUE/FALSE todecide enabling/disabling ofthe SyncWrapBurst feature.

NA

GPMCBaseAddrSet GPMCSetChipSelBaseAddr This API sets the base Address for the selectedchip select number.

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_t.

NA

GPMCMaskAddrSet GPMCSetChipSelMaskAddr This API sets the Mask Address for the selectedchip select number.

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_t.

NA


GPMCCSConfig GPMCChipSelEnable This API controls enabling/disabling of aparticular chip select number.

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_tandTRUE/FALSE toenable/disable the particularchip select.

GPMCFclkDividerSelect GPMCSetFclkDivider This API sets the clock divider for GPMCfunctional clock which is used as the base for alltiming values for read/writeaccesses.

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_t'. The

divider value for the

functional clock takes any of

the input values from the

following enum

'gpmcFclkDivider_t

NA

GPMCTimeParaGranularitySelect GPMCSetTimeParaGranularity This API sets the Time Granularity scaling factorwhich sets the latency for all the timing signalvalues.

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_t.The scale factor which decidesthe latency for the functionalclock takes any of the inputvalues from the followingenumgpmcTimeGranularity_t

NA

GPMCClkActivationTimeConfig GPMCSetClkActivationTime This API sets the Output Clock Activation timefor the selected chip select Number.

Function name is updated tofollow the new codingguidelines. The macro value toidentify chip select number isgrouped under in the followingenum gpmcChipSel_t. The clkactivation values are takenfrom the following enumgpmcTimeGranularity_t

NA

GPMCCSTimingConfig GPMCChipSelectTimingConfig This API configures the Timing Parameters forthe Chip Select signal.

Function name is updated tofollow the new codingguidelines. The API takescsNum as input for identifyingthe chip select number fromenum gpmcChipSel_t. Thetiming parameters to be writtenfor Chip Select are part of thestructuregpmcChipSelTimingParams_t.This structure needs to bepopulated with required timingvalues to be set instead of theparameterized macro from theprevious implementation of theAPI.

NA


GPMCADVTimingConfig GPMCAdvSignalTimingConfig This API configures the Timing Parameters forthe Address Latch Enable(ALE)/ AddressValid(ADV) signal parameters.

. Function name is updated tofollow the new codingguidelines.

NA

GPMCWEAndOETimingConfig GPMCWeOeSignalTimingConfig This API configures the Timing Parameters forthe Write Enable(WE)Output Enable(OE) signaltiming parameters.


NA

GPMCRdAccessAndCycleTimeTimingConfig GPMCReadAccessTimingConfig This API configures the ReadAccessTime for thechip select.


NA

GPMCWrAccessAndWrDataOnADMUXBusTimingConfig GPMCWriteAccessTimingConfig This API configures the WriteAccessTime for the

chip select Function name is updated tofollow coding guidelines.

NA

GPMCycle2CycleAndTurnArndTimeTimingConfig GPMCCycleDelayTimingConfig This API configures the Cycle2Cycle delay andBus turn around time for two successive accessesto the selected chip select.

Function name is updated tofollow coding guidelines.

NA

GPMCSNANDCmdWrite GPMCNandCmdWrite This API writes the NAND device command tothe command register


NA

GPMCNANDAddrWrite GPMCNandAddrWrite This API writes the NAND address to theAddress register.


NA

GPMCNANDDataWrite GPMCNandDataWrite This API writes the NAND data to the dataregister.


NA

GPMCNANDDataRead GPMCNandDataRead This API reads the NAND data from the dataregister


NA

GPMCLimitedAddrDevSupportConfig GPMCLimitedAddrSupportEnable This API controls enabling/disabling of thelimited device address support feature.


NA

GPMCNANDForcePostedWriteFeatureConfig GPMCNandForcePostedWriteEnable

This API controls enabling/disabling of theNAND force posted write feature.


NA

GPMCWaitPinPolaritySelect GPMCWaitPinSelect This API selects the Wait pin for the chip select. Function name is updated tofollow coding guidelines.

NA

GPMCWaitPinStatusGet GPMCWaitPinStatusGet TODO Function name is updated tofollow coding guidelines.

NA

GPMCWaitPinMonitoringConfig GPMCWaitPinMonitoringEnable This API controls enabling/disabling of the Waitpin monitoring feature for Read and Write accessof the GPMC.


NA

GPMCWaitMonitoringTimeSelect GPMCSetWaitPinMonitoringTime This API sets the waitpin monitoring time for theselected chip select Number.


NA

GPMCWriteProtectPinLevelCtrl GPMCSetWriteProtectPinLvl This API sets the Write Protect Pin level to eitherhigh or low.


NA

GPMCEmptyWriteBuffStatusGet GPMCIsWriteBufEmpty This API returns the empty status of the writebuffer.


NA

GPMCIntEnable GPMCIntrEnable This API enables the specified interrupts forGPMC module.

No change NA

GPMCIntDisable GPMCIntrDisable This API disables the specified interrupts forGPMC module

No change NA

GPMCIntStatusGet GPMCIntrStatus This API returns the status of GPMC interrupts. Function name is updated tofollow the new codingguidelines.

NA


GPMCIntStatusClear GPMCIntrClear This API clears the status of GPMC interrupts. Function name is updated tofollow the new codingguidelines.

NA

GPMCTimeOutFeatureConfig GPMCTimeoutEnable This API controls the enabling/disabling of thetimeout feature


NA

GPMCTimeOutStartValSet GPMCSetTimeoutVal This API sets the timeout value for the timeoutcounter of GPMC.


NA

GPMCErrAddrGet GPMCGetErrAddr This API returns the address of illegal accesswhere an error occurred.


NA

GPMCErrSysCmdGet GPMCGetErrSysCmd This API returns the system command of thetransaction that caused


NA

GPMCErrValStatusGet GPMCIsErrValid This API checks whether the error fields set arevalid or not and returns the status.


NA

GPMCErrStatusGet GPMCErrStatus This API returns the Error status. Function name is updated tofollow the new codingguidelines.

NA

GPMCPrefetchAccessModeSelect GPMCSetPrefetchAccessMode This API sets the access modes to eitherPREFETCH read or POSTWRITE mode.


NA

GPMCPrefetchCSSelect GPMCSetPrefetchChipSel This API selects the Chip Select(CS) for whichthe PREFETCH/POSTWRITE engine must beactive.


NA

GPMCPrefetchSyncTypeSelect GPMCSetPrefetchSyncType This API enables the synchronization type of thePrefetch engine to either DMA request or anInterrupt request after the data in the FIFO crossesthe threshold..


NA

GPMCPrefetchSyncModeConfig GPMCSetPrefetchSyncMode This API controls the start of access to aparticular chip select


NA

GPMCPrefetchFifoThrldValSet GPMCSetPrefetchFifoThreshold This API sets the FIFO threshold for thePREFETCH/POSTWRITE engine.


NA

GPMCPrefetchTrnsCntValSet GPMCSetPrefetchXferCountVal This API sets the number of bytes to be read orwritten by the PREFETCH/POSTWRITE engineto the desired chip select.


NA

GPMCPrefetchRRArbitrationConfig GPMCArbitrationEnable This API controls the enabling/disabling theRound Robin Arbitration for Prefetch/PostwriteEngine.


NA

GPMCPrefetchWeightedPrioSet GPMCSetPrefetchEngNumAccess This API sets the number of accesses to begranted to the Prefetch/Postwrite Engine when theRound Robin Arbitration is enabled.


NA

GPMCPrefetchAccessCycleOptConfig GPMCPrefetchOptAccessEnable This API controls enabling/disabling of accesscycle optimization.


NA


GPMCPrefetchCycleOptValSet GPMCSetPrefetchCycleTimeOptVal

This function sets the number of GPMC_FCLKcycles to be subtracted fromRdCycleTime,WrCycleTime, AccessTime,CSRdOffTime,CSWrOffTime,ADVRdOffTime,ADVWrOffTime,OEOffTime, WEOffTime for PREFETCH enginecycle optimization.


NA

GPMCPrefetchEngineEnable andGPMCPrefetchEngineDisable

GPMCPrefetchEngineEnable This API controls the enabling/disabling of thePREFETCH/POSTWRITE


NA

GPMCPrefetchEngineStart GPMCPrefetchEngineStart This API starts the PREFETCH Engine andResets the Pointer to 0

No change. NA

GPMCPrefetchEngineStop GPMCPrefetchEngineStop This API stops the PREFETCH Engine. Function name is updated tofollow the new codingguidelines.

NA

GPMCPrefetchEngineStatusGet GPMCIsPrefetchEngineRunning This API returns the status ofPREFETCH/POSTWRITE engine.


NA

GPMCPrefetchFifoThrldStatusGet GPMCPrefetchFifoThresholdStatus This API returns the PREFETCH engine FIFOstatus.


NA

NA GPMCGetPrefetchFifoPtr This API returns the PREFETCH engine FIFOpointer pointing to the number of bytes availableto be read or free empty space to be written.

New API NA

GPMCPrefetchCountValGet GPMCGetPrefetchFifoRemBytes This API returns the remaining bytes to be reador to be written by the PREFETCH engineaccording to the TransferCount value.


NA

GPMCECCCSSelect GPMCSetEccChipSelect This API sets the Chip Select number for whichthe ECC computation is required.


NA

GPMCECCColumnSelect GPMCSetEccColumnSize This API selects the column size for ECCcomputation.


NA

GPMCECCBCHNumOfSectorsSelect GPMCSetEccNumSectors This API sets the number of sectors to processwith the BCH algorithm.


NA

NA GPMCSetBchEccCapability This API sets the BCH Error CorrectionCapability to be used.

New API NA

NA GPMCSetBchWrapModeVal This function sets the wrap mode for the ECCBCH algorithm.

New API NA

GPMCECCAlgoSelect GPMCSetEccAlgorithm This API sets the Algorithm to be used for ECCcalculation


NA

GPMCECCEnable and GPMCECCDisable GPMCEccEnable This API controls enabling/disabling of the ECCcalculation feature of the GPMC.


NA

GPMCECCResultRegClear GPMCEccResultRegClear This API clears all the ECC result registers. Function name is updated tofollow the new codingguidelines.

NA


GPMCECCResultRegSelect GPMCEccResultRegSelect This API selects the result register where theECC computation is to be stored.


NA

GPMCECCSizeValSet GPMCSetEccSize This API reads the value in Scratch pad Register. Function name is updated tofollow the new codingguidelines.

NA

GPMCECCResultSizeSelect GPMCSetEccResultSize This API sets the ECC size number for the ECCresult register.


NA

GPMCECCResultGet GPMCGetEccResult This API returns the ECC result stored in theparticular result register.


NA

GPMCECCBCHResultGet GPMCGetBchResult This API returns the BCH computation result. Function name is updated tofollow the new codingguidelines.

NA

GPMCECCBCHSWDataWrite GPMCSetEccBchSwData This API is used to directly pass the data to BCHECC Calculator without accessing the actualNAND flash interface.


NA

GPMCECCBCHSWDataRead GPMCGetEccBchSwData This API returns the data passed directly to theBCH calculator bypassing the NAND flashinterface.


NA

GPMCIdleModeSelect GPMCSetIdleMode This API sets GPMC to one of the Idle modes. Function name is updated tofollow the new codingguidelines.

NA

GPMCAutoIdleConfig GPMCAutoIdleEnable This API controls enabling/disabling of the theAuto Idle mode


NA


StarterWare v02.00.01.01: StarterWare v02.01.00.XX: Reason forchange

GPMC_IDLEMODE_FORCEIDLE, GPMC_IDLEMODE_NOIDLE,GPMC_IDLEMODE_SMARTIDLE

The Idle mode values aregrouped into enumgpmcIdleMode_t.


GPMC_FIFOEVENT_INT, GPMC_TERMINALCOUNT_INT,GPMC_WAIT0EDGEDETECTION_INT, GPMC_WAIT1EDGEDETECTION_INT

Enum: gpmcIntrMask_t - Macros aregroupedlogically.

GPMC_CHIP_SELECT_0, GPMC_CHIP_SELECT_1, GPMC_CHIP_SELECT_2,GPMC_CHIP_SELECT_3, GPMC_CHIP_SELECT_4, GPMC_CHIP_SELECT_5,GPMC_CHIP_SELECT_6, GPMC_CHIP_SELECT_7

Enum: gpmcChipSel_t - Macros aregroupedlogically.

GPMC_WP_PIN_POLARITY_LOW, GPMC_WP_PIN_POLARITY_HIGH macros Enum: gpmcWaitPinPol_t Macros aregroupedlogically.


ELMThe below table lists the DAL file name differences between the versions

StarterWare v02.01.00.XX StarterWare v02.00.01.01 Reason for change

elm.c elm.c No Change

elm.h elm.h No Change

hw_elm.h hw_elm.h No Change





StarterWarev02.01.00.XX: Changes

Notes

ELMRevisionGet ELMGetRevision This API returns the Revision Numberof the ELM.


NA

ELMModuleReset ELMModuleReset This API performs a module reset ofthe ELM.

No change NA

ELMModuleResetStatusGet ELMModuleIsResetDone This function returns the softwareresets status of ELM.


NA

ELMErrCorrectionLevelSet ELMSetBchEccLevel This API sets the Error Correctionlevel to be used for the BCH algorithm


NA

ELMECCSizeSet ELMSetEccBufSize This API sets the maximum size of thebuffer for which the Error locationengine is used


NA

ELMModeSet ELMSetContinuousMode This API sets the Error location engineto continuous mode.

The continuous mode andPage Mode settingfunctionality is merged ina single API.

NA

ELMModeSet ELMSetPageMode This API sets the Error location engineto Page mode.

The continuous mode andPage Mode settingfunctionality is merged ina single API.

NA

ELMSyndromeFrgmtSet ELMSetSyndromeFragment This API sets the fragment of the inputsyndrome polynomial for error locationprocessing.


NA

ELMErrLocProcessingStart ELMErrLocProcessingStart This API controls theEnabling/Disabling of the computationprocess for Error location for thepolynomial set in the syndromefragment registers.

No change NA

ELMErrLocProcessingStatusGet ELMErrLocProcessStatus This API returns the status of errorlocation processing for a givensyndrome polynomial.


NA

ELMNumOfErrsGet ELMGetNumErrors This API returns the status of errorlocation processing for a givensyndrome polynomial.


NA

ELMErrLocBitAddrGet ELMGetErrAddress This API returns the bit address oferror location for the syndromepolynomial.


NA


ELMIntConfig ELMIntrEnable This API enables the specifiedinterrupts for ELM.


NA

ELMIntConfig ELMIntrDisable This API disables the specifiedinterrupts for ELM.


NA

ELMIntStatusGet ELMIntrStatus This API returns the status of ELMinterrupts.


NA

ELMIntStatusClear ELMIntrClear This API clears the status of ELMinterrupts.


NA

ELMCAutoGatingConfig ELMAutoGatingEnable This API controls Enabling/Disablingof the Auto-Gating feature.


NA

ELMCIdleModeSelect ELMSetIdleMode This API sets ELM to one of the SlaveIdle modes.


NA

ELMOCPClkActivityConfig ELMSetIdleModeOcpClkActivity This API sets the OCP Clock Activitywhen module is in Idle mode.


NA

EDMAThe below table lists the DAL file name differences between the versions


edma.c edma.c No change

edma.h edma.h No change

hw_edma.h hw_edma.h No change


StarterWare v02.00.01.01: API Name StarterWare v02.01.00.XX: APIName


StarterWarev02.01.00.XX :

Changes

Notes

EDMA3Init EDMAInit This API initializes allregions of EDMA module.

Function name isupdated to follow thenew codingguidelines.

NA

NA EDMARegionReset This API resets given regionof EDMA module.

New API NA

EDMA3PeripheralIdGet EDMAGetPeripheralId This API returns theperipheral id of the EDMAmodule.


NA

NA EDMAIsMemProtectionSupported This API checks if theEDMA module supportsmemory protection.

New API NA


NA EDMAIsChMapSupported This API checks if theEDMA module supportschannel mapping.

New API NA

NA EDMAGetNumRegions This API gives number ofmemory protected or shadowregions the EDMA modulesupports.

New API NA

NA EDMAGetNumQueues This API gives number ofqueues or transfer controllersthe EDMA module supports.

New API NA

NA EDMAGetNumParamSets This API gives number ofParameter sets the EDMAmodule supports.

New API NA

NA EDMAGetNumIntrCh This API gives number ofinterrupt channels the EDMAmodule supports.

New API NA

NA EDMAGetNumQdmaCh This API gives number ofQDMA channels the EDMAmodule supports.

New API NA

NA EDMAGetNumDmaCh This API gives number ofDMA channels the EDMAmodule supports.

New API NA

EDMA3EnableChInShadowReg EDMAShdwRegionChEnable This API enablesDMA/QDMA channel in thethe given shadow region.


NA

EDMA3DisableChInShadowReg EDMAShdwRegionChDisable This API disableDMA/QDMA channel in thethe given shadow region.


NA

NA EDMAIsChInShdwRegion This API checks ifDMA/QDMA channel isassigned to given region.

New API NA.

EDMA3ChannelToParamMap EDMAChToParamSetMap This API maps QDMA/DMAchannel to the given PaRAMset.


NA

EDMA3MapChToEvtQ EDMAChToEvtQueueMap This API maps QDMA/DMAchannel to the given eventqueue.


NA

EDMA3SetQdmaTrigWord EDMASetQdmaTriggerWord This API sets the Triggerword for the specific QDMAchannel in the QCHMAPRegister. Default QDMAtrigger word is CCNT.


NA

EDMA3ClrMissEvt EDMAChMissEvtClear This API clears the missedevent status for channel ingiven region


NA


NA EDMAEvtMissStatus This API gives status of themissed event for givenQDMA/DMA channel.

New API NA

EDMA3ClrCCErr EDMAComplCodeErrClear This API clears thecompletion code error status.


NA

NA EDMAQueueThresholdErrClear This API clears the thresholderror status for given queue.

New API NA

EDMA3SetEvt EDMASetEvt This API manually sets eventto initiate transfer on DMAchannel in the the givenshadow region.


NA

EDMA3ClrEvt EDMAEvtClear This API clears event ofDMA channel in the givenglobal or shadow region.


NA

NA EDMAEvtStatus This API gives event statusof DMA channel in the givenglobal or shadow region.


NA

EDMA3EnableDmaEvtEDMA3EnableQdmaEvt

EDMAEvtEnable This API enables event ofchannel in the given global orshadow region.


NA

EDMA3DisableDmaEvtEDMA3DisableQdmaEvt

EDMAEvtDisable This API disables event ofchannel in the given global orshadow region.


NA

EDMA3GetCCErrStatus EDMAComplCodeErrStatus This API gives thecompletion code error status.


NA

NA EDMAQueueThresholdErrStatus This API gives the thresholderror status for given queue..


NA

EDMA3GetIntrStatusEDMA3IntrStatusHighGetEDMA3GetErrIntrStatusEDMA3ErrIntrHighStatusGetEDMA3QdmaGetErrIntrStatus

EDMAIntrStatus This API gives pendinginterrupt of a set of channelin the given global or shadowregion.


NA

EDMA3ClrIntr EDMAIntrClear This API clear pendinginterrupt of a channel in thegiven global or shadowregion.


NA

EDMA3GetPaRAMEDMA3QdmaGetPaRAM

EDMAGetParamEntry This API gives PaRAM Setof given index.


NA


EDMA3SetPaRAM EDMA3QdmaSetPaRAMEDMA3QdmaSetPaRAMEntryEDMA3QdmaGetPaRAMEntry

EDMASetParamEntry This API takes a PaRAM Setas input and copies it onto thegiven PaRAM Set index.


NA

NA EDMAParamReset This API resets the givenPaRAM Set index

New API NA

NA EDMAParamDataConfig This API takes a PaRAM Setas input and copies it onto thegiven PaRAM Set index.

New API NA

NA EDMAParamXferConfig This API takes a PaRAM Setas input and copies it onto thegiven PaRAM Set index.

New API NA

NA EDMAParamConfig This API takes a PaRAM Setas input and copies it onto thegiven PaRAM Set index.

New API NA

EDMA3RequestChannel EDMAChConfig This API configures givenchannel.


NA

EDMA3FreeChannel EDMAChReset This API resets givenchannel.


NA

EDMA3EnableTransfer EDMATransferStart Start EDMA transfer on thespecified channel.


NA

EDMA3DisableTransfer EDMATransferStop Disable DMA transfer on thespecified channel.


NA

LCDCThe below table lists the DAL file name differences between the versions



Reason for change

raster.c lcdc.c As per new coding guidelines of starterware the dal file names should be module names. Sinceraster is not the module name, this file is renamed to "lcdc.c".

raster.h lcdc.h Same as above.






StarterWare v02.01.00.XX :Changes

Notes

RasterClkConfig LCDCClkConfig This function configuresclk divider to generaterequired frequency ofpixel clock and selectsthe raster mode in lcdccontroller.

API is renamed to follow new codingguidelines. API name should start withmodule name which is LCDC notRaster.

NA

RasterIdGet LCDCGetRevision This function returns theReversion Id of LCDcontroller.

API is renamed to follow new codingguidelines.

NA

RasterAutoUnderFlowEnable LCDCAutoUnderFlowEnable This function enablesauto under flow feature.

API is renamed to follow new codingguidelines. The functionality of bothautounderflow enable and disable apisare combined into single API. Theunified API will accept additionalparameter "enableAutoUnderFlow",which accepts the followingparameters TRUE orFALSE.

NA

RasterAutoUnderFlowDisable Same as above This function disablesauto under flow feature.

Same as above NA

RasterEnable LCDCRasterEnable This function enablesraster control.

API is renamed to follow new codingguidelines. The functionality of bothraster enable and disable apis arecombined into single API. The unifiedAPI will accept additional parameter"enableRaster", which accepts thefollowing parameters TRUE orFALSE.

NA

RasterDisable Same as above This function disablesraster control.

Same as above. NA

RasterModeConfig LCDCRasterDisplayModeConfig This function willconfigures LCD toMonoChrome or colormode, TFT or STNmode and palette loadingmode.

API is renamed to follow new codingguidelines. All the parameters that aregrouped into a single structure"lcdcRasterDisplayAttrCfg_t" andthe pointer holding the address of thisstructure is passed to the API.

NA

RasterLSBDataOrderSelect LCDCRasterDataOrderSelect This function orders theframe buffer data fromleast to most significantbit bit/nibble/byte/word.

API is renamed to follow new codingguidelines. The functionality of thetwo data order select apis is combinedinto single API. The unified API willaccept additional parameter"dataOrder", which accepts themacros from the following enum"lcdcRasterDataOrder_t".

NA

RasterMSBDataOrderSelect Same as above This function orders theframe buffer data frommost to least significantbit bit/nibble/byte/word.

Same as above NA


RasterIntEnable LCDCIntrEnable This API enablesselected interrupts inLCD controller.

API is renamed to follow new codingguidelines. One of the input parameter"flag" is renamed to "intrMask" andthe macros that this parameter acceptsare grouped into enum"lcdcIntrMask_t".

NA

RasterIntDisable LCDCIntrDisable This API disablesselected interrupts inLCD controller.

Same as above. NA

RasterNibbleModeEnable LCDCRasterNibbleModeEnable This function enablesnibble mode.

API is renamed to follow new codingguidelines. The functionality of bothnibble mode enable and disable apisare combined into single API. Theunified API will accept additionalparameter "enableNibbleMode",which accepts the followingparameters TRUE or FALSE.

NA

RasterNibbleModeDisable Same as above This function disablesnibble mode.

Same as above NA

RasterFIFODMADelayConfig LCDCRasterSetDmaFifoDelay This function configuresinput FIFO delay.


NA

RasterHparamConfig LCDCRasterTimingConfig This function configuershorizontal timingparametes and numberof pixel per line.

API is renamed to follow new codingguidelines. The functionality of theHparam and Vparam configurationparameters are combined into singleAPI. This unified Api groups all theinput parameters into a structure"lcdcRasterTimingCfg_t" and theaddress of this sturcutue is passed as aparameter to this API.

NA

RasterVparamConfig Same as above This function configuersvertical timingparameters and numberof lines per panel.

Same as above NA

RasterTiming2Configure LCDCRasterPolarityConfig This function configuresthe polartiy of varioustiming parameters ofLCD controller.

API is renamed to follow new codingguidelines. ACBias configurationshave been removed from this API asnew api is defined for only acbiascofiguration. All the input parameterspassed are grouped into a structure"lcdcRasterPolarityCfg_t" and theaddress of this structure is passed as aparameter to this API.

NA

RasterDMAConfig LCDCDmaConfig This function configuresDMA present insideLCD controller.

API is renamed to follow new codingguidelines. All the input parametersare grouped into a structure"lcdcDmaCfg_t" and the address ofthis sturucture is passed as a parameterto this API.

NA


RasterByteSwapEnable LCDCByteSwapEnable This function enablesbyte swap with in a halfword of the dmatransfer.

API is renamed to follow new codingguidelines. The functionality of bothbyte swap enable and disable apis arecombined into single API. The unifiedAPI will accept additional parameter"enableByteSwap", which accepts thefollowing parameters TRUE orFALSE.

NA

RasterByteSwapDisable Same as above. This function disablesbyte swap with in a halfword of the dmatransfer.

Same as above. NA

RasterIntStatus LCDCIntrStatus This function returnsstatus of the specifiedinterrupts.

API is renamed to follow new codingguidelines. Old API is accepting aparameter "flag" which selects thestatus of the required interrupts, butthe new API will return status of theall the interrupts. It is up to user tocheck the status of the requiredinterrupts.

NA

RasterIntRawStatus LCDCIntrRawStatus This function returnsraw status of thespecified interrupts.

API is renamed to follow new codingguidelines. Old API is accepting aparameter "flag" which returns the rawstatus of the required interrupts, butthe new API will return raw status ofthe all the interrupts. It is up to user tocheck the status of the requiredinterrupts.

NA

RasterIntRawStatusSet LCDCIntrTrigger This function assertsspecified interrupts.

API is renamed to follow new codingguidelines. One of the input parameter"flag" is renamed to "intrMask" andthe macros that this parameter acceptsare grouped into enum"lcdcIntrMask_t".

NA

RasterDMAFBConfig LCDCDmaFrameBufConfig This function configuresbase and ceiling valuefor Frame buffer.

"API is renamed to follow new codingguidelines. This API functionality isnot changed except the followingparameters are renamed : base ->bufAddr,flag ->frmBufId. The macros that theparameter "frmBufId" accepts aregrouped into the following enum"lcdcFrmBufId_t".

NA

RasterClearGetIntStatus LCDCIntrClear This function clear statusof the selectedinterrupts.

API is renamed to follow new codingguidelines. One of the input parameter"flag" is renamed to "intrMask" andthe macros that this parameter acceptsare grouped into enum"lcdcIntrMask_t". Old API willreturn the status along with clearingstatus, whereas new API clears statusand will not return the status.

NA


RasterSubPanelEnable LCDCRasterSubPanelEnable This function enablesraster subpanel feature

API is renamed to follow new codingguidelines. The functionality of bothraster sub panel enable and disableapis are combined into single API. Theunified API will accept additionalparameter "enableSubPanel", whichaccepts the following parametersTRUE or FALSE.

NA

RasterSubPanelDisable Same as above This function disablesraster subpanel feature

Same as above NA

RasterSubPanelConfig LCDCRasterSubPanelConfig This function configuresraster subpanel feature

API is renamed to follow new codingguidelines. No functionality change.Input parameters are renamed as hols-> subPanelPos, lppt->linesPerPanelThr, dpd->defaultPixelData. The parameter"subPanelPos" can take macros fromthe enum"lcdcRasterSubPanelPos_t".

NA

RasterClocksEnable LCDCClocksEnable This function Enablesthe clock for the DMAsubmodule,LIDDsubmodule and for thecore(which encompassesthe Raster active matrixand Passive matrix).


NA

RasterSoftWareClkEnable LCDCRasterClkEnable This function enablessoftware clock for theraster,whichencompasses the rasteractive matrix andpassive matrix logic.

API is renamed to follow new codingguidelines. The functionality of bothraster clock enable and disable apis arecombined into single API. The unifiedAPI will accept additional parameter"enableRasterClk", which accepts thefollowing parameters TRUE orFALSE.

NA

RasterSoftWareClkDisable Same as above This function disablessoftware clock for theraster,whichencompasses the rasteractive matrix andpassive matrix logic.

Same as above NA

RasterDMASoftWareClkEnable LCDCDmaClkEnable This function enablessoftware clock for theDMA submodule.

API is renamed to follow new codingguidelines. The functionality of bothDma clock enable and disable apis arecombined into single API. The unifiedAPI will accept additional parameter"enableDmaClk", which accepts thefollowing parameters TRUE orFALSE.

NA

RasterDMASoftWareClkDisable Same as above This function disablessoftware clock for theDMA submodule.

Same as above NA


RasterSoftWareResetControlEnable LCDCSoftwareResetEnable This function doesSoftware Resets forLCD module or DMAsubmodule or Corewhich encompassesRaster Active Matrixand Passive Matrix logicbased on the "flag"argument passed to thisfunction.

API is renamed to follow new codingguidelines. The functionalities ofenable and disable apis are combinedinto single api, by adding one moreparameter"enableSoftwareReset".The inputparameter "moduleId" accepts macrosfrom the enum "lcdcSubModuleId_t"and the parameter"enableSoftwareReset" accepts themacros TRUE or FALSE.

NA

RasterSoftWareResetControlDisable Same as above This function disablesSoftware Resets forLCD module or DMAsubmodule or Corewhich encompassesRaster Active Matrixand Passive Matrix logicbased on the "flag"argument passed to thisfunction.

Same as above NA

RasterDmaMasterPrioritySet LCDCSetDmaMasterPriority This function sets thepriority for the L3 OCPMaster Bus.


NA

RasterStandbyModeConfig LCDCSetStandbyMode This API configures thestandby mode of LCDcontroller.

API is renamed to follow new codingguidelines. The parameter isrenamed as flag -> standbyMode andthe macros that this parameter acceptsare grouped into an enumlcdcStandbyMode_t.

NA

RasterIdleModeConfig LCDCSetIdleMode This API configures theIdle mode of LCDcontroller.

API is renamed to follow new codingguidelines. The parameter is renamedas flag -> idleMode and the macrosthat this parameter accepts are groupedinto an enum lcdcIdleMode_t.

NA

RasterContextSave LCDCContextSave This API saves thecontext of LCDCregisters.

API is renamed to follow new codingguidelines. The structure which holdsthe context information is renamed asRASTERCONTEXT -> lcdcContext_t.

NA

RasterContextRestore LCDCContextRestore This API restores thecontext of LCDCregisters.

API is renamed to follow new codingguidelines. The structure which holdsthe context information is renamed asRASTERCONTEXT ->lcdcContext_t.

NA




RasterEndOfFrameIntEnable RasterEndOfFrameIntEnable This API is valid only for am1808 raster but not for am335x raster.

RasterEndOfFrameIntDisable RasterEndOfFrameIntDisable Same as above.



RASTER_DISPLAY_MODE_XX Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcRasterMatrixMode_t.


--- All the supported pixel formats have beengrouped into an enum lcdcPixelFormat_t.

New macros.

RASTER_MONO8B, RASTER_MONO4B Output widths of monochromatic display aregrouped into an enum lcdcMonoType_t.

New macros.

RASTER_PALETTE_DATA,RASTER_PALETTE, RASTER_DATA

Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcPaletteMode_t.


RASTER_COLOR, RASTER_MONOCHROME Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcRasterDisplayType_t.


RASTER_RIGHT_ALIGNED,RASTER_EXTRAPOLATE

----- These macros have been removed. The APIinstead of accepting these macros, it willaccept TRUE or FALSE and achieve thesame functionality.

RASTER_SINGLE_FRAME_BUFFER,RASTER_DOUBLE_FRAME_BUFFER

Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcDmaFrmMode_t.


RASTER_BIG_ENDIAN_XX Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcDmaDataEndian_t.


RASTER_BURST_SIZE_XX Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcDmaBurstSize_t.


RASTER_FIFO_THRESHOLD_XX Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcFifoThreshold_t.


RASTER_FRAME_CLOCK_XX Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcRasterVSyncPol_t.


RASTER_LINE_CLOCK_XX Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcRasterHSyncPol_t.


RASTER_PIXEL_CLOCK_XX Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcRasterPclkPol_t.


RASTER_SYNC_EDGE_XX Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcRasterActiveSyncEdge_t.



RASTER_SYNC_CTRL_XX Macro names are updated to follow new codingguidelines and these macros are grouped into anenum lcdcRasterSyncCtrl_t.


RASTER_CORE_RESET,RASTER_DMA_RESET,RASTER_LCD_MODULE_RESET

----- These macros have been removed. Insteadof these macros sub module Ids have beendefined inside an enumlcdcSubModuleId_t.

----- Macros corresponding to data order select havebeen grouped into an enumlcdcRasterDataOrder_t.

New macros.

----- All the interrupt masks have been renamed tofollow new coding guidelines and they aregrouped into an enum lcdcIntrMask_t.


---- Sub panel position macros are groupd into anenum lcdcRasterSubPanelPos_t.

New macros.

---- Standby mode configurations have been groupedinto an enum lcdcStandbyMode_t.

New macros.

---- Idle mode configurations have been grouped intoan enum lcdcIdleMode_t.

New macros.

Structure : RASTERCONTEXT Structure is renamed as below to follow newcoding guidelines lcdcContext_t.

Naming convention change.

----- All the LCDC DMA parameters are grouped intothe following strucuture lcdcDmaCfg_t.

New structure.

----- All the LCDC display parameters are groupedinto the following structurelcdcRasterDisplayAttrCfg_t.

New structure.

----- All the LCDC timing parameters have beengrouped into the following structurelcdcRasterTimingCfg_t.

New structure.

----- All the LCDC signal polarities are grouped intothe following structure lcdcRasterPolarityCfg_t.

New structure.

----- Following is the strucutre holding the ac biasconfiguration parameters lcdcRasterAcbCfg_t.

New structure.

MMCSDThe below table lists API differences between the versions




StarterWare v02.01.00.XX : Changes Notes

HSMMCSDSoftReset No change. This API performssoft reset ofMMC/SD controller.It also waits until thereset process iscomplete.

No Change. NA

HSMMCSDLinesReset HSMMCSDLinesReset This API performsthe soft reset of theMMC/SD controllerlines.

The parameter "flag" is renamed as"resetMask" and the macros that thisparameter accepts have been grouped intoan enum "hsMmcsdResetLineMask_t".

NA


HSMMCSDSystemConfig HSMMCSDSystemConfig This API performsthe systemconfigurations of theMMC/SDcontroller likestandby, idle andwake up modes.

Instead of passing a configurationparameter "config", all the systemconfiguration parameters have beengrouped into a structure"hsMmcsdSysCfg_t" and the pointerwhich holds the address of this struture hasbeen passed as a parameter.

NA

HSMMCSDBusWidthSet HSMMCSDSetBusWidth This API configuresthe MMC/SDcontroller bus width.

API is renamed to follow new codingguidelines. The macros that the parameter"width" accepts have been grouped into anenum "hsMmcsdBusWidth_t".

NA

HSMMCSDBusVoltSet HSMMCSDSetBusVolt This API configuresthe MMC/SD busvoltage.

API is renamed to follow new codingguidelines. The macros that the parameter"voltage" accepts have been grouped intoan enum "hsMmcsdBusVolt_t".

NA

HSMMCSDBusPower HSMMCSDBusPowerOnCtrl This API turnsMMC/SD bus poweron / off.

API is renamed to follow new codingguidelines. The macros that the parameter"pwrCtrl" accepts have been grouped intoan enum "hsMmcsdPwrCtrl_t".

NA

HSMMCSDIntClock HSMMCSDIntClockEnable This API controlsthe enable/disable ofinternal clocks.

API is renamed to follow new codingguidelines. The second parameter "pwr" isrenamed as "enableIntClk" and thesupported macros are TRUE or FALSE".

NA

HSMMCSDIsIntClockStable HSMMCSDIsIntClockStable This API gets theinternal clock stablestatus.

No change. NA

HSMMCSDSupportedVoltSet HSMMCSDSetSupportedVoltage This API sets thesupported busvoltages.

API is renamed to follow new codingguidelines. The parameter "volt" isrenamed as "voltMask" and the macrosthat this parameter accepts have beengrouped into an enum"hsMmcsdSuppVolt_t".

NA

HSMMCSDIsHSupported HSMMCSDIsHighSpeedSupported This API checks ifthe controllersupports high speed.


NA

HSMMCSDDataTimeoutSet HSMMCSDSetDataTimeout This API sets datatime out value. Thisvalue determinesthe interval by whichmmc_dat lines timeouts are detected.


NA

HSMMCSDBusFreqSet HSMMCSDSetBusFreq This API sets outputbus frequency.


NA

HSMMCSDInitStreamSend No Change. This API sends INITstream to the card.

No Change. NA

HSMMCSDIntrStatusEnable No Change. This API enables thecontroller events toset flags instatus register.

The parameter "flag" is renamed as"intrMask" and the macros that thisparameter accepts have been grouped intoan enum "hsMmcsdIntrMask_t".

NA

HSMMCSDIntrStatusDisable No Change. This API disablesthe controller eventsto set flags in statusregister.


NA


HSMMCSDIntrEnable No Change. This API enables thecontroller events togenerate a h/winterrupt request.


NA

HSMMCSDIntrStatusGet HSMMCSDIntrStatus This API gets thestatus of thehardware interrupts.

API is renamed to follow new codingguidelines. Instead of reading the status ofspecific interrupts, this will return status ofthe all the interrupts and it is upto theapplication to check the status of thespecific interrupts. Since it is returningentire status, the second paramter isremoved from the API defintion.

NA

--- HSMMCSDIntrDisable This API disablesthe controller eventsto generate a h/winterrupt request.

This API is newly added. NewAPI.

HSMMCSDIntrStatusClear HSMMCSDIntrClear This API clears theinterrupt status bitsof the controller.

API is renamed to follow new codingguidelines. The parameter "flag" isrenamed as "intrMask" and the macrosthat this parameter accepts have beengrouped into an enum"hsMmcsdIntrMask_t".

NA

HSMMCSDIsCmdComplete No Change This API checks ifthe command iscomplete.

No change. NA

HSMMCSDIsXferComplete No change This API checks ifthe transfer iscomplete.

No change. NA

HSMMCSDBlkLenSet HSMMCSDSetBlkLength This API sets theblock length/size (inbytes) for datatransfer.


NA

HSMMCSDCommandSend No change Pass the MMC/SDcommand to thecontroller/card.

All the command configuration parametershave been grouped into a strucutrehsMmcsdCmdObj_t. Instead of passingall the parameters, the address of strucutretype hsMmcsdCmdObj_t which containall the parameters have been passed to theAPI.

NA

HSMMCSDResponseGet HSMMCSDGetResponse This API gets thecommand responsefrom the controller.


NA

HSMMCSDIsCardInserted No change This API checks ifthe card is insertedand detected.

No change. NA

HSMMCSDIsCardWriteProtected No change This API checks ifthe card is writeprotected.

No change. NA

MMCSDContextSave HSMMCSDContextSave This API can beused to save theregister context ofMMCSD.

API is renamed to follow new codingguidelines and the context stuructre type isrenamed as MMCSDCONTEXT ->hsMmcsdCtx_t.

NA


MMCSDContextRestore HSMMCSDContextRestore This API can beused to restore theregister context ofMMCSD.

API is renamed to follow new codingguidelines and the context stuructre type isrenamed as MMCSDCONTEXT ->hsMmcsdCtx_t.

NA



HSMMCSDDataGet HSMMCSDDataGet ---



HS_MMCSD_STANDBY_XX Macros have been renamed to follow new codingguidelines and they are grouped into anenum hsMmcsdStandbyMode_t.

Macros are logicallygrouped.

HS_MMCSD_CLOCK_OFF,HS_MMCSD_FCLK_OFF,

HS_MMCSD_ICLK_OFF,HS_MMCSD_CLOCK_ON

Macros have been renamed to follow new codingguidelines and they are grouped into an enumhsMmcsdClkAct_t.


HS_MMCSD_SMARTIDLE_XX Macros have been renamed to follow new codingguidelines and they are grouped into an enumhsMmcsdIdleMode_t.


HS_MMCSD_WAKEUP_XX,HS_MMCSD_AUTOIDLE_XX

These macros have been removed. The API functionality ischanged such that theAPI accepts TRUE orFALSE instead of thesemacros.

HS_MMCSD_BUS_WIDTH_XX Macros have been renamed to follow new codingguidelines and they are grouped into an enumhsMmcsdBusWidth_t.


HS_MMCSD_BUS_VOLT_XX Macros have been renamed to follow new codingguidelines and they are grouped into an enumhsMmcsdBusVolt_t.


HS_MMCSD_BUS_POWER_XX Macros have been renamed to follow new codingguidelines and they are grouped into an enumhsMmcsdBusVolt_t.


HS_MMCSD_SUPPORT_VOLT_XX Macros have been renamed to follow new codingguidelines and they are grouped into an enumhsMmcsdSuppVolt_t.


HS_MMCSD_INTR_XX, HS_MMCSD_STAT_XX,HS_MMCSD_SIGEN_XX

Instead of three sets of macros single set of macros havebeen defined. Macros have been renamed to follow newcoding guidelines and they are grouped into an enumhsMmcsdSuppVolt_t.


HS_MMCSD_XX_RESET Macros have been renamed to follow new codingguidelines and they are grouped into an enumhsMmcsdResetLineMask_t.


--- Following new strucuture has been defined to holdmmcsd controller system configuration :hsMmcsdSysCfg_t.

New structure.

--- Following new strucuture has been defined to holdmmcsd controller system configuration :hsMmcsdCmdObj_t.

New structure.


structure: MMCSDCONTEXT Structure is renamed as hsMmcsdCtx_t to follow newcoding guidelines.

Renamed to follow newcoding guidelines.

Macro: HS_MMCSD_CMD No change. No Change.

CPSWThe below table lists API differences between the versions




StarterWarev02.01.00.XX :

Changes

Notes

--- CPSWReset This API resets the CPSW. NA

CPSWSSReset CPSWSsReset This API resets the CPSW Subsystemmodule.

--- CPSWCpdmaReset This API resets the CPDMA module.

CPSWSlControlExtEnable CPSWSlCtrlInbandEnable This API configures the operatingmode of the sliver.

CPSWSlGigModeForceEnable CPSWSlForceExtGigbitMode This API configures the CPGMAC ofsliver if the input gmii_mt_clk hasbeen stopped by the PHY.

CPSWSlGigModeForceDisable ----

CPSWSlTransferModeSet CPSWSlGigModeEnable This API configures the transfer speedof the sliver to gigabit or non-gigabitmode.

--- CPSWSlSetDuplexMode This API sets the transfer duplexmode of the sliver.

CPSWSlMACStatusGet ----

CPSWSlReset CPSWSlReset This API resets the CPSW SliverLogic.

CPSWSlRxMaxLenSet CPSWSetSlRxMaxLen This API sets the maximum length forreceived frame in sliver.

CPSWSlGMIIEnable CPSWSlGmiiEnable This API configures the sliver toenable GMII for gigabit mode.

---- CPSWSetSlRmiiSpeed This API configures the RMII inputspeed of slover to either 10Mbps or100Mbps operation.

---- CpswMacOperModeConfig This API configures the operatingspeed and duplex mode for MAC ofgiven port.

CPSWSlRGMIIEnable ---

---- CPSWSlIsExtSpeedGigabit This API checks the external speedstatus of sliver is gigabit ornon-gigabyte (10/100 Mbps) forin-band mode of operation.

---- CPSWSlIsExtFullDuplex This API check the external duplexstatus is Half/Full for in-band mode ofoperation.


---- CPSWSlIsMacIdle This API checks if the sliver is in idlestate.

CPSWWrReset CPSWWrReset This API resets the CPSW Wrappermodule.

CPSWWrControlRegReset ----

CPSWWrCoreIntEnable CPSWWrChIntrEnable This API enables RX, TX or RXthreshold interrupts of a channel. Itconfigures given interrupt coreinterfaced to processor.

---- CPSWWrMiscIntrEnable This API enables miscellaneousinterrupts. It configures given interruptcore in wrapper module interfaced toprocessor.

CPSWWrCoreIntDisable CPSWWrchIntrDisable This API disables RX, TX or RXthreshold interrupts of a channel. Itconfigures given interrupt core inwrapper module interfaced toprocessor.

CPSWWrMiscIntrDisable This API disables miscellaneousinterrupts. It configures given interruptcore in wrapper module interfaced toprocessor.

CPSWWrCoreIntStatusGet CPSWWrchIntrStatus This API gives status given channelinterrupt of all channels for giveninterrupt core in wrapper moduleinterfaced to processor.

CPSWWrMiscIntrStatus This API gives status formiscellaneous interrupts of giveninterrupt core in wrapper moduleinterfaced to processor.

CPSWWrRGMIIStatusGet CPSWGetWrRgmiiInbandSpeed This API gives speed of CPRGMII inin-band mode for given slave port.

CPSWGetWrRgmiiInbandDuplexMode This API gives duplex mode ofCPRGMII in in-band mode for givenslave port.

CPSWWrRgmiiInbandLinkStatus This API gives link status ofCPRGMII in in-band mode for givenslave port.

CPSWALEInit CPSWAleInit

CPSWAleEnable This API enables/disables packetprocessing by ALE.

CPSWAleClearTable This API clears the entries of addresslookup table.

CPSWALEPortStateSet CPSWAleSetPortState This API configures the port state fora given port in the ALE.

CPSWALETableEntrySet CPSWAleSetTableEntry This API sets an ALE table entry atgiven index.

CPSWALETableEntryGet CPSWAleGetTableEntry This API reads an ALE table entry atgiven index.


CPSWALEPrescaleGet CPSWAleGetRateLimitPrescale This API reads the prescale value forALE.

CPSWALEPrescaleSet CPSWAleSetRateLimitPrescale This API sets the prescale value forALE.

CPSWAleBypassEnable This API enables/disables thebypassing of the ALE logic for allpackets received on slave ports to thehost port.

CPSWALEBypassEnable

CPSWALEBypassDisable

CPSWRxFlowControlEnable CPSWSsRxFlowCtrlEnable This API enables/disables the receiveflow control for a given port in CPSWsystem.

CPSWRxFlowControlDisable

CPSWSoftwareIdleEnable CPSWSsSwIdleEnable This API enables/disables the softwareidle mode, causing the switch fabric tostop forward packets at the next startof packet.

CPSWSoftwareIdleDisable

CPSWStatisticsEnable CPSWSsStatsEnable This API enables/disables the CPSWstatistics for the given port

CPSWVLANAwareEnable CPSWSsVlanAwareEnable This API enables/disables the VLANaware mode for CPSW.

CPSWVLANAwareDisable

CPSWPortSrcAddrSet CPSWSetPortSrcAddr This API configures the MAC addressof the slave port.

CPSWStatisticsGet

CPSWCPDMAReset

CPSWCPDMACmdIdleEnable CPSWCpdmaIdleEnable This API enable/disable the idle modefor CPDMA. When enabled idle, theCPSW stops all the reception andtransmission. However, if receivingthe current frame will be receivedcompletely before going to the idlestate. Also, while transmitting, thecontents in the fifo will be sent fully.

CPSWCPDMACmdIdleDisable

CPSWCPDMATxIntEnable CPSWCpdmaChIntrEnable This API enables the transfer interruptfor given channel.

CPSWCPDMARxIntEnable

CPSWCPDMATxIntDisable CPSWCpdmaChIntrDisable This API disables the transfer interruptfor given channel.

CPSWCPDMARxIntDisable

CPSWCPDMATxEnable CPSWCpdmaXferEnable This API enables the transfer. Anywrite to hardware descriptor of achannel will start transfer.

CPSWCPDMARxEnable


CPSWCpdmaXferDisable This API disables the transfer.

CPSWCPDMATxHdrDescPtrWrite CPSWCpdmaWriteXferHdrDescPtr This API writes the transfer HDPregister. If transfer is enabled, write tothe transfer HDP will immediatelystart transfer. The data will be takenfrom the buffer pointer of the transferbuffer descriptor written to the transferHDP.

CPSWCPDMARxHdrDescPtrWrite

CPSWCPDMAEndOfIntVectorWrite CPSWCpdmaWriteEoiVector This API writes the interrupt linenumber to End Of Interrupt Vector.

CPSWCPDMATxCPWrite CPSWCpdmaWriteXferCp This API writes the the transferCompletion Pointer for a specificchannel.

CPSWCPDMARxCPWrite

CPSWCPDMANumFreeBufSet CPSWSetCpdmaNumFreeBuf This API sets the free buffers for aspecific channel.

CPSWCPDMAStatusGet

CPSWIsCpdmaIdle This API checks if the CPDMA is inidle state.

CPSWGetCpdmaHostErrorCode Returns the CPDMA Status.

CPSWGetCpdmaHostErrorCh This API returns the channel numberon which error occurred.

CPSWCPDMAConfig

CPSWCpdmaTxRateLimitChBusConfig This API configures the transmit ratelimit channel bus of CPDMA module.

CPSWCPDMARxBufOffsetSet CPSWSetCpdmaRxBufOffset This API sets the RX buffer offsetvalue. The RX buffer offset will bewritten by the port into each frameSOP buffer descriptor buffer_offsetfield. The frame data will begin afterthe rx_buffer_offset value of bytes.This value will be used for all thechannels .

CPSWCPDMATxIntStatRawGet CPSWCpdmaChIntrRawStatus This API returns the raw status ofgiven interrupt for all channels.

CPSWCPDMARxIntStatRawGet

CPSWCPDMATxIntStatMaskedGet CPSWCpdmachIntrStatus This API returns the status of giveninterrupt for all channels.

CPSWCPDMARxIntStatMaskedGet

CPSWContextSave

CPSWContextRestore

CPSWHostPortDualMacModeSet CPSWHostPortDualMacModeEnable This API configures the host port forDual MAC mode.

CPSWAleVlanAwareEnable This API configures VLAN Aware inALE module to determine what to bedone if VLAN is not found.

CPSWALEVLANAwareSet


CPSWALEVLANAwareClear

CPSWPortVLANConfig CPSWPortVlanConfig This API configures Port VLAN.

Migration FAQs• Will the StarterWare v02.01.xx.xx APIs be backward compatible to the StarterWare v02.00.xx.xx APIs?

• Due to significant changes for ensuring consistency across DALs, the new APIs shall not be backwardcompatible to the earlier StarterWare releases.

Article Sources and Contributors 87

Article Sources and ContributorsStarterware 02 01 00 XX Migration Guide Source: http://ap-fpdsp-swapps.dal.design.ti.com/index.php?oldid=191888 Contributors: A0132220, Anantpai, Baskaran, Jeethan,MugdhaKamoolkar, Sandhya, Vishveshwarbhat, X0182916, X0189513

Image Sources, Licenses and ContributorsImage:TIBanner.png Source: http://ap-fpdsp-swapps.dal.design.ti.com/index.php?title=File:TIBanner.png License: unknown Contributors: Sriram

starterware 02 01 00 xx migration guide - texas...

Documents