Home

Stellaris Peripheral Driver Library User's Guide

1. Enable the Hibernation module SysCtlPeripheralEnable SYSCTL_PERIPH_HIBERNATE HibernateEnableExpClk SysCt1lClockGet Wait an amount of time for the module to power up Configure the clock source for Hibernation module and enable the RTC feature This configuration is for the 4 194304 MHz crystal HibernateClockSelect HIBERNATE_CLOCK_SEL_DIV128 HibernateRTCEnable j Set the RTC to an initial value HibernateRTCSet 0 150 January 11 2011 Hibernation Module Set Match 0 for 30 seconds from now HibernateRTCMatch0OSet HibernateRTCGet 30 Set up interrupts on the Hibernation module to enable the RTC match 0 interrupt Clear all pending interrupts and register the interrupt handler HibernateIntEnable HIBERNATE_INT_RTC_MATCH_0O HibernateIntClear HIBERNATE_INT_PIN_WAKE HIBERNATE_INT_LOW_BAT HIBERNATE_INT_RTC_MATCH_0O HIBERNATE_INT_RTC_MATCH_1 HibernateIntRegister HibernateHandler Hibernate handler above will now be invoked in 30 seconds January 11 2011 151 Hibernation Module 152 January 11 2011 Inter Integrated Circuit I2C 11 Inter Integrated Circuit 12C I ea Ns e E e AAE ETAIT T AAE TE E E ETT E A nan T AE dhe de A ASTIAT 153 APIPUMGIONS chcoccc dew veneanieineheale welt eesriaesddauciee aa ASE 154 Pregrammmg Example ccc carnrenaeceia
2. Restore program state information that was saved prior to hibernation HibernateDataGet ulNVData 64 Now that wakeup cause has been determined and state has been restored the program can proceed with normal processor and peripheral initialization Hibernation module was not active so this is a cold power up reset else Perform normal power on initialization 148 January 11 2011 Hibernation Module The following example shows how to set up the Hibernation module and initiate a hibernation with wake up at a future time unsigned long ulStatus unsigned long ulNVData 64 Need to enable the hibernation peripheral before using it SysCtlPeripheralEnable SYSCTL_PERIPH_HIBERNATE La Enable clocking to the Hibernation module HibernateEnableExpClk SysCtlClockGet User implemented delay here to allow crystal to power up and stabilize Configure the clock source for Hibernation module and enable the RTC feature This configuration is for a 4 194304 MHz crystal HibernateClockSelect HIBERNATE_CLOCK_SEL_DIV128 HibernateRTCEnable Set the RTC to 0 or an initial value The RTC can be set once when the system is initialized after the cold startup and then left to run Or it can be initialized before every hibernate HibernateRTCSet 0 Set the match 0 register f
3. Parameters ulBase is the base address of the timer module ulTimer specifies the timer s to adjust must be one of TIMER_A TIMER_B or TIMER_BOTH ulValue is the timer prescale value must be between 0 and 255 inclusive Description This function sets the value of the input clock prescaler The prescaler is only operational when in 16 bit mode and is used to extend the range of the 16 bit timer modes Returns None 21 2 2 23 TimerRTCDisable Disable RTC counting Prototype void TimerRTCDisable unsigned long ulBase Parameters ulBase is the base address of the timer module Description This function causes the timer to stop counting when in RTC mode January 11 2011 303 Timer Returns None 21 2 2 24 TimerRTCEnable Enable RTC counting Prototype void TimerRTCEnable unsigned long ulBase Parameters ulBase is the base address of the timer module Description This function causes the timer to start counting when in RTC mode If not configured for RTC mode this will do nothing Returns None 21 2 2 25 TimerValueGet 21 3 304 Gets the current timer value Prototype unsigned long TimerValueGet unsigned long ulBase unsigned long ulTimer Parameters ulBase is the base address of the timer module ulTimer specifies the timer must be one of TIMER_A or TIMER_B Only TIMER_A should be used when the timer is configured for 32 bit operation Description This fu
4. Set up the master clock source to use the master clock from an external pin I2SMasterClockSelect I2SO_BASE I2S_TX_MCLK_INT Set the MCLK rate and save it for conversion back to sample rate The multiply by 8 is due to a 4X oversample rate plus a factor of two since the data is always stereo on the 12S interface ulSampleRate SysCtlI2SMC1kSet 0 ulSampleRate usBitsPerSample 8 Configure the TX format and mode Use I2S mode with 16 bit compact sample format Word size 16 but 32 bits on the wire This I2S TX will be the clock master and will transmit zeroes if the FIFO is empty I2STxConfigSet I2SO_BASE I2S_CONFIG_FORMAT_I2S I2S_CONFIG_MODE_COMPACT_16 I2S_CONFIG_CLK_MASTER I2S_CONFIG_SAMPLE_SIZE_16 I2S_CONFIG_WIRE_SIZE_32 I2S_CONFIG_EMPTY_ZERO Set the TX FIFO limit to trigger when there are 4 or fewer samples left in the FIFO I2STxFIFOLimitSet I2SO_BASE I2S_FIFO_LIMIT_4 Clear out all pending interrupts I2SIntClear I2SO_BASE I2S_INT_TXERR I2S_INT_TXREQ Enable the interrupts for error and service request Also since the interrupt vector was allocated at compile time the peripheral interrupt needs to be enabled on the master controller January 11 2011 January 11 2011 I2SIntEnable I2SO_BASE I2S_INT_TXERR I2S_INT_TXREQ IntEnable INT_I2S0 ih Finally the I2S transmitter nee
5. 19 2 2 15 SysCtllntEnable Enables individual system control interrupt sources Prototype void SysCtlIntEnable unsigned long ullInts Parameters ullnts is a bit mask of the interrupt sources to be enabled Must be a logical OR of SYSCTL_INT_PLL_LOCK SYSCTL_INT_CUR_LIMIT SYSCTL_INT_IOSC FAIL SYSCTL_INT_MOSC _ FAIL SYSCTL_INT_POR SYSCTL_INT_BOR and or SYSCTL_INT_PLL_FAIL 268 January 11 2011 System Control Description Enables the indicated system control interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor Returns None 19 2 2 16 SysCtllntRegister Registers an interrupt handler for the system control interrupt Prototype void SysCtlIntRegister void pfnHandler void Parameters pfnHandler is a pointer to the function to be called when the system control interrupt occurs Description This sets the handler to be called when a system control interrupt occurs This will enable the global interrupt in the interrupt controller specific system control interrupts must be enabled via SysCtllntEnable It is the interrupt handler s responsibility to clear the interrupt source via SysCtllntClear System control can generate interrupts when the PLL achieves lock if the internal LDO current limit is exceeded if the internal oscillator fails if the main oscillator fails if the internal LDO output voltage
6. 7 2 API Functions Functions m void EPlAddressMapSet unsigned long ulBase unsigned long ulMap m void EPIConfigGPModeSet unsigned long ulBase unsigned long ulConfig unsigned long ulFrameCount unsigned long ulMaxWait void EPIConfigHB16Set unsigned long ulBase unsigned long ulConfig unsigned long ul MaxWait void EPIConfigHB8Set unsigned long ulBase unsigned long ulConfig unsigned long ul MaxWait m void EPIConfigSDRAMSet unsigned long ulBase unsigned long ulConfig unsigned long ul Refresh void EPI DividerSet unsigned long ulBase unsigned long ulDivider void EPIFIFOConfig unsigned long ulBase unsigned long ulConfig void EPIIntDisable unsigned long ulBase unsigned long ullntFlags void EPIIntEnable unsigned long ulBase unsigned long ullntFlags void EPlIntErrorClear unsigned long ulBase unsigned long ulErrFlags unsigned long EPlIntErrorStatus unsigned long ulBase January 11 2011 85 External Peripheral Interface EP 7 2 1 86 m void EPlIntRegister unsigned long ulBase void pfnHandler void unsigned long EPIIntStatus unsigned long ulBase tBoolean bMasked void EPlIntUnregister unsigned long ulBase void EPIModeSet unsigned long ulBase unsigned long ulMode unsigned long EPINonBlockingReadAvail unsigned long ulBase void EPINonBlockingReadConfigure unsigned long ulBase unsigned long ulChannel un signed long ulDataSize unsigned long ulAddress unsigned long EPINonBlocki
7. Description The watchdog timer interrupt source is cleared so that it no longer asserts Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None WatchdogIntEnable Enables the watchdog timer interrupt Prototype void WatchdogIntEnable unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description Enables the watchdog timer interrupt Note This function will have no effect if the watchdog timer has been locked See also WatchdogLock WatchdogUnlock WatchdogEnable Returns None WatchdogIntRegister Registers an interrupt handler for watchdog timer interrupt Prototype void WatchdogIntRegister unsigned long ulBase void pfnHandler void January 11 2011 395 Watchdog Timer 25 2 2 5 25 2 2 6 396 Parameters ulBase is the base address of the watchdog timer module pfnHandler is a pointer to the function to be called when the watchdog timer interrupt
8. Prototype unsigned long I2STxFIFOLimitGet unsigned long ulBase Parameters ulBase is the 2S module base address January 11 2011 181 Inter IC Sound 12S Description This function is used to get the value of the transmit FIFO service request level This value is set using the I2STxFIFOLimitSet function Returns Returns the current value of the FIFO service request limit 12 2 2 23 I2STxFIFOLimitSet Sets the FIFO level at which a service request is generated Prototype void I2STxFIFOLimitSet unsigned long ulBase unsigned long ulLevel Parameters ulBase is the I2S module base address ulLevel is the FIFO service request limit Description This function is used to set the transmit FIFO fullness level at which a service request will occur The service request is used to generate an interrupt or a DMA transfer request The transmit FIFO will generate a service request when the number of items in the FIFO is less than the level specified in the u Level parameter For example if u Level is 8 then a service request will be generated when there are less than 8 samples remaining in the transmit FIFO For the purposes of counting the FIFO level a left right sample pair counts as 2 whether the mode is dual or compact stereo When mono mode is used internally the mono sample is still treated as a sample pair so a single mono sample counts as 2 Since the FIFO always deals with sample pairs the level
9. Returns None MPURegionGet Gets the current settings for a specific region Prototype void MPURegionGet unsigned long ulRegion unsigned long xpulAddr unsigned long pulFlags Parameters ulRegion is the region number to get pulAdar points to storage for the base address of the region pulFlags points to the attribute flags for the region January 11 2011 201 Memory Protection Unit MPU 14 2 2 9 202 Description This function retrieves the configuration of a specific region The meanings and format of the parameters is the same as that of the MPURegionSet function This function can be used to save the configuration of a region for later use with the MPURe gionSet function The region s enable state will be preserved in the attributes that are saved Returns None MPURegionSet Sets up the access rules for a specific region Prototype void MPURegionSet unsigned long ulRegion unsigned long ulAddr unsigned long ulFlags Parameters ulRegion is the region number to set up ulAddr is the base address of the region It must be aligned according to the size of the region specified in ulFlags ulFlags is a set of flags to define the attributes of the region Description This function sets up the protection rules for a region The region has a base address and a set of attributes including the size which must be a power of 2 The base address parameter ulAdadr must b
10. SysCtlPeripheralEnable unsigned long ulPeripheral Parameters ulPeripheral is the peripheral to enable Description System Control SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH _I2C0 SYSCTL_PERIPH_ PWM SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TEMP SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_WDOGO or Peripherals are enabled with this function At power up all peripherals are disabled they must be enabled in order to operate or respond to register reads writes The ulPeripheral parameter must be only one of the following values SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CANO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2CO SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_PWM SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_TEMP SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO or SYSCTL_PERIPH_WDOG1 Note It takes five clock cycles after the write to enable a peripheral
11. 368 Returns the current status of an endpoint Prototype unsigned long USBEndpointStatus unsigned long ulBase unsigned long ulEndpoint Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access Description This function will return the status of a given endpoint If any of these status bits need to be cleared then these these values must be cleared by calling the USBDevEndpointStatusClear or USBHostEndpointStatusClear functions The following are the status flags for host mode USB_HOST_IN_PID_ERROR PID error on the given endpoint USB_HOST_IN_NOT_COMP The device failed to respond to an IN request USB_HOST_IN_STALL A stall was received on an IN endpoint USB_HOST_IN_DATA_ERROR There was a CRC or bit stuff error on an IN endpoint in Isochronous mode January 11 2011 USB Controller USB_HOST_IN_NAK_TO NAKs received on this IN endpoint for more than the specified timeout period USB_HOST_IN_ERROR Failed to communicate with a device using this IN endpoint USB_HOST_IN_FIFO_FULL This IN endpoint s FIFO is full USB_HOST_IN_PKTRDY Data packet ready on this IN endpoint a USB_HOST_OUT_NAK_TO NAKs received on this OUT endpoint for more than the specified timeout period a USB_HOST_OUT_NOT_COMP The device failed to respond to an OUT request a USB_HOST_OUT_STALL A stall was received on this OUT endpoint USB_HOST_OUT_
12. CANIntDisable Disables individual CAN controller interrupt sources Prototype void CANIntDisable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base address of the CAN controller ullntFlags is the bit mask of the interrupt sources to be disabled Description Disables the specified CAN controller interrupt sources Only enabled interrupt sources can cause a processor interrupt The ullntFlags parameter has the same definition as in the CANIntEnable function Returns None CANIntEnable Enables individual CAN controller interrupt sources January 11 2011 Controller Area Network CAN Prototype void CANIntEnable unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the base address of the CAN controller ullntFlags is the bit mask of the interrupt sources to be enabled Description Enables specific interrupt sources of the CAN controller Only enabled sources will cause a processor interrupt The ul ntFlags parameter is the logical OR of any of the following CAN_INT_ERROR a controller error condition has occurred CAN_INT_STATUS a message transfer has completed or a bus error has been detected CAN_INT_MASTER allow CAN controller to generate interrupts In order to generate any interrupts CAN_INT_MASTER must be enabled Further for any particular transaction from a message object to generate an interrupt that message obj
13. Prototype void USBHostHubAddrSet unsigned long ulBase unsigned long ulEndpoint unsigned long ulAddr unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulAddr is the hub address for the device using this endpoint ulFlags determines if this is an IN or an OUT endpoint Description This function will set the hub address for a device that is using this endpoint for communication The u Flags parameter determines if the device address for the IN or the OUT endpoint is set by this call Note This function should only be called in host mode Returns None 24 3 2 34 USBHostMode Change the mode of the USB controller to host Prototype void USBHostMode unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function changes the mode of the USB controller to host mode This is only valid on microcontrollers that have the host and device capabilities and not the OTG capabilities Returns None 24 3 2 35 USBHostPwrConfig Sets the configuration for USB power fault January 11 2011 377 USB Controller Prototype void USBHostPwrConfig unsigned long ulBase unsigned long ulFlags Parameters ulBase specifies the USB module base address ulFlags specifies the configuration of the power fault Description This function controls how the USB controller uses i
14. Waits for a packet from the Ethernet controller Prototype long EthernetPacketGet unsigned long ulBase unsigned char pucBuf long 1BufLen Parameters ulBase is the base address of the controller pucBuf is the pointer to the packet buffer BufLen is the maximum number of bytes to be read into the buffer Description This function reads a packet from the receive FIFO of the controller and places it into pucBurf The function will wait until a packet is available in the FIFO Then the function will read the entire packet from the receive FIFO If there are more bytes in the packet than will fit into pucBuf as specified by BufLen the function will return the negated length of the packet and the buffer will contain BufLen bytes of the packet Otherwise the function will return the length of the packet that was read and pucBuf will contain the entire packet excluding the frame check sequence bytes Note This function is blocking and will not return until a packet arrives Returns Returns the negated packet length n if the packet is too large for pucBuf and returns the packet length n otherwise EthernetPacketGetNonBlocking Receives a packet from the Ethernet controller January 11 2011 6 2 2 17 Ethernet Controller Prototype long EthernetPacketGetNonBlocking unsigned long ulBase unsigned char xpucBuf long 1BufLen Parameters ulBase is the base address of the controller pucB
15. void HibernatelntEnable unsigned long ullntFlags void HibernatelntRegister void pfnHandler void unsigned long HibernatelntStatus tBoolean bMasked void HibernatelntUnregister void unsigned int HibernatelsActive void unsigned long HibernateLowBatGet void January 11 2011 135 Hibernation Module 10 2 1 m void HibernateLowBatSet unsigned long ulLowBatFlags void HibernateRequest void void HibernateRTCDisable void void HibernateRTCEnable void unsigned long HibernateRTCGet void unsigned long HibernateRTCMatch0Get void void HibernateRTCMatch0Set unsigned long ulMatch unsigned long HibernateRT CMatch1 Get void void HibernateRTCMatch1 Set unsigned long ulMatch void HibernateRTCSet unsigned long ulRTCValue unsigned long HibernateRTCTrimGet void void HibernateRT CTrimSet unsigned long ulTrim unsigned long HibernateWakeGet void void HibernateWakeSet unsigned long ulWakeFlags Detailed Description The Hibernation module must be enabled before it can be used Use the HibernateEnableExpClk function to enable it If a crystal is used for the clock source then the initializing code must allow time for the crystal to stabilize after calling the HibernateEnableExpClk function Refer to the device data sheet for information about crystal stabilization time If an oscillator is used then no delay is necessary After the module is enabled the clock source must be configured by calling Hiberna
16. EPI_INT_RXREQ read FIFO is above the trigger level m EPI_INT_ERR an error condition occurred Returns Returns None EPIIntErrorClear Clears pending EPI error sources Prototype void EPIIntErrorClear unsigned long ulBase unsigned long ulErrFlags Parameters ulBase is the EPI module base address ulErrFlags is a bit mask of the error sources to be cleared Description This function clears the specified pending EPI errors The u ErrFlags parameter can be the logical OR of any of the following values EPI_INT_ERR_WTFULL EPI_INT_ERR_RSTALL or EPLINT_ERR_TIMEOUT Returns Returns None EPIIntErrorStatus Gets the EPI error interrupt status Prototype unsigned long EPIIntErrorStatus unsigned long ulBase Parameters ulBase is the EPI module base address Description This function returns the error status of the EPI If the return value of the function EPIIntStatus has the flag EPI_INT_ERR set then this function can be used to determine the cause of the error January 11 2011 7 2 2 12 7 2 2 13 External Peripheral Interface EP This function returns a bit mask of error flags which can be the logical OR of any of the following EPl_INT_ERR_WTFULL occurs when a write stalled when the transaction FIFO was full EPl_INT_ERR_RSTALL occurs when a read stalled EPl_INT_ERR_TIMEOUT occurs when the external clock enable held off a transaction
17. GPIO 9 2 2 32 9 3 132 Description This function will ensure that the interrupt handler specified by pfnintHandler is called when an interrupt is detected from the selected GPIO port This function will also enable the correspond ing GPIO interrupt in the interrupt controller individual pin interrupts and interrupt sources must be enabled with GPIOPinlntEnable See also IntRegister for important information about registering interrupt handlers Returns None GPIOPortlIntUnregister Removes an interrupt handler for a GPIO port Prototype void GPIOPortIntUnregister unsigned long ulPort Parameters ulPort is the base address of the GPIO port Description This function will unregister the interrupt handler for the specified GPIO port This function will also disable the corresponding GPIO port interrupt in the interrupt controller individual GPIO interrupts and interrupt sources must be disabled with GPIOPinIntDisable See also IntRegister for important information about registering interrupt handlers Returns None Programming Example The following example shows how to use the GPIO API to initialize the GPIO enable interrupts read data from pins and write data to pins int iVal Register the port level interrupt handler This handler is the first level interrupt handler for all the pin interrupts ah GPIOPortIntRegister GPIO_PORTA_BASE PortAIntHandler ff Init
18. Parameters ulBase specifies the USB module base address ulEndpoint specifies which endpoint to remove the stall condition ulFlags specifies whether to remove the stall condition from the IN or the OUT portion of this endpoint Description This function will cause the endpoint number passed in to exit the stall condition If the u Flags parameter is USB_EP_DEV_IN then the stall will be cleared on the IN portion of this endpoint If the u Flags parameter is USB_EP_DEV_OUT then the stall will be cleared on the OUT portion of this endpoint Note This function should only be called in device mode Returns None 24 3 2 10 USBDevEndpointStatusClear Clears the status bits in this endpoint in device mode Prototype void USBDevEndpointStatusClear unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulFlags are the status bits that will be cleared Description This function will clear the status of any bits that are passed in the u Flags parameter The ulFlags parameter can take the value returned from the USBEndpointStatus call January 11 2011 363 USB Controller Note This function should only be called in device mode Returns None 24 3 2 11 USBDevMode Change the mode of the USB controller to device Prototype void USBDevMode unsigned long ulBase Parameters ulB
19. SYSCTL_PERIPH_GPIOG or SYSCTL_PERIPH_GPIOH Returns None 19 2 2 12 SysCtll2SMClkSet Sets the MCLK frequency provided to the 12S module Prototype unsigned long SysCtlI2SMC1kSet unsigned long ulInputClock unsigned long ulMC1lk Parameters ullnputClock is the input clock to the MCLK divider If this is zero the value is computed from the current PLL configuration ulIMCIk is the desired MCLK frequency If this is zero MCLK output is disabled Description This function sets the dividers to provide MCLK to the 12S module A MCLK divider will be cho sen that produces the MCLK frequency that is the closest possible to the requested frequency which may be above or below the requested frequency The actual MCLK frequency will be returned It is the responsibility of the application to de termine if the selected MCLK is acceptable in general the human ear can not discern the frequency difference if it is within 0 3 of the desired frequency though there is a very small percentage of the population that can discern lower frequency deviations Returns Returns the actual MCLK frequency 19 2 2 13 SysCtllntClear Clears system control interrupt sources Prototype void SysCtlIntClear unsigned long ullInts Parameters January 11 2011 ullnts is a bit mask of the interrupt sources to be cleared Must be a logical OR of SYSCTL_INT_PLL_LOCK SYSCTL_INT_CUR_LIMIT SYSCTL_INT_IOSC FAIL SYSCT
20. This function does not return 19 2 2 38 SysCtlResetCauseClear Clears reset reasons Prototype void SysCtlResetCauseClear unsigned long ulCauses Parameters ulCauses are the reset causes to be cleared must be a logical OR of SYSCTL_CAUSE_LDO SYSCTL_CAUSE_SW SYSCTL_CAUSE_WDOG SYSCTL_CAUSE_BOR SYSCTL_CAUSE_POR and or SYSCTL_CAUSE_EXT Description This function clears the specified sticky reset reasons Once cleared another reset for the same reason can be detected and a reset for a different reason can be distinguished instead of having two reset causes set If the reset reason is used by an application all reset causes should be cleared after they are retrieved with SysCtIResetCauseGet Returns None 19 2 2 39 SysCtlResetCauseGet Gets the reason for a reset Prototype unsigned long SysCt1lResetCauseGet void Description This function will return the reason s for a reset Since the reset reasons are sticky until either cleared by software or an external reset multiple reset reasons may be returned if multiple resets have occurred The reset reason will be a logical OR of SYSCTL_CAUSE_LDO SYSCTL_CAUSE_SW SYSCTL_CAUSE_WDOG SYSCTL_CAUSE_BOR SYSCTL_CAUSE_POR and or SYSCTL_CAUSE_EXT Returns Returns the reason s for a reset January 11 2011 281 System Control 19 2 2 40 SysCtlSleep Puts the processor into sleep mode Prototype void SysCt1Sleep void Description This functio
21. is used instead A define is used to to select the device being used since the set of functions available in the ROM must be a compile time decision checking at run time does not provide any flash savings since both the ROM call and the flash version of the API would be in the application flash image The following defines are recognized by driverlib rom h ARGET_IS_DUSTDEVIL_RAO The application is being built to run on a DustDevil class de vice silicon revision AO ARGET_IS_TEMPEST_RB1 The application is being built to run on a Tempest class device silicon revision B1 By using ROM_Function the ROM will be explicitly called If the function in question is not avail able in the ROM a compiler error will be produced See the Stellaris ROM User s Guide for details of the APIs available in the ROM The following is an example of calling a function in the ROM defining the device in question using a define in the source instead of in the project file define TARGET_IS_DUSTDEVIL_RAO January 11 2011 403 Using the ROM 26 3 404 include driverlib rom h include driverlib systick h int main void ROM_SysTickPeriodSet 0x1000 ROM_SysTickEnable Lp sare Mapped ROM Calls When code is intended to be shared between projects and some of the projects run on devices with a ROM and some run on devices without a ROM it is convenient to have the code automatically call the ROM
22. m 12S CONFIG_SCLK_INVERT to invert the polarity of the serial bit clock 178 January 11 2011 Inter IC Sound 12S 12S CONFIG_MODE_DUAL for dual channel stereo 12S CONFIG_MODE_COMPACT_16 for 16 bit compact stereo mode 128 _CONFIG_MODE_COMPACT _8 for 8 bit compact stereo mode or 126 CONFIG_MODE_MONDO for single channel mono format I2S CONFIG_CLK_MASTER or I2S_CONFIG_CLK_SLAVE to select whether the 12S transmitter is the clock master or slave I2S CONFIG_SAMPLE_SIZE_32 24 20 16 or _8 to select the number of bits per sample I2S CONFIG_WIRE_SIZE_32 24 20 16 or _8 to select the number of bits per word that are transferred on the data line 12S CONFIG_EMPTY_ZERO or I2S_CONFIG_EMPTY_REPEAT to select whether the module transmits zeroes or repeats the last sample when the FIFO is empty Returns None 12 2 2 17 l2STxDataPut Writes data samples to the 12S transmit FIFO with blocking Prototype void I2STxDataPut unsigned long ulBase unsigned long ulData Parameters ulBase is the 12S module base address ulData is the single or dual channel 12S data Description This function writes a single channel sample or combined left right samples to the 12S transmit FIFO The format of the sample is determined by the configuration that was used with the function I2STxConfigSet If the transmit mode is 125 MODE _DUAL_STEREO then the u Data parameter contains either the left or right sample The left and ri
23. unsigned char ucPins January 11 2011 9 2 2 19 9 2 2 20 GPIO Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The GPIO pins must be properly configured in order to function correctly as GPIO inputs this is especially true of Fury class devices where the digital input enable is turned off by default This function provides the proper configuration for those pin s The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Returns None GPIOPinTypeGP IOOutput Configures pin s for use as GPIO outputs Prototype void GPIOPinTypeGPlOOutput unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The GPIO pins must be properly configured in order to function correctly as GPIO outputs this is especially true of Fury class devices where the digital input enable is turned off by default This function provides the proper configuration for those pin s The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Retu
24. void UARTIntUnregister unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function does the actual unregistering of the interrupt handler It will clear the handler to be called when a UART interrupt occurs This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for important information about registering interrupt handlers Returns None 22 2 2 28 UARTModemControlClear Clears the states of the DTR and or RTS modem control signals Prototype void UARTModemControlClear unsigned long ulBase unsigned long ulControl January 11 2011 321 UART Parameters ulBase is the base address of the UART port ulControl is a bit mapped flag indicating which modem control bits should be set Description Clears the states of the DTR or RTS modem handshake outputs from the UART The ulControl parameter is the logical OR of any of the following m UART_OUTPUT_DTR The Modem Control DTR signal a UART_OUTPUT_RTS The Modem Control RTS signal Note The availability of hardware modem handshake signals varies with the Stellaris part and UART in use Please consult the datasheet for the part you are using to determine whether this support is available Returns None 22 2 2 29 UARTModemControlGet Gets the states of the DTR and RTS modem control signals Prototype unsigned
25. void UARTDisableSIR unsigned long ulBase void UARTDMADisable unsigned long ulBase unsigned long ulDMAFlags void UARTDMAEnable unsigned long ulBase unsigned long ulDMAFlags void UARTEnable unsigned long ulBase void UARTEnableSIR unsigned long ulBase tBoolean bLowPower void UARTFIFODisable unsigned long ulBase void UARTFIFOEnable unsigned long ulBase void UARTFIFOLevelGet unsigned long ulBase unsigned long pulTxLevel unsigned long pulRxLevel void UARTFIFOLevelSet unsigned long ulBase unsigned long ulTxLevel unsigned long ul RxLevel unsigned long UARTFlowControlGet unsigned long ulBase void UARTFlowControlSet unsigned long ulBase unsigned long ulMode void UARTIntClear unsigned long ulBase unsigned long ullntFlags void UARTIntDisable unsigned long ulBase unsigned long ullntFlags void UARTIntEnable unsigned long ulBase unsigned long ullntFlags void UARTIntRegister unsigned long ulBase void xpfnHandler void unsigned long UARTIntStatus unsigned long ulBase tBoolean bMasked void UARTIntUnregister unsigned long ulBase void UARTModemConitrolClear unsigned long ulBase unsigned long ulControl unsigned long UARTModemControlGet unsigned long ulBase void UARTModemControlSet unsigned long ulBase unsigned long ulControl unsigned long UARTModemStatusGet unsigned long ulBase unsigned long UARTParityModeGet unsigned long ulBase void UARTParityModeSet unsigned long ulBase unsigned long
26. All uDMA transfers used by the USB controller must use burst mode The final call sets the read access size to 8 bits wide the source address increment to 0 the destination address increment to 8 bits and the uDMA arbitration size to 64 bytes Example Configure endpoint 1 transmit channel Clear out any uDMA settings DMAChannelAttributeClear DMA_CHANNEL_USBEP1RX DMA_CONFIG_ALL DMAChannelAttributeSet DMA_CHANNEL_USBEP1RX DMA_CONFIG_USEBURST DMAChannelControlSet DMA_CHANNEL_USBEP1RX DMA_DATA_SIZE_8 DMA_ADDR_INC_NONE DMA_ADDR_INC_8 DMA_ARB_64 0 The next step is to actually start the uDMA transfer Unlike the transfer side if the application is ready this can be set up right away to wait for incoming data Like the transmit case these are the only calls needed to start a new transfer normally all of the previous UDMA configuration can remain the same Example Start requesting of data on endpoint 1 January 11 2011 Configure the address and size of the data to transfer is from the USB FIFO for endpoint 0 to g_DataBufferIn DMAChannelTransferSet DMA_CHANNEL_USBEP1RX DMA_MODE_BASIC USBF IFOAddr USBO_BASE USB_EP_1 g_DataBufferlIn 64 Enable the uDMA channel and wait for data DMAChannelEnable DMA_CHANNEL_USBEP1RX USB Controller transfer The uDMA interrupt occurs on the same interrupt vector as any other USB i
27. COMP_REF_1_2375V to set the reference voltage to 1 2375 V COMP_REF_1_340625V to set the reference voltage to 1 340625 V COMP_REF_1_375V to set the reference voltage to 1 375 V COMP_REF_1_44375V to set the reference voltage to 1 44375 V COMP_REF_1_5125V to set the reference voltage to 1 5125 V COMP_REF_1_546875V to set the reference voltage to 1 546875 V COMP_REF_1_65V to set the reference voltage to 1 65 V COMP_REF_1_753125V to set the reference voltage to 1 753125 V COMP_REF_1_7875V to set the reference voltage to 1 7875 V COMP_REF_1_85625V to set the reference voltage to 1 85625 V COMP_REF_1_925V to set the reference voltage to 1 925 V COMP_REF_1_959375V to set the reference voltage to 1 959375 V COMP_REF_2 _0625V to set the reference voltage to 2 0625 V COMP_REF_2_165625V to set the reference voltage to 2 165625 V COMP_REF_2_26875V to set the reference voltage to 2 26875 V COMP_REF_2_371875V to set the reference voltage to 2 371875 V Returns None 18 January 11 2011 3 2 2 9 3 3 Analog Comparator ComparatorValueGet Gets the current comparator output value Prototype tBoolean ComparatorValueGet unsigned long ulBase unsigned long ulComp Parameters ulBase is the base address of the comparator module ulComp is the index of the comparator Description This function retrieves the current value of the comparator output Returns Returns true if the comparator ou
28. Dead band generator Control block e PWM output enable e Output polarity control e Synchronization e Fault handling e Interrupt status This driver is contained in driverlib pwm c with driverlib pwm h containing the API defi nitions for use by applications 16 2 API Functions Functions void PWMDeadBandDisable unsigned long ulBase unsigned long ulGen void PWMDeadBandEnable unsigned long ulBase unsigned long ulGen unsigned short us Rise unsigned short usFall void PWMFaultIntClear unsigned long ulBase void PWMFaultIntClearExt unsigned long ulBase unsigned long ulFaultInts void PWMFaultIntRegister unsigned long ulBase void xpfnIntHandler void void PWMFaultIntUnregister unsigned long ulBase void PWMGenConfigure unsigned long ulBase unsigned long ulGen unsigned long ulConfig void PWMGenDisable unsigned long ulBase unsigned long ulGen January 11 2011 215 Pulse Width Modulator PWM 16 2 1 216 void PWMGenEnable unsigned long ulBase unsigned long ulGen void PWMGenFaultClear unsigned long ulBase unsigned long ulGen unsigned long ulGroup unsigned long ulFaultTriggers void PWMGenFaultConfigure unsigned long ulBase unsigned long ulGen unsigned long ulMinFaultPeriod unsigned long ulFaultSenses unsigned long PWMGenFaultStatus unsigned long ulBase unsigned long ulGen unsigned long ulGroup unsigned long PWMGenFaultTriggerGet unsigned long ulBase unsigned long ulGen un signed
29. Description This function will power on the Ethernet PHY enabling it return to normal operation By default the PHY is powered on so this function only needs to be called if EthernetPHYPowerOff has previously been called Returns None EthernetPHY Read Reads from a PHY register Prototype unsigned long EthernetPHYRead unsigned long ulBase unsigned char ucRegAddr Parameters ulBase is the base address of the controller ucRegAddar is the address of the PHY register to be accessed Description This function will return the contents of the PHY register specified by ucRegAdar Returns Returns the 16 bit value read from the PHY EthernetPHYWrite Writes to the PHY register January 11 2011 81 Ethernet Controller 6 2 2 23 6 3 82 Prototype void EthernetPHYWrite unsigned long ulBase unsigned char ucRegAddr unsigned long ulData Parameters ulBase is the base address of the controller ucRegAdar is the address of the PHY register to be accessed ulData is the data to be written to the PHY register Description This function will write the u Data to the PHY register specified by ucRegAdar Returns None EthernetSpaceAvail Checks for packet space available in the Ethernet controller Prototype tBoolean EthernetSpaceAvail unsigned long ulBase Parameters ulBase is the base address of the controller Description The Ethernet controller s trans
30. Description This function will return the starting address and size of the FIFO for a given endpoint End point zero does not have a dynamically configurable FIFO so this function should not be called for endpoint zero The u Flags parameter specifies whether the endpoints OUT or IN FIFO should be read If in host mode the u Flags parameter should be USB_EP_HOST_OUT or USB_EP_HOST_IN and if in device mode the u Flags parameter should be either USB_EP_DEV_OUT or USB_EP_DEV_IN Returns None 24 3 2 23 USBFlFOConfigSet Sets the FIFO configuration for an endpoint 370 January 11 2011 USB Controller Prototype void USBFIFOConfigSet unsigned long ulBase unsigned long ulEndpoint unsigned long ulFIFOAddress unsigned long ulFIFOSize unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulFlFOAddress is the starting address for the FIFO ulFIFOSize is the size of the FIFO in bytes ulFlags specifies what information to set in the FIFO configuration Description This function will set the starting FIFO RAM address and size of the FIFO for a given end point Endpoint zero does not have a dynamically configurable FIFO so this function should not be called for endpoint zero The ulFIFOSize parameter should be one of the values in the USB_FIFO_SZ_ values If the endpoint is going to use double buffering it should use the values with the
31. EPI_FIFO_CONFIG_TX_1_2 or EPI_FIFO_CONFIG_TX_3_4 to set the TX FIFO trigger level to empty 1 4 1 2 or 3 4 level EPI_FIFO_CONFIG_RX_1_ 8 EPI FIFO_CONFIG_RX_1_4 EPI_FIFO_CONFIG_RX_1_ 2 EPI_FIFO_CONFIG_RX_3_4 EPI_FIFO_CONFIG_RX_7_8 or EPI_FIFO_CONFIG_RX_FULL to set the RX FIFO trigger level to 1 8 1 4 1 2 3 4 7 8 or full level Returns None 7 2 2 8 EPllntDisable Disables EPI interrupt sources Prototype void EPIIntDisable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the EPI module base address ullntFlags is a bit mask of the interrupt sources to be disabled Description This function disables the specified EPI sources for interrupt generation The ulintFlags param eter can be the logical OR of any of the following values EPI_INT_RXREQ EPI_INT_TXREQ or 12S_INT_ERR Returns Returns None 7 2 2 9 EPI lIntEnable Enables EPI interrupt sources Prototype void EPIIntEnable unsigned long ulBase unsigned long ullIntFlags January 11 2011 93 External Peripheral Interface EPI 7 2 2 10 7 2 2 11 94 Parameters ulBase is the EPI module base address ullntFlags is a bit mask of the interrupt sources to be enabled Description This function enables the specified EPI sources to generate interrupts The ullntFlags param eter can be the logical OR of any of the following values EPI_INT_TXREQ transmit FIFO is below the trigger level
32. MSG_OBJ_TYPE_RX 2 amp sMsgObjectRx MSG_OBJ_TYPE_RX 3 amp SMsgObjectRx MSG_OBJ_TYPE_RX not have the MSG_OBJ_FIFO set to indicate that this is the last message sMsgObjectRx CANMessageSet CANO_BASE ils Configure ulFlags MSG_OBJ_USE_ID_FILTER 4 amp sMsgObjectRx MSG_OBJ_TYPE_RX and start transmit of message object sMsgObjectTx ulMsgID 0x400 sMsgObjectTx ulFlags 0 sMsgObjectTx ulMsgLen 8 sMsgObjectTx pucMsgData ucBufferOut CANMessageSet CANO_BASE 2 amp sMsgObjectTx MSG_OBJ_TYPE_TX Wait for new data to become available while CANStatusGet CAN1_BASE CAN_STS_NEWDAT amp 1 0 Read the message out of the message object CANMessageGet CAN1_BASE 1 amp sMsgObjectRx true Process new data in sMsgObjectRx pucMsgData This example code will configure a set of CAN message objects in FIFO mode using CAN controller 0 tCANBitClkParms CANBitClk tCANMsgObject sMsgObjectRx unsigned char ucBufferIn 8 unsigned char ucBufferOut 8 Reset the state of all the message objects and the state of the CAN module to a known state CANInit CANO_BASE Configure the controller for 1 Mbit operation Ld CANBitRateSet CANO_BASE 8000000 1000000 Take the CANO device out of INIT state 66 January 11 2011 Controller Area Network CAN CANEnable CANO_BASE Confi
33. PHAO PHBO IDX0 PHA1 PHB1 or IDX1 See also GPIOPinTypeQE in order to configure multiple QEI pins at once Returns None PinTypeSSl Configures the specified SSI pin to function as an SSI pin Prototype void PinTypeSSI unsigned long ulName Parameters ulName is one of the valid names for the SSI pins Description This function takes one of the valid names for an SSI pin and configures the pin for its SSI functionality depending on the part that is defined The valid names for the pins are as follows SSIOCLK SSIOFSS SSIORX SSIOTX SSI1CLK SSI1FSS SSI1RX or SSI1TX See also GPIOPinTypeSSl in order to configure multiple SSI pins at once Returns None PinType Timer Configures the specified Timer pin to function as a Timer pin January 11 2011 211 Peripheral Pin Mapping Prototype void PinTypeTimer unsigned long ulName Parameters ulName is one of the valid names for the Timer pins Description This function takes one of the valid names for a Timer pin and configures the pin for its Timer functionality depending on the part that is defined The valid names for the pins are as follows CCP0 CCP1 CCP2 CCP3 CCP4 CCP5 CCP6 or CCP7 See also GPIOPinTypeTimer in order to configure multiple CCP pins at once Returns None 15 2 2 10 PinTypeUART 15 2 2 11 212 Configures the specified UART pin to function as a UART pin Prototype void PinTypeUART un
34. Parameters ulBase is the base address of the watchdog timer module Description Enables the capability of the watchdog timer to issue a reset to the processor upon a second timeout condition Note This function will have no effect if the watchdog timer has been locked See also WatchdogLock WatchdogUnlock Returns None 25 2 2 13 WatchdogRunning Determines if the watchdog timer is enabled Prototype tBoolean WatchdogRunning unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module January 11 2011 399 Watchdog Timer Description This will check to see if the watchdog timer is enabled Returns Returns true if the watchdog timer is enabled and false if it is not 25 2 2 14 WatchdogStallDisable Disables stalling of the watchdog timer during debug events Prototype void WatchdogStallDisable unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description This function disables the debug mode stall of the watchdog timer By doing so the watchdog timer continues to count regardless of the processor debug state Returns None 25 2 2 15 WatchdogStallEnable Enables stalling of the watchdog timer during debug events Prototype void WatchdogStallEnable unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description This function allows the watchdog timer to
35. Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access Description This function acknowledges that the data was read from the endpoint s FIFO This call is used if processing is required between reading the data and acknowledging that the data has been read Note This function should only be called in host mode Returns None 24 3 2 30 USBHostEndpointDataToggle Sets the value data toggle on an endpoint in host mode Prototype void USBHostEndpointDataToggle unsigned long ulBase unsigned long ulEndpoint tBoolean bDataToggle unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint specifies the endpoint to reset the data toggle bDataToggle specifies whether to set the state to DATAO or DATA1 ulFlags specifies whether to set the IN or OUT endpoint Description This function is used to force the state of the data toggle in host mode If the value passed in the bDataToggle parameter is false then the data toggle will be set to the DATAO state and if it is true it will be set to the DATA1 state The u Flags parameter can be USB_EP_HOST_IN or USB_EP_HOST_OUT to access the desired portion of this endpoint The u Flags parameter is ignored for endpoint zero Note This function should only be called in host mode Returns None January 11 2011 375 USB Controller 24 3 2 31 USBHostEndpointStatusClear Clears the sta
36. See also GPIOPinTypeADC in order to configure multiple ADC pins at once Returns None 15 2 2 3 PinTypeCAN Configures the specified CAN pin to function as a CAN pin Prototype void PinTypeCAN unsigned long ulName Parameters ulName is one of the valid names for the CAN pins Description This function takes one of the valid names for a CAN pin and configures the pin for its CAN functionality depending on the part that is defined The valid names for the pins are as follows CANORX CANOTX CAN1RX CAN1TX CAN2RX or CAN2TX See also GPIOPinTypeCAN in order to configure multiple CAN pins at once Returns None 15 2 2 4 PinTypeComparator Configures the specified comparator pin to function as a comparator pin Prototype void PinTypeComparator unsigned long ulName Parameters ulName is one of the valid names for the Comparator pins Description This function takes one of the valid names for a comparator pin and configures the pin for its comparator functionality depending on the part that is defined The valid names for the pins are as follows CO_MINUS CO_PLUS C1_MINUS C1_PLUS C2_MINUS or C2_PLUS See also GPIOPinTypeComparator in order to configure multiple comparator pins at once January 11 2011 209 Peripheral Pin Mapping 15 2 2 5 15 2 2 6 210 Returns None PinTypel2C Configures the specified 12C pin to function as an 12C pin Prototype void PinTyp
37. Since the flash is programmed one word at a time the starting address and byte count must both be multiples of four It is up to the caller to verify the programmed contents if such verification is required January 11 2011 107 Flash 8 2 2 9 8 2 2 10 8 2 2 11 108 This function will not return until the data has been programmed Returns Returns 0 on success or 1 if a programming error is encountered FlashProtectGet Gets the protection setting for a block of flash Prototype tFlashProtection FlashProtectGet unsigned long ulAddress Parameters ulAddress is the start address of the flash block to be queried Description This function will get the current protection for the specified 2 kB block of flash Each block can be read write read only or execute only Read write blocks can be read executed erased and programmed Read only blocks can be read and executed Execute only blocks can only be executed processor and debugger data reads are not allowed Returns Returns the protection setting for this block See FlashProtectSet for possible values FlashProtectSave Saves the flash protection settings Prototype long FlashProtectSave void Description This function will make the currently programmed flash protection settings permanent This is a non reversible operation a chip reset or power cycle will not change the flash protection This function will not return until the protection
38. This function should only be called in host mode Returns None USBHostRequestStatus Issues a request for a status IN transaction on endpoint zero Prototype void USBHostRequestStatus unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function is used to cause a request for an status IN transaction from a device on endpoint zero This function can only be used with endpoint zero as that is the only control endpoint that supports this ability This is used to complete the last phase of a control transaction to a device and an interrupt will be signaled when the status packet has been received Returns None 24 3 2 42 USBHostReset Handles the USB bus reset condition Prototype void USBHostReset unsigned long ulBase tBoolean bStart Parameters ulBase specifies the USB module base address bStart specifies whether to start or stop signaling reset on the USB bus Description When this function is called with the bStart parameter set to true this function will cause the start of a reset condition on the USB bus The caller should then delay at least 20ms before calling this function again with the bStart parameter set to false January 11 2011 381 USB Controller Note This function should only be called in host mode Returns None 24 3 2 43 USBHostResume Handles the USB bus resume condition Prototype void USBHostResume unsigned long u
39. This function will set the configuration of the ADC for one step of a sample sequence The ADC can be configured for single ended or differential operation the ADC_CTL_D bit selects differential operation when set the channel to be sampled can be chosen the ADC_CTL_CHO January 11 2011 4 2 2 27 4 2 2 28 Analog to Digital Converter ADC through ADC_CTL_CH15 values and the internal temperature sensor can be selected the ADC_CTL_TS bit Additionally this step can be defined as the last in the sequence the ADC_CTL_END bit and it can be configured to cause an interrupt when the step is complete the ADC_CTL_IE bit If the digital comparators are present on the device this step may also be configured send the ADC sample to the selected comparator the ADC_CTL_CMP0O through ADC_CTL_CMP7 values by using the ADC_CTL_CE bit The configuration is used by the ADC at the appropriate time when the trigger for this sequence occurs Note If the Digitial Comparator is present and enabled using the ADC_CTL_CE bit the ADC sample will NOT be written into the ADC sequence data FIFO The u Step parameter determines the order in which the samples are captured by the ADC when the trigger occurs It can range from zero to seven for the first sample sequence from zero to three for the second and third sample sequence and can only be zero for the fourth sample sequence Differential mode only works with adjacent channel pairs for example O and
40. This interrupt indicates that a transaction on the management interface has completed successfully ETH_INT_RXER This interrupt indicates that an error has occurred during reception of a frame This error can indicate a length mismatch a CRC failure or an error indication from the PHY ETH_INT_RXOF This interrupt indicates that a frame has been received that exceeds the available space in the RX FIFO ETH_INT_TX This interrupt indicates that the packet stored in the TX FIFO has been successfully transmitted ETH_INT_TXER This interrupt indicates that an error has occurred during the transmis sion of a packet This error can be either a retry failure during the back off process or an invalid length stored in the TX FIFO ETH_INT_RX This interrupt indicates that one or more packets are available in the RX FIFO for processing Returns None 6 2 2 9 EthernetIntRegister Registers an interrupt handler for an Ethernet interrupt Prototype void EthernetIntRegister unsigned long ulBase void pfnHandler void Parameters ulBase is the base address of the controller pfnHandler is a pointer to the function to be called when the enabled Ethernet interrupts occur Description This function sets the handler to be called when the Ethernet interrupt occurs This will enable the global interrupt in the interrupt controller specific Ethernet interrupts must be enabled via EthernetIntEnable It is the
41. Valid sample sequences range from zero to three sequence zero will capture up to eight samples sequences one and two will capture up to four samples and sequence three will capture a single sample The trigger condition and priority with respect to other sample sequence execution is set The ulTrigger parameter can take on the following values ADC_TRIGGER_PROCESSOR A trigger generated by the processor via the ADCPro cessor Trigger function ADC_TRIGGER_COMPO0 A trigger generated by the first analog comparator configured with ComparatorConfigure ADC_TRIGGER_COMP1 A trigger generated by the second analog comparator config ured with ComparatorConfigure ADC_TRIGGER_COMP2 A trigger generated by the third analog comparator configured with ComparatorConfigure ADC_TRIGGER_EXTERNAL A trigger generated by an input from the Port B4 pin ADC_TRIGGER_TIMER A trigger generated by a timer configured with TimerCon trolTrigger 33 Analog to Digital Converter ADC 4 2 2 21 4 2 2 22 34 ADC_TRIGGER_PWM0 A trigger generated by the first PWM generator configured with PWMGenIntTrigEnable ADC_TRIGGER_PWM1 A trigger generated by the second PWM generator configured with PWMGenlIntTrigEnable ADC_TRIGGER_PWN2 A trigger generated by the third PWM generator configured with PWMGenIntTrigEnable ADC_TRIGGER_PWNMS3 A trigger generated by the fourth PWM generator configured wi
42. WatchdogReloadSet WATCHDOGO_BASE OxFEEFEE Lf Enable the reset WatchdogResetEnable WATCHDOGO_BASE January 11 2011 401 Watchdog Timer Enable the watchdog timer WatchdogEnable WATCHDOGO_BASE Wait for the reset to occur while 1l 402 January 11 2011 26 26 1 26 2 Using the ROM Using the ROM MOUCINA 403 Drect R MECS codis aa a aaar AS anita pabweeid hee 403 Mapped ROCA copas E E EE 404 Firmware Updale icinnisccareriniseenemmnermpihes Eae AAA E EEA E 405 Introduction Stellaris DustDevil class devices have portions of the peripheral driver library stored in an on chip ROM By utilizing the code in the on chip ROM more flash is available for use by the application The boot loader is also contained within the ROM which can be called by an application in order to start a firmware update Direct ROM Calls In order to call the ROM the following steps must be performed m The device on which the application will be run must be defined This is done by defining a preprocessor symbol which can be done either within the source code or in the project that builds the application The later is more flexible if code is shared between projects m driverlib rom h is included by the source code desiring to call the ROM The ROM version of a peripheral driver library function is called For example if GPIODirMod eSet is to be called in the ROM ROM_GPIODirModeSet
43. l c pate eee ee et ee eee kere rears et eet e P EEE SA E ern er ree cee ene nt S TAT 237 APIPUMCIONS chceucc dad veserenietwet Ear aaa rk 238 Pregramimmg Example eearri a A EE E A 246 17 1 Introduction The quadrature encoder API provides a set of functions for dealing with the Quadrature Encoder with Index QEI Functions are provided to configure and read the position and velocity captures register a QEI interrupt handler and handle QEI interrupt masking clearing The quadrature encoder module provides hardware encoding of the two channels and the index signal from a quadrature encoder device into an absolute or relative position There is additional hardware for capturing a measure of the encoder velocity which is simply a count of encoder pulses during a fixed time period the number of pulses is directly proportional to the encoder speed Note that the velocity capture can only operate when the position capture is enabled The QEI module supports two modes of operation phase mode and clock direction mode In phase mode the encoder produces two clocks that are 90 degrees out of phase the edge relationship is used to determine the direction of rotation In clock direction mode the encoder produces a clock signal to indicate steps and a direction signal to indicate the direction of rotation When in phase mode edges on the first channel or edges on both channels can be counted counting edges on both channels provides higher encoder reso
44. respectively The peripheral clock will be the same as the processor clock This will be the value returned by SysCtlClockGet or it can be explicitly hard coded if it is constant and known to save the code execution overhead of a call to SysCtlClockGei This function replaces the original UARTConfigSet API and performs the same actions A macro is provided in uart h to map the original API to this API Returns None 22 2 2 10 UARTDisable Disables transmitting and receiving Prototype void UARTDisable unsigned long ulBase Parameters ulBase is the base address of the UART port Description Clears the UARTEN TXE and RXE bits then waits for the end of transmission of the current character and flushes the transmit FIFO Returns None 22 2 2 11 UARTDisableSIR Disables SIR IrDA mode on the specified UART January 11 2011 313 UART Prototype void UARTDisableSIR unsigned long ulBase Parameters ulBase is the base address of the UART port Description Clears the SIREN IrDA and SIRLP Low Power bits Note SIR IrDA operation is not supported on Sandstorm class devices Returns None 22 2 2 12 UARTDMADisable Disable UART DMA operation Prototype void UARTDMADisable unsigned long ulBase unsigned long ulDMAFlags Parameters ulBase is the base address of the UART port ulDMAFlags is a bit mask of the DMA features to disable Description This functio
45. ucSourceBuffer ucDestBuffer sizeof ucDestBuffer Finally the channel must be enabled Since this is a software initiated transfer a request must also be made This will start the transfer running uDMAChannelEnable UDMA_CHANNEL_SW uDMAChannelRequest UDMA_CHANNEL_SW January 11 2011 349 uDMA Controller 350 January 11 2011 24 24 1 24 2 USB Controller USB Controller Mi aeai Me a A ett EAEI TE E A E TT PO ncaa bt tots due T TAS AS EA S TTAN 351 Using UDMA wiih USE niies aa a D Ea EA ESR 351 HP POUMGUONS corsini aaO OR O E EE RA 355 Programming Example vicciineseximiahenterneneagr tanner r An R Oa EPE ETRE 391 Introduction The USB APIs provide a set of functions that are used to access the Stellaris USB device or host controllers The APIs are split into groups according to the functionality provided by the USB controller present in the microcontroller Because of this the driver has to handle microcontrollers that have only a USB device interface a host and or device interface or microcontrollers that have an OTG interface The groups are the following USBDev USBHost USBOTG USBEndpoint and USBFIFO The APIs in the USBDev group are only used with microcontrollers that have a USB device controller The APIs in the USBHost group can only be used with microcontrollers that have a USB host controller The USBOTG APIs are used by microcontrollers with an OTG interface With USB OTG
46. ulSequenceNum is the sample sequence number Description This function enables the requested sample sequence interrupt Any outstanding interrupts are cleared before enabling the sample sequence interrupt Returns None ADClIntRegister Registers an interrupt handler for an ADC interrupt Prototype void ADCIntRegister unsigned long ulBase unsigned long ulSequenceNum void pfnHandler void Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number pfnHandler is a pointer to the function to be called when the ADC sample sequence interrupt occurs Description This function sets the handler to be called when a sample sequence interrupt occurs This will enable the global interrupt in the interrupt controller the sequence interrupt must be enabled with ADCIntEnable It is the interrupt handler s responsibility to clear the interrupt source via ADCiIntClear See also IntRegister for important information about registering interrupt handlers Returns None ADClntStatus Gets the current interrupt status Prototype unsigned long ADCIntStatus unsigned long ulBase January 11 2011 29 Analog to Digital Converter ADC 4 2 2 14 4 2 2 15 30 unsigned long ulSequenceNum tBoolean bMasked Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number bMasked is false if the raw interrupt
47. unsigned char pucBuf long BufLen long EthernetPacketGetNonBlocking unsigned long ulBase unsigned char pucBuf long IBu fLen long EthernetPacketPut unsigned long ulBase unsigned char pucBuf long IBufLen long EthernetPacketPutNonBlocking unsigned long ulBase unsigned char xpucBuf long IBu fLen void EthernetPHYPowerOff unsigned long ulBase January 11 2011 69 Ethernet Controller 6 2 1 70 m void EthernetPHYPowerOn unsigned long ulBase m unsigned long EthernetPHY Read unsigned long ulBase unsigned char ucRegAdadr m void EthernetPHYWrite unsigned long ulBase unsigned char ucRegAddr unsigned long ul Data tBoolean EthernetSpaceAvail unsigned long ulBase Detailed Description For any application the EthernetInitExpClk function must be called first to prepare the Ethernet controller for operation This function will configure the Ethernet controller options that are based on system parameters such as the system clock speed Once initialized access to the PHY is available via the EthernetPHYRead and EthernetPHY Write functions By default the PHY will auto negotiate the line speed and duplex modes For most applications this will be sufficient If a special configuration is required the PHY read and write functions can be used to reconfigure the PHY to the desired mode of operation The MAC must also be configured using the EthernetConfigSet function The parameters for this funct
48. unsigned char ucData Parameters ulBase is the base address of the I2C Master module ucData data to be transmitted from the 12C Master Description This function will place the supplied data into 12C Master Data Register Returns None I2CMasterDisable Disables the 12C master block Prototype void I2CMasterDisable unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This will disable operation of the 12C master block Returns None January 11 2011 Inter Integrated Circuit 12C 11 2 2 9 l2CMasterEnable Enables the I2C Master block Prototype void I2CMasterEnable unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This will enable operation of the 12C Master block Returns None 11 2 2 10 12CMasterErr Gets the error status of the 12C Master module Prototype unsigned long I2CMasterErr unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This function is used to obtain the error status of the Master module send and receive opera tions Returns Returns the error status as one of I2C_MASTER_ERR_NONE I2C_MASTER_ERR_ADDR_ACK I2C_MASTER_ERR_DATA_ACK or 12C_MASTER_ERR_ARB LOST 11 2 2 11 l2CMasterInitExpClk Initializes the 12C Master block Prototype void I2CMasterInitExpClk unsigned long ulBase unsigne
49. 12C 11 2 2 28 2CSlavelntStatus Gets the current 12C Slave interrupt status Prototype tBoolean I2CSlaveIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the base address of the 12C Slave module bMasked is false if the raw interrupt status is requested and true if the masked interrupt status is requested Description This returns the interrupt status for the 12C Slave module Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned Returns The current interrupt status returned as true if active or false if not active 11 2 2 29 2CSlavelntStatusEx Gets the current 12C Slave interrupt status Prototype unsigned long T2CSlaveIntStatusEx unsigned long ulBase tBoolean bMasked Parameters ulBase is the base address of the 12C Slave module bMasked is false if the raw interrupt status is requested and true if the masked interrupt status is requested Description This returns the interrupt status for the 12C Slave module Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned Returns Returns the current interrupt status enumerated as a bit field of values described in I2CSlavelntEnableEx 11 2 2 30 2CSlaveStatus Gets the 12C Slave module status Prototype unsigned long I2CSlaveStatus unsigned long ulBase January 11 2011 167 In
50. 2 3 22 2 2 4 310 Description Allows the caller to determine whether all transmitted bytes have cleared the transmitter hard ware If false is returned the transmit FIFO is empty and all bits of the last transmitted char acter including all stop bits have left the hardware shift register Returns Returns true if the UART is transmitting or false if all transmissions are complete UARTCharGet Waits for a character from the specified port Prototype long UARTCharGet unsigned long ulBase Parameters ulBase is the base address of the UART port Description Gets a character from the receive FIFO for the specified port If there are no characters avail able this function waits until a character is received before returning Returns Returns the character read from the specified port cast as a ong UARTCharGetNonBlocking Receives a character from the specified port Prototype long UARTCharGetNonBlocking unsigned long ulBase Parameters ulBase is the base address of the UART port Description Gets a character from the receive FIFO for the specified port This function replaces the original UARTCharNonBlockingGet API and performs the same actions A macro is provided in uart h to map the original API to this API Returns Returns the character read from the specified port cast as a long A 1 is returned if there are no characters present in the receive FIFO The UARTCharsAvail function sho
51. 25 UARTIntRegister Registers an interrupt handler for a UART interrupt Prototype void UARTIntRegister unsigned long ulBase void x pfnHandler void Parameters ulBase is the base address of the UART port pfnHandler is a pointer to the function to be called when the UART interrupt occurs Description This function does the actual registering of the interrupt handler This will enable the global interrupt in the interrupt controller specific UART interrupts must be enabled via UARTIntEn able It is the interrupt handler s responsibility to clear the interrupt source See also IntRegister for important information about registering interrupt handlers Returns None 320 January 11 2011 UART 22 2 2 26 UARTIntStatus Gets the current interrupt status Prototype unsigned long UARTIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the base address of the UART port bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required Description This returns the interrupt status for the specified UART Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned Returns Returns the current interrupt status enumerated as a bit field of values described in UARTIn tEnable 22 2 2 27 UARTIntUnregister Unregisters an interrupt handler for a UART interrupt Prototype
52. Description This function gets the match value for the specified timer Returns Returns the match value for the timer 21 2 2 18 TimerMatchSet Sets the timer match value Prototype void TimerMatchSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue Parameters ulBase is the base address of the timer module ulTimer specifies the timer s to adjust must be one of TIMER_A TIMER_B or TIMER_BOTH Only TIMER_A should be used when the timer is configured for 32 bit operation ulValue is the match value Description This function sets the match value for a timer This is used in capture count mode to determine when to interrupt the processor and in PWM mode to determine the duty cycle of the output signal Returns None 21 2 2 19 TimerPrescaleGet Get the timer prescale value January 11 2011 301 Timer Prototype unsigned long TimerPrescaleGet unsigned long ulBase unsigned long ulTimer Parameters ulBase is the base address of the timer module ulTimer specifies the timer must be one of TIMER_A or TIMER _B Description This function gets the value of the input clock prescaler The prescaler is only operational when in 16 bit mode and is used to extend the range of the 16 bit timer modes Returns The value of the timer prescaler 21 2 2 20 TimerPrescaleMatchGet 21 2 2 21 302 Get the timer prescale match value Prototype unsigned long TimerPrescaleMa
53. FLASH_INT_ACCESS values Description Enables the indicated flash controller interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor Returns None FlashIntRegister Registers an interrupt handler for the flash interrupt Prototype void FlashIntRegister void xpfnHandler void Parameters pfnHandler is a pointer to the function to be called when the flash interrupt occurs Description This sets the handler to be called when the flash interrupt occurs The flash controller can generate an interrupt when an invalid flash access occurs such as trying to program or erase a read only block or trying to read from an execute only block It can also generate an interrupt when a program or erase operation has completed The interrupt will be automatically enabled when the handler is registered See also IntRegister for important information about registering interrupt handlers Returns None FlashIntStatus Gets the current interrupt status Prototype unsigned long FlashIntStatus tBoolean bMasked Parameters bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required January 11 2011 Flash Description This returns the interrupt status for the flash controller Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor
54. GPIOPortIntRegister and GPIO PortIntUnregister The GPIO pin state is accessed with GPIOPinRead and GPIOPinWrite Function Documentation GPI IODirModeGet Gets the direction and mode of a pin Prototype unsigned long GPIODirModeGet unsigned long ulPort unsigned char ucPin Parameters ulPort is the base address of the GPIO port ucPin is the pin number Description This function gets the direction and control mode for a specified pin on the selected GPIO port The pin can be configured as either an input or output under software control or it can be under hardware control The type of control and direction are returned as an enumerated data type Returns Returns one of the enumerated data types described for GPIODirModeSet GPI IODirModeSet Sets the direction and mode of the specified pin s Prototype void GPIODirModeSet unsigned long ulPort unsigned char ucPins unsigned long ulPinI0O Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s ulPinlO is the pin direction and or mode January 11 2011 115 GPIO 9 2 2 3 9 2 2 4 Description This function will set the specified pin s on the selected GPIO port as either an input or output under software control or it will set the pin to be under hardware control The parameter u Pin O is an enumerated data type that can be one of the following values GPIO_DIR_M
55. I2CSlaveEnable unsigned long ulBase void I2CSlavelnit unsigned long ulBase unsigned char ucSlaveAddr void I2CSlavelntClear unsigned long ulBase void I2CSlavelntClearEx unsigned long ulBase unsigned long ullntFlags void I2CSlavelntDisable unsigned long ulBase void I2CSlavelntDisableEx unsigned long ulBase unsigned long ullntFlags void I2CSlavelntEnable unsigned long ulBase void I2CSlavelntEnableEx unsigned long ulBase unsigned long ullntFlags tBoolean I2CSlavelntStatus unsigned long ulBase tBoolean bMasked unsigned long 2CSlavelntStatusEx unsigned long ulBase tBoolean bMasked unsigned long 2CSlaveStatus unsigned long ulBase 11 2 1 Detailed Description The 12C API is broken into three groups of functions those that deal with interrupts those that handle status and initialization and those that deal with sending and receiving data The I2C master and slave interrupts are handled by the I2ClIntRegister 2ClntUnregister I2CMasterIntEnable 2CMasterIntDisable 2CMasterlIntClear 2CMasterlntStatus Aa SC CSO I2CSlavelntEnable I2CSlavelntDisable I2CSlavelntClear I2CSlavelntStatus I2CSlavelntEnableEx I2CSlavelntDisableEx 12CSlavelntClearEx and I2CSlavelntStatusEx functions Status and initialization functions for the lI2C modules are 2CMasterlnitExpClk I2CMasterEnable 12CMasterDisable 2CMasterBusBusy 12CMasterBusy 2CMasterErr I2CSlavelnit 2CSlaveEn
56. IntPriorityMaskSet unsigned long ulPriorityMask void IntPrioritySet unsigned long ullnterrupt unsigned char ucPriority void IntRegister unsigned long ullnterrupt void pfnHandler void void IntUnregister unsigned long ullnterrupt Detailed Description The primary function of the interrupt controller API is to manage the interrupt vector table used by the NVIC to dispatch interrupt requests Registering an interrupt handler is a simple matter of inserting the handler address into the table By default the table is filled with pointers to an internal handler that loops forever it is an error for an interrupt to occur when there is no interrupt han dler registered to process it Therefore interrupt sources should not be enabled before a handler has been registered and interrupt sources should be disabled before a handler is unregistered Interrupt handlers are managed with IntRegister and IntUnregister Each interrupt source can be individually enabled and disabled via IntEnable and IntDisable The processor interrupt can be enabled and disabled via IntMasterEnable and IntMasterDisable this does not affect the individual interrupt enable states Masking of the processor interrupt can be utilized as a simple critical section only NMI will interrupt the processor while the processor interrupt is disabled though this will have adverse effects on the interrupt response time The priority of each interrupt source can be set
57. None 25 2 2 10 WatchdogReloadSet 25 2 2 11 398 Sets the watchdog timer reload value Prototype void WatchdogReloadSet unsigned long ulBase unsigned long ulLoadVal Parameters ulBase is the base address of the watchdog timer module ulLoadvVal is the load value for the watchdog timer Description This function sets the value to load into the watchdog timer when the count reaches zero for the first time if the watchdog timer is running when this function is called then the value will be immediately loaded into the watchdog timer counter If the ulLoadVal parameter is 0 then an interrupt is immediately generated Note This function will have no effect if the watchdog timer has been locked See also WatchdogLock WatchdogUnlock WatchdogReloadGet Returns None WatchdogResetDisable Disables the watchdog timer reset Prototype void WatchdogResetDisable unsigned long ulBase January 11 2011 Watchdog Timer Parameters ulBase is the base address of the watchdog timer module Description Disables the capability of the watchdog timer to issue a reset to the processor upon a second timeout condition Note This function will have no effect if the watchdog timer has been locked See also WatchdogLock WatchdogUnlock Returns None 25 2 2 12 WatchdogResetEnable Enables the watchdog timer reset Prototype void WatchdogResetEnable unsigned long ulBase
58. PWM_FAULT_FAULT1 PWM_FAULT_FAULT2 or PWM_FAULT_FAULTS For PWM_FAULT_GROUP_1 this will be the logi cal OR of PWM_FAULT_DCMP0O PWM_FAULT_DCMP1 PWM_FAULT_DCMP2 PWM_FAULT_DCMP3 PWM_FAULT_DCMP4 PWM_FAULT_DCMP5 PWM_FAULT_DCMP6 or PWM_FAULT_DCMP7 Description This function allows selection of the set of fault inputs that will be combined to generate a fault condition to a given PWM generator By default all generators use only FAULTO for backwards compatibility but if PWMGenConfigure is called with flag PWM_GEN_MODE_FAULT_SRC in the ulConfig parameter extended fault handling is enabled and this function must be called to configure the fault triggers The fault signal to the PWM generator is generated by ORing together each of the signals whose inputs are specified in the u FaultTriggers parameter after having adjusted the sense of each FAULTn input based on the configuration previously set using a call to PWMGenFault Configure Note This function is only available on devices supporting extended PWM fault handling Returns None 16 2 2 15 PWMGenIntClear Clears the specified interrupt s for the specified PWM generator block Prototype void PWMGenIntClear unsigned long ulBase unsigned long ulGen unsigned long ulInts Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to query Must be one of PWM_GEN_0O PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 ullnts specifies
59. Stellaris part and UART in use Please consult the datasheet for the part you are using to determine whether this support is available Returns None 22 2 2 22 UARTIntClear 318 Clears UART interrupt sources Prototype void UARTIntClear unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base address of the UART port January 11 2011 UART ullntFlags is a bit mask of the interrupt sources to be cleared Description The specified UART interrupt sources are cleared so that they no longer assert This func tion must be called in the interrupt handler to keep the interrupt from being recognized again immediately upon exit The ullntFlags parameter has the same definition as the ullntFlags parameter to UARTIntEn able Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None 22 2 2 23 UARTIntDisable Disables individual UART interrupt sources Prototype void UARTIntDisable unsigned long ulBase unsign
60. This function will ensure that the interrupt handler specified by pfnintHandler is called when an interrupt is detected for the specified PWM generator block This function will also en able the corresponding PWM generator interrupt in the interrupt controller individual generator interrupts and interrupt sources must be enabled with PWMlIntEnable and PWMGenIntTri gEnable See also IntRegister for important information about registering interrupt handlers Returns None 16 2 2 17 PWMGenIntStatus Gets interrupt status for the specified PWM generator block Prototype unsigned long PWMGenIntStatus unsigned long ul unsigned long ul Base Gen tBoolean bMasked Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to query Must be one of PWM_GEN_0O PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 January 11 2011 227 Pulse Width Modulator PWM bMasked specifies whether masked or raw interrupt status is returned Description If bDMasked is set as true then the masked interrupt status is returned otherwise the raw interrupt status will be returned Returns Returns the contents of the interrupt status register or the contents of the raw interrupt status register for the specified PWM generator 16 2 2 18 PWMGenIntTrigDisable Disables interrupts for the specified PWM generator block Prototype void PWMGenIntTrigDisable unsigned long ulBase unsi
61. _DB at the end of the value For example use USB_FIFO_SZ_16_DB to con figure an endpoint to have a 16 byte double buffered FIFO If a double buffered FIFO is used then the actual size of the FIFO will be twice the size indicated by the u FiFOSize parameter This means that the USB_FIFO_SZ_16_DB value will use 32 bytes of the USB controller s FIFO memory The ulFIFOAddress value should be a multiple of 8 bytes and directly indicates the start ing address in the USB controllers FIFO RAM For example a value of 64 indicates that the FIFO should start 64 bytes into the USB controller s FIFO memory The u Flags value specifies whether the endpoints OUT or IN FIFO should be configured If in host mode use USB_EP_HOST_OUT or USB_EP_HOST_IN and if in device mode use USB_EP_DEV_OUT or USB_EP_DEV_IN Returns None 24 3 2 24 USBFIFOFlush Forces a flush of an endpoint s FIFO Prototype void USBFIFOFlush unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulFlags specifies if the IN or OUT endpoint should be accessed January 11 2011 371 USB Controller Description This function will force the controller to flush out the data in the FIFO The function can be called with either host or device controllers and requires the u Flags parameter be one of USB_EP_HOST_OUT USB_EP_HOST_IN USB_EP_DEV_OUT or USB_EP_DE
62. action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted January 11 2011 16 2 2 4 16 2 2 5 Pulse Width Modulator PWM Returns None PWMFaultIntClearExt Clears the fault interrupt for a PWM module Prototype void PWMFaultIntClearExt unsigned long ulBase unsigned long ulFaultInts Parameters ulBase is the base address of the PWM module ulFaultints specifies the fault interrupts to clear Description Clears one or more fault interrupts by writing to the appropriate bit of the PWM interrupt status register The parameter u Faultints must be the logical OR of any of PWM_INT_FAULTO PWM_INT_FAULT1 PWM_INT_FAULT2 or PWM_INT_FAULT3 When running on a device supporting extended PWM fault handling the fault interrupts are derived by performing a logical OR of each of the configured fault trigger signals for a given generator Therefore these interrupts are not directly related to the four possible FAULTn inputs to the device but indicate that a fault has been signaled to one of the four possible PWM generators On a device without extended PWM fault handling the interrupt is directly related to the state of the single FAULT pin Note Because there is a write buffer in the Cortex M3 processor it may take seve
63. after the successful initialization of the I2C master module Data is transferred by first setting the slave address using 2CMasterSlaveAddrSet That function is also used to define whether the transfer is a send a write to the slave from the master or a receive a read from the slave by the master Then if connected to an 12C bus that has multiple masters the Stellaris 12C master must first call 2CMasterBusBusy before attempting to initiate the desired transaction After determining that the bus is not busy if trying to send data the user must call the 2CMasterDataPut function The transaction can then be initiated on the bus by calling the I2CMasterControl function with any of the following commands 12C_MASTER_CMD_SINGLE_SEND 12C_MASTER_CMD_SINGLE_RECEIVE 12C_ MASTER_CMD_BURST_SEND_START 12C_ MASTER_CMD_BURST_RECEIVE_START Any of those commands will result in the master arbitrating for the bus driving the start sequence onto the bus and sending the slave address and direction bit across the bus The remainder of the transaction can then be driven using either a polling or interrupt driven method For the single send and receive cases the polling method will involve looping on the return from 2CMasterBusy Once that function indicates that the 12C master is no longer busy the bus trans action has been completed and can be checked for errors using 12CMasterErr If there are no January 11 2011 153 Inter Int
64. and examined via IntPrioritySet and IntPriori tyGet The priority assignments are defined by the hardware the upper N bits of the 8 bit priority are examined to determine the priority of an interrupt for the Stellaris family N is 3 This allows January 11 2011 13 2 2 13 2 2 1 13 2 2 2 13 2 2 3 Interrupt Controller NVIC priorities to be defined without a real need to know the exact number of supported priorities moving to a device with more or fewer priority bits will continue to treat the interrupt source with a similar level of priority Smaller priority numbers correspond to higher interrupt priority so 0 is the highest priority Function Documentation IntDisable Disables an interrupt Prototype void IntDisable unsigned long ulInterrupt Parameters ullnterrupt specifies the interrupt to be disabled Description The specified interrupt is disabled in the interrupt controller Other enables for the interrupt such as at the peripheral level are unaffected by this function Returns None IntEnable Enables an interrupt Prototype void IntEnable unsigned long ulInterrupt Parameters ullnterrupt specifies the interrupt to be enabled Description The specified interrupt is enabled in the interrupt controller Other enables for the interrupt such as at the peripheral level are unaffected by this function Returns None IntMasterDisable Disables the processor inter
65. and provides information about the device The members of the Stellaris family have a varying peripheral set and memory sizes The device has a set of read only registers that indicate the size of the memories the peripherals that are present and the pins that are present for peripherals that have a varying number of pins This information can be used to write adaptive software that will run on more than one member of the Stellaris family The device can be clocked from one of five sources an external oscillator the main oscillator the internal oscillator the internal oscillator divided by four or the PLL The PLL can use any of the four oscillators as its input Since the internal oscillator has a very wide error range 50 it cannot be used for applications that require specific timing its real use is for detecting failures of the main oscillator and the PLL and for applications that strictly respond to external events and do not use time based peripherals such as a UART When using the PLL the input clock frequency is constrained to specific frequencies between 3 579545 MHz and 8 192 MHz that is the standard crystal frequencies in that range When direct clocking with an external oscillator or the main oscillator the frequency is constrained to between 0 Hz and 50 MHz depending on the part The internal oscillator is 15 MHz 50 its frequency will vary by device with voltage and with temperature The internal oscillator
66. any data from the FIFO Returns The number of elements read from the I2S receive FIFO 1 or 0 12 2 2 11 l2SRxDisable Disables the 12S receive module for operation Prototype void I2SRxDisable unsigned long ulBase Parameters ulBase is the I2S module base address Description This function disables the receive module for operation The module should be disabled before configuration When the module is disabled no data will be clocked in regardless of the signals on the 12S interface Returns None 12 2 2 12 l2SRxEnable Enables the I2S receive module for operation Prototype void I2SRxEnable unsigned long ulBase January 11 2011 Inter IC Sound 12S Parameters ulBase is the 2S module base address Description This function enables the receive module for operation The module should be enabled after configuration When the module is disabled no data will be clocked in regardless of the signals on the 12S interface Returns None 12 2 2 13 I2SRxFlFOLevelGet Gets the number of samples in the receive FIFO Prototype unsigned long I2SRxFIFOLevelGet unsigned long ulBase Parameters ulBase is the I2S module base address Description This function is used to get the number of samples in the receive FIFO For the purposes of measuring the FIFO level a left right sample pair counts as 2 whether the mode is dual or compact stereo When mono mode is used internal
67. as output inversion output triggers and timer behavior during stalls Control is also provided over interrupt sources and events Interrupts can be generated to indicate that an event has been captured or that a certain number of events have been captured Interrupts can also be generated when the timer has counted down to zero or when the RTC matches a certain value This driver is contained in driverlib timer c with driverlib timer h containing the API definitions for use by applications API Functions Functions void TimerConfigure unsigned long ulBase unsigned long ulConfig m void TimerControlEvent unsigned long ulBase unsigned long ulTimer unsigned long ulEvent m void TimerControlLevel unsigned long ulBase unsigned long ulTimer tBoolean binvert January 11 2011 291 Timer 21 2 1 292 void TimerControlStall unsigned long ulBase unsigned long ulTimer tBoolean bStall void TimerControlTrigger unsigned long ulBase unsigned long ulTimer tBoolean bEnable void TimerControlWaitOnTrigger unsigned long ulBase unsigned long ulTimer tBoolean bWait void TimerDisable unsigned long ulBase unsigned long ulTimer void TimerEnable unsigned long ulBase unsigned long ulTimer void TimerlntClear unsigned long ulBase unsigned long ullntFlags void TimerlIntDisable unsigned long ulBase unsigned long ullntFlags void TimerlntEnable unsigned long ulBase unsigned long ullntFlags void TimerIntRegister unsig
68. based on the message identifiers as mes sage are seen by the CAN controller The combination of ulMsgID and ulMsgIDMask will determine if a message is accepted for a given message object In some cases it may be necessary to add a filter based on the direction of the message so in these cases the MSG_OBJ_USE_DIR_FILTER is used to only accept the direction specified in the message type Another additional filter flag is MSG_OBJ_USE_EXT_FILTER which will filter on only extended identifiers In a mixed 11 bit and 20 bit identifier system this will prevent an 11 bit identifier being confused with a 20 bit identifier of the same value It is not necessary to specify this if there are only extended identifiers being used in the system To determine if the incoming message identifier matches a given message object the incoming message identifier is ANDed with ulMsgIDMask and compared with ulMsgID The C logic would be the following if IncomingID amp ulMsgIDMask ulMsgID Accept the message else Ignore the message The last of the flags to affect CANMessageSet is the MSG_OBJ_FIFO flag This flag is used when combining multiple message objects in a FIFO This is useful when an application needs to receive more than the 8 bytes of data that can be received by a single CAN message object It can January 11 2011 Controller Area Network CAN also be used to reduce the likelihood of causing an overrun of d
69. bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into an I2C pin it only configures an 12C pin for proper operation Returns None GPIOPinTypel2S Configures pin s for use by the I2S peripheral Prototype void GPIOPinTypel2S unsigned long ulPort unsigned char ucPins January 11 2011 GPIO Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description Some 12S pins must be properly configured for the 12S peripheral to function correctly This function provides a typical configuration for the digital 12S pin s other configurations may work as well depending upon the board setup for example using the on chip pull ups The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into a 2S pin it only configures a I2S pin for proper operation Returns None 9 2 2 23 GPIOPinTypePWM Configures pin s for use by the PWM peripheral Prototype void GPIOPinTypePWM unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The PWM pins must be properly configured for the PWM peripheral to function co
70. block of MAC addresses The last three octets 00 00 80 are a 24 bit number managed by the OUI owner to uniquely identify a piece of hardware within that organization that is to be connected to the Ethernet In this representation the octets are transmitted from left to right with the AC octet being transmitted first and the 80 octet being transmitted last Within an octet the bits are transmit ted LSB to MSB For this address the first bit to be transmitted would be 0 the LSB of AC and the last bit to be transmitted would be 1 the MSB of 80 Returns None 6 2 2 14 EthernetPacketAvail Check for packet available from the Ethernet controller Prototype tBoolean EthernetPacketAvail unsigned long ulBase January 11 2011 77 Ethernet Controller 6 2 2 15 6 2 2 16 78 Parameters ulBase is the base address of the controller Description The Ethernet controller provides a register that contains the number of packets available in the receive FIFO When the last bytes of a packet are successfully received that is the frame check sequence bytes the packet count is incremented Once the packet has been fully read including the frame check sequence bytes from the FIFO the packet count will be decre mented Returns Returns true if there are one or more packets available in the receive FIFO including the current packet being read and false otherwise EthernetPacketGet
71. called when a comparator interrupt occurs This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for important information about registering interrupt handlers Returns None ComparatorRefSet Sets the internal reference voltage January 11 2011 17 Analog Comparator Prototype void ComparatorRefSet unsigned long ulBase unsigned long ulRef Parameters ulBase is the base address of the comparator module ulRef is the desired reference voltage Description This function sets the internal reference voltage value The voltage is specified as one of the following values COMP_REF_OFF to turn off the reference voltage COMP_REF_OV to set the reference voltage to 0 V COMP_REF_0_1375V to set the reference voltage to 0 1375 V COMP_REF_0_275V to set the reference voltage to 0 275 V COMP_REF_0_4125V to set the reference voltage to 0 4125 V COMP_REF_0_55V to set the reference voltage to 0 55 V COMP_REF_0_6875V to set the reference voltage to 0 6875 V COMP_REF_0_825V to set the reference voltage to 0 825 V COMP_REF_0_928125V to set the reference voltage to 0 928125 V COMP_REF_0_9625V to set the reference voltage to 0 9625 V COMP_REF_1_03125V to set the reference voltage to 1 03125 V COMP_REF_1_134375V to set the reference voltage to 1 134375 V COMP_REF_1_1V to set the reference voltage to 1 1 V
72. can be returned Returns The current interrupt status enumerated as a bit field of FLASH_INT_PROGRAM and FLASH_INT_ACCESS 8 2 2 7 FlashIntUnregister Unregisters the interrupt handler for the flash interrupt Prototype void FlashIntUnregister void Description This function will clear the handler to be called when the flash interrupt occurs This will also mask off the interrupt in the interrupt controller so that the interrupt handler is no longer called See also IntRegister for important information about registering interrupt handlers Returns None 8 2 2 8 FlashProgram Programs flash Prototype long FlashProgram unsigned long xpulData unsigned long ulAddress unsigned long ulCount Parameters pulData is a pointer to the data to be programmed ulAddress is the starting address in flash to be programmed Must be a multiple of four ulCount is the number of bytes to be programmed Must be a multiple of four Description This function will program a sequence of words into the on chip flash Programming each location consists of the result of an AND operation of the new data and the existing data in other words bits that contain 1 can remain 1 or be changed to 0 but bits that are 0 cannot be changed to 1 Therefore a word can be programmed multiple times as long as these rules are followed if a program operation attempts to change a 0 bit to a 1 bit that bit will not have its value changed
73. channel index the primary or alternate control structure must also be selected uDMAChannelControlSet UDMA_CHANNEL_UARTORX UDMA_PRI_SELECT sane Dy In order to help make it clear when one or the other form is to be used the parameters are named differently in the API description For functions that require just the channel number the name of the parameter is ulChannelNum For functions that require the channel index of the channel control structure the name of the parameter is u ChannelStructldx Selecting UDMA Channels The uDMA controller has 32 channels and therefore most of the API functions take a channel number with a value from 0 31 or a channel index with a value from 0 63 the 32 63 is specified with the logical OR of the channel number with UDMA_ALT_SELECT In order to avoid the need for hardcoded channel numbers in code macros are provided that map channel names to channel numbers To use the default channel mapping you may use one of the following choices whenever a channel number or index is needed This list is all the possible channels that are defined by the API However not all channels are available on all parts depending on which peripherals are available on the part and which of those support UDMA Please consult the data sheet for your specific part to see which uDMA channels are supported UDMA_CHANNEL_USBEP1RxX for USB endpoint 1 receive UDMA_CHANNEL_USBEP1TX for USB endpoint 1 transmit UDMA_CHANNEL_USBE
74. code can be used as a reference upon which to add support for the additional capabilities The APIs have a means of removing all error checking code Because the error checking is usually only useful during initial program development it can be removed to improve code size and speed For many applications the drivers can be used as is But in some cases the drivers will have to be enhanced or rewritten in order to meet the functionality memory or processing requirements of the application If so the existing driver can be used as a reference on how to operate the peripheral The following tool chains are supported m Keil RealView Microcontroller Development Kit CodeSourcery Sourcery G for Stellaris EABI m IAR Embedded Workbench Code Red Technologies tools m Texas Instruments Code Composer Studio Source Code Overview The following is an overview of the organization of the peripheral driver library source code January 11 2011 7 Introduction EULA txt driverlib hw_ h inc makedefs The full text of the End User License Agreement that covers the use of this software package This directory contains the source code for the drivers Header files one per peripheral that describe all the registers and the bit fields within those registers for each peripheral These header files are used by the drivers to directly access a peripheral and can be used by application code to bypass the periphe
75. current value The counter is not automatically reloaded with the period as specified in a previous call to SysTickPeriodSet If an immediate reload is required the NVIC_ST_CURRENT register must be written to force this Any write to this register clears the SysTick counter to 0 and will cause a reload with the supplied period on the next clock Returns None SysTickIntDisable Disables the SysTick interrupt Prototype void SysTickIntDisable void Description This function will disable the SysTick interrupt preventing it from being reflected to the proces sor Returns None January 11 2011 20 2 2 4 20 2 2 5 20 2 2 6 System Tick SysTick SysTickIntEnable Enables the SysTick interrupt Prototype void SysTickIntEnable void Description This function will enable the SysTick interrupt allowing it to be reflected to the processor Note The SysTick interrupt handler does not need to clear the SysTick interrupt source as this is done automatically by NVIC when the interrupt handler is called Returns None SysTickintRegister Registers an interrupt handler for the SysTick interrupt Prototype void SysTickIntRegister void pfnHandler void Parameters pfnHandler is a pointer to the function to be called when the SysTick interrupt occurs Description This sets the handler to be called when a SysTick interrupt occurs See also IntRegister for important information a
76. dates sie euer Wes adaaep eee dee eee 135 Programming REIN DIE eearri a A E E 148 10 1 Introduction The Hibernate API provides a set of functions for using the Hibernation module on the Stellaris microcontroller The Hibernation module allows the software application to cause power to be removed from the microcontroller and then be powered on later based on specific time or a signal on the external WAKE pin The API provides functions to configure wake conditions manage interrupts read status save and restore program state information and request hibernation mode Some of the features of the Hibernation module are m 32 bit real time clock Trim register for fine tuning the RTC rate Two RTC match registers for generating RTC events External WAKE pin to initiate a wake up m Low battery detection m 64 32 bit words of non volatile memory m Programmable interrupts for hibernation events This driver is contained in driverlib hibernate c with driverlib hibernate h contain ing the API definitions for use by applications 10 2 API Functions Functions void HibernateClockSelect unsigned long ulClockInput void HibernateDataGet unsigned long xpulData unsigned long ulCount void HibernateDataSet unsigned long xpulData unsigned long ulCount void HibernateDisable void void HibernateEnableExpClk unsigned long ulHibClk void HibernatelntClear unsigned long ullntFlags void HibernatelntDisable unsigned long ullntFlags
77. droops too much if the external voltage droops too much or if the PLL fails See also IntRegister for important information about registering interrupt handlers Returns None 19 2 2 17 SysCtllntStatus Gets the current interrupt status Prototype unsigned long SysCtliIntStatus tBoolean bMasked Parameters bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required Description This returns the interrupt status for the system controller Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned January 11 2011 269 System Control Returns The current interrupt status enumerated as a bit field of SYSCTL_INT_PLL_LOCK SYSCTL_INT_CUR_LIMIT SYSCTL_INT_IOSC_ FAIL SYSCTL_INT_MOSC _ FAIL SYSCTL_INT_POR SYSCTL_INT_BOR and SYSCTL_INT_PLL_FAIL 19 2 2 18 SysCtllntUnregister Unregisters the interrupt handler for the system control interrupt Prototype void SysCtlIntUnregister void Description This function will clear the handler to be called when a system control interrupt occurs This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for important information about registering interrupt handlers Returns None 19 2 2 19 SysCtllOSCVerificationSet Configures the internal oscillator verification time
78. ee ee eee ee ew eee ee 169 WESSON o hw esi ea aa es ne ae Ee a ee ke ee Ke ee a 169 POPU PURO oos oe sg artes aaa we haw E eat ee be Sok ee he he ee aau 169 Programming Example e a as bo RE A Ae ww oo Pe A aw ae ee Be 184 Interrupt Controller NVIC 2 0 ce es 187 WVERSGUSNOM sos oe em ek ee a UO A ee we a ae RR we 187 PP PUTVIGAS o sx tap eae ae ee WR ww a eee oa GOR a ee we RS RA 188 Programming Example o ee sasra eR RY MESA AG AR E awa a ee Par eeces 4 195 Memory Protection Unit MPU 2 0 2 ee 197 VENOM 2S ate eee eRe a eat on Ie a a ee ee ee cee JB doe ee a aot a 197 APIUFUNCIONS ooa ak dct aes ee wears a Hd a ae Ba a hk a a i ee a ie B i 197 Programming Example ee sa ck ah Se RRR ww eee Pa Aaa Re ee 204 Peripheral Pin Mapping 2 2 0 ee eee ee 207 IDOGION o eo al ee ke ae Se a ee OM A OR E 207 API FONCIONS o aa cee ghee a re ee we GE ee ee a a ee ee ee we YG 207 Programming EXamMple ok a a A ke EMRE Gh E 8 aoa we dee ee 213 Pulse Width Modulator PWM 2 62 ee 215 NSGUCNGN S65 aon ea Ra Be ee E ok eae ae A ow ee a ew Ma ei ee 215 API FUNCIONS o s a bed a ie arara wk we dap ae eae ees GOR ee he a 215 Programming Example ewe Sa eh ee ee ERROR OE Owe eee PEERS 236 Quadrature Encoder QEl 2 2 0 2 eee es 237 WVESGEINGM o aa a aa a ea a a e e A Qe ew a eR 237 API FONCIONS oi acio araa aie ewe a a O aai a ee Rw a a a a ee we ee we OE da 238 Programming Example 254 sasssa renra ar awaa
79. example the SSIT_CRO_FRF_M macro de fines the bit field and the SSI_CRO_FRF_NMW SSI_CRO_FRF_TI and SSI_CRO_FRF_MOTO macros provide the enumerations for the bit field Values that end in _S represent the number of bits to shift a value in order to align it with a multi bit field These values match the macro with the same base name but ending with _M January 11 2011 9 Programming Model 2 3 m All other macros represent the value of a bit field m All register name macros start with the module name and instance number for example SSI0 for the first SSI module and are followed by the name of the register as it appears in the data sheet for example the CRO register in the data sheet results in SSTO_CRO_R m All register bit fields start with the module name followed by the register name and then followed by the bit field name as it appears in the data sheet For example the SCR bit field in the CRO register in the SSI module will be identified by SSI_CRO_SCR In the case where the bit field is a single bit there will be nothing further for example SST_CRO_SPH is a single bit in the CRO register If the bit field is more than a single bit there will be a mask value M and either a shift _S if the bit field contains a number or a set of enumerations if not Given these definitions the CRO register can be programmed as follows SSIO_CRO_LR 5 lt lt SSI_CRO_SCR_S SSI_CRO_SPH SSI_CRO_SPO SSI_CRO_FRF_MOTO
80. for software initiated data transfers m channels can be independently configured and operated an arbitration scheme that is configurable per channel two levels of priority subordinate to Cortex M3 processor bus usage data sizes of 8 16 or 32 bits address increment of byte half word word or none maskable device requests optional software initiated transfers on any channel m interrupt on transfer completion The uDMA controller supports several different transfer modes allowing for complex transfer schemes The following transfer modes are provided Basic mode performs a simple transfer when request is asserted by a device This is ap propriate to use with peripherals where the peripheral asserts the request line whenever data should be transferred The transfer will pause if request is de asserted even if the transfer is not complete Auto request mode performs a simple transfer that is started by a request but will always complete the entire transfer even if request is de asserted This is appropriate to use with software initiated transfers Ping Pong mode is used to transfer data to or from two buffers switching from one buffer to the other as each buffer fills This mode is appropriate to use with peripherals as a way to ensure a continuous flow of data to or from the peripheral However it is more complex to set up and requires code to manage the ping pong buffers in the interrupt handler Memory scatter gathe
81. given USB controller Prototype unsigned long USBIntStatusEndpoint unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function will read endpoint interrupt status for a USB controller This call will return the current status for endpoint interrupts only the control interrupt status is retrieved by calling US BintStatusControl The bit values returned should be compared against the USB_INTEP_ values These are grouped into classes for USB_INTEP_HOST_ and USB_INTEP_DEV_ values to handle both host and device modes with all endpoints Note This call will clear the source of all of the endpoint interrupts Returns Returns the status of the endpoint interrupts for a USB controller 24 3 2 56 USBIntUnregister Unregisters an interrupt handler for the USB controller Prototype void USBIntUnregister unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function unregister the interrupt handler This function will also disable the USB interrupt in the interrupt controller See also IntRegister for important information about registering or unregistering interrupt handlers Returns None 388 January 11 2011 USB Controller 24 3 2 57 USBModeGet Returns the current operating mode of the controller Prototype unsigned long USBModeGet unsigned long ulBase Parameters ulBase specifies the U
82. has been saved Returns Returns 0 on success or 1 if a hardware error is encountered FlashProtectSet Sets the protection setting for a block of flash Prototype long FlashProtectSet unsigned long ulAddress tFlashProtection eProtect January 11 2011 8 2 2 12 8 2 2 13 Flash Parameters ulAddress is the start address of the flash block to be protected eProtect is the protection to be applied to the block Can be one of FlashReadWrite FlashReadOnly or FlashExecuteOnly Description This function will set the protection for the specified 2 kB block of flash Blocks which are read write can be made read only or execute only Blocks which are read only can be made execute only Blocks which are execute only cannot have their protection modified Attempts to make the block protection less stringent that is read only to read write will result in a failure and be prevented by the hardware Changes to the flash protection are maintained only until the next reset This allows the ap plication to be executed in the desired flash protection environment to check for inappropriate flash access via the flash interrupt To make the flash protection permanent use the Flash ProtectSave function Returns Returns 0 on success or 1 if an invalid address or an invalid protection was specified FlashUsecGet Gets the number of processor clocks per micro second Prototype unsigned long FlashUsecGet void D
83. interrupt handler s responsibility to clear the interrupt source See also IntRegister for important information about registering interrupt handlers Returns None 6 2 2 10 EthernetintStatus Gets the current Ethernet interrupt status January 11 2011 75 Ethernet Controller 6 2 2 11 6 2 2 12 76 Prototype unsigned long EthernetIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the base address of the controller bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required Description This returns the interrupt status for the Ethernet controller Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned Returns Returns the current interrupt status enumerated as a bit field of values described in Ethernet IntEnable EthernetIntUnregister Unregisters an interrupt handler for an Ethernet interrupt Prototype void EthernetIntUnregister unsigned long ulBase Parameters ulBase is the base address of the controller Description This function unregisters the interrupt handler This will disable the global interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for important information about registering interrupt handlers Returns None EthernetMACAddrGet Gets the MAC address
84. interrupts Use the HibernatelntRegister and Hiber natelntUnregister functions to install or uninstall an interrupt handler into the vector table Refer to the IntRegister function for notes about using the interrupt vector table The module can generate several different interrupts Use the HibernatelntEnable and HibernatelntDisable functions to enable and disable specific interrupt sources The present interrupt status can be found by call ing HibernatelntStatus In the interrupt handler all pending interrupts must be cleared Use the HibernatelntClear function to clear pending interrupts January 11 2011 10 2 2 10 2 2 1 10 2 2 2 Hibernation Module Finally once the module is appropriately configured the state saved and the software application is ready to hibernate call the HibernateRequest function This will initiate the sequence to remove power from the processor At a power on reset the software application can use the HibernatelsAc tive function to determine if the Hibernation module is already active and therefore does not need to be enabled This can provide a hint to the software that the processor is waking from hibernation instead of a cold start The software can then use the HibernatelntStatus and HibernateDataGet functions to discover the cause of the wake and to get the saved system state The HibernateEnable API from previous versions of the peripheral driver library has been re placed by t
85. interrupts with the same preemptable prioritization but different subpriorities will not cause a preemption tail chaining will instead be used to process the two interrupts back to back If two interrupts with the same priority and subpriority if so configured are asserted at the same time the one with the lower interrupt number will be processed first NVIC keeps track of the nesting of interrupt handlers allowing the processor to return from interrupt context only once all nested and pending interrupts have been handled Interrupt handlers can be configured in one of two ways statically at compile time or dynamically at run time Static configuration of interrupt handlers is accomplished by editing the interrupt handler table in the application s startup code When statically configured the interrupts must be explicitly enabled in NVIC via IntEnable before the processor will respond to the interrupt in addition to any interrupt enabling required within the peripheral itself Statically configuring the interrupt table provides the fastest interrupt response time since the stacking operation a write to SRAM can be performed in parallel with the interrupt handler table fetch a read from Flash as well as the prefetch of the interrupt handler itself assuming it is also in Flash Alternatively interrupts can be configured at run time using IntRegister or the analog in each individual driver When using IntRegister the interrupt
86. is chosen from the following m one of I2S_TX_MCLK_EXT or I2S_TX_MCLK_INT m one of I2S_RX_MCLK_EXT or l2S_RX_MCLK_INT Returns Returns None I2SRxConfigSet Configures the I2S receive module Prototype void I2SRxConfigSet unsigned long ulBase unsigned long ulConfig Parameters ulBase is the I2S module base address ulConfig is the logical OR of the configuration options Description This function is used to configure the options for the 12S receive channel The parameter ulConfig is the logical OR of the following options m 12S CONFIG_FORMAT_12S for standard 12S format 12S CONFIG_FORMAT_LEFT_JUST for left justified format or 128 CONFIG_FORMAT_RIGHT_JUST for right justified format m 12S CONFIG_SCLK_INVERT to invert the polarity of the serial bit clock m 12S CONFIG_MODE_DUAL for dual channel stereo 12S CONFIG_MODE_COMPACT_16 for 16 bit compact stereo mode 128 _CONFIG_MODE_COMPACT _8 for 8 bit compact stereo mode or 126 CONFIG_MODE_MONDO for single channel mono format m 12S CONFIG_CLK_MASTER or I2S_CONFIG_CLK_SLAVE to select whether the 12S receiver is the clock master or slave m 12S CONFIG_SAMPLE_SIZE_32 24 20 16 or 8 to select the number of bits per sample January 11 2011 Inter IC Sound 12S m 12S CONFIG_WIRE_SIZE_32 24 20 16 or _8 to select the number of bits per word that are transferred on the data line Returns None 12 2 2 9 l2SRxDataGet Reads data samples from the I2
87. is the 2S module base address ullntFlags is a bit mask of the interrupt sources to be enabled Description This function enables the specified 12S sources to generate interrupts The ullntFlags param eter can be the logical OR of any of the following values m 12S_INT_RXERR for receive errors m 12S_INT_RXREQ for receive FIFO service requests m 12S_INT_TXERR for transmit errors m 12S_INT_TXREQ for transmit FIFO service requests Returns Returns None I2SIntRegister Registers an interrupt handler for the 12S controller Prototype void I2SIntRegister unsigned long ulBase void pfnHandler void Parameters ulBase is the 2S module base address pfnHandler is a pointer to the function to be called when the interrupt is activated Description This sets and enables the handler to be called when the 12S controller generates an inter rupt Specific 12S interrupts must still be enabled with the I2SIntEnable function It is the responsibility of the interrupt handler to clear any pending interrupts with I2SIntClear January 11 2011 12 2 2 5 12 2 2 6 Inter IC Sound 12S See also IntRegister for important information about registering interrupt handlers Returns None I2SIntStatus Gets the 12S interrupt status Prototype unsigned long T2SIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the 2S module base address bMasked is set true to get the masked in
88. is the logical OR of PWM_INT_CNT_ZERO PWM_INT_CNT_LOAD PWM_INT_CNT_AU PWM_INT_CNT_AD PWM_INT_CNT_BU PWM_INT_CNT_BD PWM_TR_CNT_ZERO PWM_TR_CNT_LOAD PWM_TR_CNT_AU PWM_TR_CNT_AD PWM_TR_CNT_BU or PWM_TR_CNT_BD Returns None 16 2 2 20 PWMGenIntUnregister Removes an interrupt handler for the specified PWM generator block Prototype void PWMGenIntUnregister unsigned long ulBase unsigned long ulGen Parameters ulBase is the base address of the PWM module ulGen is the PWM generator in question Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_ 2 or PWM_GEN_3 Description This function will unregister the interrupt handler for the specified PWM generator block This function will also disable the corresponding PWM generator interrupt in the interrupt controller individual generator interrupts and interrupt sources must be disabled with PWMIntDisable and PWMGenIntTrigDisable See also IntRegister for important information about registering interrupt handlers Returns None 16 2 2 21 PWMGenPeriodGet Gets the period of a PWM generator block Prototype unsigned long PWMGenPeriodGet unsigned long ulBase unsigned long ulGen January 11 2011 229 Pulse Width Modulator PWM Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to query Must be one of PWM_GEN_0O PWM_GEN_1 PWM_GEN_2 or PWM_GEN_ 3 Description This function gets the period of the spec
89. level returned as one of UART_FIFO_TX1_8 UART_FIFO_TX2_8 UART_FIFO_TX4_8 UART_FIFO_TX6_8 or UART_FIFO_TX7_8 pulRxLevel is a pointer to storage for the receive FIFO level returned as one of UART_FIFO_RX1_8 UART_FIFO_RX2_8 UART_FIFO_RX4_8 UART_FIFO_RX6_8 or UART_FIFO_RX7_8 Description This function gets the FIFO level at which transmit and receive interrupts are generated Returns None 22 2 2 19 UARTFIFOLevelSet Sets the FIFO level at which interrupts are generated Prototype void UARTFIFOLevelSet unsigned long ulBase unsigned long ulTxLevel unsigned long ulRxLevel Parameters ulBase is the base address of the UART port ulTxLevel is the transmit FIFO interrupt level specified as one of UART_FIFO_TX1_ 8 UART_FIFO_TX2_8 UART_FIFO_TX4_8 UART_FIFO_TX6_8 or UART_FIFO_TX7_8 ulRxLevel is the receive FIFO interrupt level specified as one of UART_FIFO_RX1_ 8 UART_FIFO_RX2_8 UART_FIFO_RX4_8 UART_FIFO_RX6 8 or UART_FIFO_RX7_8 Description This function sets the FIFO level at which transmit and receive interrupts are generated Returns None 22 2 2 20 UARTFlowControlGet Returns the UART hardware flow control mode currently in use Prototype unsigned long UARTFlowControlGet unsigned long ulBase Parameters ulBase is the base address of the UART port Description Returns the current hardware flow control mode January 11 2011 317 UART 22 2 2 21 Note The
90. level where N is 3 for the Stellaris family so any prioritization must be performed in those bits Returns None 13 2 2 12 IntPrioritySet Sets the priority of an interrupt Prototype void IntPrioritySet unsigned long ulInterrupt unsigned char ucPriority Parameters ullnterrupt specifies the interrupt in question ucPriority specifies the priority of the interrupt Description This function is used to set the priority of an interrupt When multiple interrupts are asserted simultaneously the ones with the highest priority are processed before the lower priority in terrupts Smaller numbers correspond to higher interrupt priorities priority O is the highest interrupt priority The hardware priority mechanism will only look at the upper N bits of the priority level where N is 3 for the Stellaris family so any prioritization must be performed in those bits The remaining bits can be used to sub prioritize the interrupt sources and may be used by the hardware priority mechanism on a future part This arrangement allows priorities to migrate to different NVIC implementations without changing the gross prioritization of the interrupts Returns None January 11 2011 193 Interrupt Controller NVIC 13 2 2 13 IntRegister Registers a function to be called when an interrupt occurs Prototype void IntRegister unsigned long ulInterrupt void pfnHandler void Parameters ullnterrupt specifies the i
91. logical OR of the following PWM_GEN_MODE_DOWN or PWM_GEN_MODE_UP_DOWN to specify the counting mode PWM_GEN_MODE_SYNC or PWM_GEN_MODE_NO_SYNC to specify the counter load and comparator update synchronization mode PWM_GEN_MODE_DBG_RUN or PWM_GEN_MODE_DBG_STOP to specify the debug behavior PWM_GEN MODE_GEN_NO SYNC PWM_GEN_MODE_GEN_ SYNC LOCAL or PWM_GEN_MODE_GEN_SYNC_GLOBAL to specify the update synchronization mode for generator counting mode changes PWM_GEN_MODE_DB_NO SYNC PWM_GEN_ MODE_DB_SYNC_LOCAL or PWM_GEN _MODE_DB_SYNC_GLOBAL to specify the deadband parameter syn chronization mode PWM_GEN_MODE_FAULT_LATCHED or PWM_GEN_MODE_FAULT_UNLATCHED to specify whether fault conditions are latched or not PWM_GEN_MODE_FAULT_MINPER or PWM_GEN MODE_FAULT_NO_MINPER to specify whether minimum fault period support is required PWM_GEN_MODE_FAULT_EXT or PWM_GEN_MODE_FAULT_LEGACY to specify whether extended fault source selection support is enabled or not Setting PWM_GEN_MODE_FAULT_MINPER allows an application to set the minimum dura tion of a PWM fault signal Fault will be signaled for at least this time even if the external fault pin deasserts earlier Care should be taken when using this mode since during the fault signal period the fault interrupt from the PWM generator will remain asserted The fault interrupt handler may therefore reenter immediately if it exits prior to expiration of the fault timer 221 Pulse Width
92. long UARTModemControlGet unsigned long ulBase Parameters ulBase is the base address of the UART port Description Returns the current states of each of the two UART modem control signals DTR and RTS Note The availability of hardware modem handshake signals varies with the Stellaris part and UART in use Please consult the datasheet for the part you are using to determine whether this support is available Returns Returns the states of the handshake output signals This will be a logical logical OR combina tion of values UART_OUTPUT_RTS and UART_OUTPUT_DTR where the presence of each flag indicates that the associated signal is asserted 22 2 2 30 UARTModemControlSet Sets the states of the DTR and or RTS modem control signals Prototype void UARTModemControlSet unsigned long ulBase unsigned long ulControl 322 January 11 2011 UART Parameters ulBase is the base address of the UART port ulControl is a bit mapped flag indicating which modem control bits should be set Description Sets the states of the DTR or RTS modem handshake outputs from the UART The ulControl parameter is the logical OR of any of the following UART_OUTPUT_DTR The Modem Control DTR signal m UART_OUTPUT_RTS The Modem Control RTS signal Note The availability of hardware modem handshake signals varies with the Stellaris part and UART in use Please consult the datasheet for the part you are using to determine whether this
93. longer than the configured maximum wait time Returns Returns the interrupt error flags as the logical OR of any of the following EPLINT_ERR_WTFULL EPlINT_ERR_RSTALL or EPl_INT_ERR_TIMEOUT EPlIntRegister Registers an interrupt handler for the EPI module Prototype void EPIIntRegister unsigned long ulBase void pfnHandler void Parameters ulBase is the EPI module base address pfnHandler is a pointer to the function to be called when the interrupt is activated Description This sets and enables the handler to be called when the EPI module generates an interrupt Specific EPI interrupts must still be enabled with the EPlIIntEnable function See also IntRegister for important information about registering interrupt handlers Returns None EPIlntStatus Gets the EPI interrupt status Prototype unsigned long EPIIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the EPI module base address bMasked is set true to get the masked interrupt status or false to get the raw interrupt status Description This function returns the EPI interrupt status It can return either the raw or masked interrupt status January 11 2011 95 External Peripheral Interface EP Returns Returns the masked or raw EPI interrupt status as a bit field of any of the following values EPI_INT_TXREQ EPI_INT_RXREQ or EPI_INT_ERR 7 2 2 14 EPllntUnregister Unregisters an interrupt hand
94. low band only if ADC output has been in the high band since the last trigger output ADC_COMP_INT_LOW_HONCE to generate ADC interrupt once when ADC output tran sitions into low band only if ADC output has been in the high band since the last trigger output ADC_COMP_INT_MID_ALWAYS to always generate ADC interrupt when ADC output is in the mid band ADC_COMP_INT_MID_ONCE to generate ADC interrupt once when ADC output transi tions into the mid band ADC_COMP_INT_HIGH_ALWAYS to always generate ADC interrupt when ADC output is in the high band ADC_COMP_INT_HIGH_ONCE to generate ADC interrupt once when ADC output transi tions into the high band ADC_COMP_INT_HIGH_HALWAYS to always generate ADC interrupt when ADC output is in the high band only if ADC output has been in the low band since the last trigger output ADC_COMP_INT_HIGH_HONCE to generate ADC interrupt once when ADC output tran sitions into high band only if ADC output has been in the low band since the last trigger output Returns None ADCComparatorIntClear Clears sample sequence comparator interrupt source January 11 2011 4 2 2 3 4 2 2 4 Analog to Digital Converter ADC Prototype void ADCComparatorIntClear unsigned long ulBase unsigned long ulStatus Parameters ulBase is the base address of the ADC module ulStatus is the bit mapped interrupts status to clear Description The specified interrupt status is cleared Re
95. occurs Description This function does the actual registering of the interrupt handler This will enable the global interrupt in the interrupt controller the watchdog timer interrupt must be enabled via Watch dogEnable It is the interrupt handler s responsibility to clear the interrupt source via Watch dogIntClear See also IntRegister for important information about registering interrupt handlers Returns None WatchdogIntStatus Gets the current watchdog timer interrupt status Prototype unsigned long WatchdogIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the base address of the watchdog timer module bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required Description This returns the interrupt status for the watchdog timer module Either the raw interrupt status or the status of interrupt that is allowed to reflect to the processor can be returned Returns Returns the current interrupt status where a 1 indicates that the watchdog interrupt is active and a 0 indicates that it is not active WatchdogIntUnregister Unregisters an interrupt handler for the watchdog timer interrupt Prototype void WatchdogIntUnregister unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module January 11 2011 25 2 2 1 25 2 2 8 25 2 2 9 Watchdog Timer Description This function does
96. of items read from the FIFO EPINonBlockingReadGet32 Read available data from the read FIFO as 32 bit data items Prototype unsigned long EPINonBlockingReadGet 32 unsigned long ulBase unsigned long ulCount unsigned long x pulBuf January 11 2011 7 2 2 21 7 2 2 22 External Peripheral Interface EP Parameters ulBase is the EPI module base address ulCount is the maximum count of items to read pulBuf is the caller supplied buffer where the read data should be stored Description This function reads 32 bit data items from the read FIFO and stores the values in a caller supplied buffer The function will read and store data from the FIFO until there is no more data in the FIFO or the maximum count is reached as specified in the parameter u Count The actual count of items will be returned Returns The number of items read from the FIFO EPINonBlockingReadGet8 Read available data from the read FIFO as 8 bit data items Prototype unsigned long EPINonBlockingReadGet8 unsigned long ulBase unsigned long ulCount unsigned char xpucBuf Parameters ulBase is the EPI module base address ulCount is the maximum count of items to read pucBuf is the caller supplied buffer where the read data should be stored Description This function reads 8 bit data items from the read FIFO and stores the values in a caller sup plied buffer The function will read and store data from the FIFO until ther
97. of the Ethernet controller Prototype void EthernetMACAddrGet unsigned long ulBase unsigned char pucMACAddr Parameters ulBase is the base address of the controller pucMACAddar is the pointer to the location in which to store the array of MAC 48 address octets January 11 2011 6 2 2 13 Ethernet Controller Description This function will read the currently programmed MAC address into the pucMACAdar buffer See also Refer to EthernetMACAddrSet API description for more details about the MAC address for mat Returns None EthernetMACAddrSet Sets the MAC address of the Ethernet controller Prototype void EthernetMACAddrSet unsigned long ulBase unsigned char pucMACAddr Parameters ulBase is the base address of the controller pucMACAddar is the pointer to the array of MAC 48 address octets Description This function will program the IEEE defined MAC 48 address specified in pucMACAdar into the Ethernet controller This address is used by the Ethernet controller for hardware level filtering of incoming Ethernet packets when promiscuous mode is not enabled The MAC 48 address is defined as 6 octets illustrated by the following example address The numbers are shown in hexadecimal format AC DE 48 00 00 80 In this representation the first three octets AC DE 48 are the Organizationally Unique Iden tifier OUI This is a number assigned by the IEEE to an organization that requests a
98. parameters provide the rest The u Flags parameter determines whether this is an IN end point USB_EP_HOST_IN or USB_EP_DEV_IN or an OUT endpoint USB_EP_HOST_OUT or USB_EP_DEV_OUT whether this is a Full speed endpoint USB_EP_SPEED_FULL ora Low speed endpoint USB_EP_SPEED_ LOW The USB_EP_MODE_ flags control the type of the endpoint m USB_EP_MODE_ CTRL is a control endpoint USB_EP_MODE_ISOC is an isochronous endpoint USB_EP_MODE_BULK is a bulk endpoint USB_EP_MODE_INT is an interrupt endpoint The u NAKPollinterval parameter has different meanings based on the USB_EP_MODE value and whether or not this call is being made for endpoint zero or another endpoint For endpoint zero or any Bulk endpoints this value always indicates the number of frames to allow a device to NAK before considering it a timeout If this endpoint is an isochronous or interrupt endpoint this value is the polling interval for this endpoint For interrupt endpoints the polling interval is simply the number of frames between polling an interrupt endpoint For isochronous endpoints this value represents a polling interval of 2 uINAKPollinterval 1 frames When used as a NAK timeout the u NAKPollinterval value specifies 2 u NAKPollinterval 1 frames before issuing a time out There are two special time out values that can be specified when setting the u NAKPollinterval value The first is MAX_NAK_LIMIT which is the maximum value that can be passed i
99. pointer to the function to be called when the interrupt is activated Description This sets and enables the handler to be called when the uDMA controller generates an inter rupt The ullntChannel parameter should be one of the following UDMA_INT_SW to register an interrupt handler to process interrupts from the uDMA soft ware channel UDMA_CHANNEL_SW m UDMA_INT_ERR to register an interrupt handler to process UDMA error interrupts See also IntRegister for important information about registering interrupt handlers Note The interrupt handler for uDMA is for transfer completion when the channel UDMA_CHANNEL_SW is used and for error interrupts The interrupts for each periph eral channel are handled through the individual peripheral interrupt handlers Returns None 23 2 3 23 uDMAIntUnregister Unregisters an interrupt handler for the UDMA controller Prototype void uDMAIntUnregister unsigned long ulIntChannel Parameters ullntChannel identifies which uDMA interrupt to unregister Description This function will disable and clear the handler to be called for the specified UDMA interrupt The ullntChannel parameter should be one of UDMA_INT_SW or UDMA_INT_ERR as docu mented for the function UDMAIntRegister See also IntRegister for important information about registering interrupt handlers Returns None 348 January 11 2011 uDMA Controller 23 3 Programming Example The following example
100. read by the host before being overwritten Returns None CANMessageSet Configures a message object in the CAN controller Prototype void CANMessageSet unsigned long ulBase unsigned long ulObjID tCANMsgObject pMsgObject tMsgObjType eMsgType Parameters ulBase is the base address of the CAN controller ulObjID is the object number to configure 1 32 pMsgObject is a pointer to a structure containing message object settings eMsgType indicates the type of message for this object Description This function is used to configure any one of the 32 message objects in the CAN controller A message object can be configured as any type of CAN message object as well as several options for automatic transmission and reception This call also allows the message object to be configured to generate interrupts on completion of message receipt or transmission The message object can also be configured with a filter mask so that actions are only taken when a message that meets certain parameters is seen on the CAN bus The eMsgType parameter must be one of the following values MSG_OBJ_TYPE_TX CAN transmit message object MSG_OBJ_TYPE_TX_REMOTE CAN transmit remote request message object MSG_OBJ_TYPE_RX CAN receive message object January 11 2011 Controller Area Network CAN MSG_OBJ_TYPE_RX_REMOTE CAN receive remote request message object MSG _OBJ_TYPE_RXTX_REMOTE CAN remote frame receive remote then
101. sample sequence Prototype void ADCProcessorTrigger unsigned long ulBase unsigned long ulSequenceNum January 11 2011 31 Analog to Digital Converter ADC 4 2 2 18 4 2 2 19 32 Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number with ADC_TRIGGER_WAIT or ADC_TRIGGER_SIGNAL optionally ORed into it Description This function triggers a processor initiated sample sequence if the sample sequence trigger is configured to ADC_TRIGGER_PROCESSOR If ADC_TRIGGER_WAIT is ORed into the sequence number the processor initiated trigger is delayed until a later processor initiated trigger to a different ADC module that specifies ADC_TRIGGER_SIGNAL allowing multiple ADCs to start from a processor initiated trigger in a synchronous manner Returns None ADCReferenceGet Returns the current setting of the ADC reference Prototype unsigned long ADCReferenceGet unsigned long ulBase Parameters ulBase is the base address of the ADC module Description Returns the value of the ADC reference setting The returned value will be one of ADC_REF_INT or ADC_REF_EXT_8V Note The value returned by this function is only meaningful if used on a part that is capable of using an external reference Consult the data sheet for your part to determine if it has an external reference input Returns The current setting of the ADC reference ADCReferenceSet Selects the ADC refe
102. samples from the I2S receive FIFO without blocking Prototype long I2SRxDataGetNonBlocking unsigned long ulBase unsigned long pulData Parameters ulBase is the 2S module base address January 11 2011 175 Inter IC Sound 12S pulData points to storage for the returned I2S sample data Description This function reads a single channel sample or combined left right samples from the I2S receive FIFO The format of the sample is determined by the configuration that was used with the func tion I2SRxConfigSet If the receive mode is 125 MODE_DUAL_STEREO then the received data contains either the left or right sample The left and right sample alternate with each read from the FIFO left sample first If the receive mode is 12S MODE_COMPACT_STEREO_16 or 125_ MODE_COMPACT_STEREO_8 then the received data contains both the left and right samples If the receive mode is 12S MODE_SINGLE_MONDO then the received data contains the single channel sample For the compact modes both the left and right samples are read at the same time If 16 bit compact mode is used then the least significant 16 bits contain the left sample and the most significant 16 bits contain the right sample If 8 bit compact mode is used then the lower 8 bits contain the left sample and the next 8 bits contain the right sample with the upper 16 bits unused If there is no data in the receive FIFO then this function will return immediately without reading
103. sets up the uDMA controller to perform a software initiated memory to memory transfer The application must allocate the channel control table This one is a full table for all modes and channels NOTE This table must be 1024 byte aligned unsigned char ucDMAControlTable 1024 Source and destination buffers used for the DMA transfer Le unsigned char ucSourceBuffer 256 unsigned char ucDestBuffer 256 Enable the uDMA controller uDMAEnable Set the base for the channel control table uDMAControlBaseSet amp ucDMAControlTable 0 No attributes need to be set for a software based transfer They will be cleared by default but are explicitly cleared here in case they were set elsewhere uDMAChannelAttributeDisable UDMA_CHANNEL_SW UDMA_CONFIG_ALL Now set up the characteristics of the transfer It will be 8 bit data size with source and destination increments in bytes to perform a byte wise buffer copy A bus arbitration size of 8 is used uDMAChannelControlSet UDMA_CHANNEL_SW UDMA_PRI_SELECT UDMA_SIZE_8 UDMA_SRC_INC_8 UDMA_DST_INC_8 UDMA_ARB_ 8 The transfer buffers and transfer size will now be configured The transfer will use AUTO mode which means that the transfer will automatically run to completion after the first vequest uDMAChannelTransferSet UDMA_CHANNEL_SW UDMA_PRI_SELECT UDMA_MODE_AUTO
104. specifies either 2 4 or 8 mA output drive strength and GPIO_OUT_STRENGTH_8MA_SC specifies 8 mA output drive with slew control The parameter u PinType can be one of the following values GPIO_PIN_TYPE_STD GPIO_PIN_TYPE_STD_WPU GPIO_ PIN _TYPE_STD_WPD GPIO_PIN_TYPE_OD GPIO_PIN_TYPE_OD_WPU GPIO PIN TYPE_OD_WPD GPIO_PIN_TYPE_ANALOG January 11 2011 9 2 2 7 9 2 2 8 GPIO where GPIO_PIN_TYPE_STD specifies a push pull pin GPIO_PIN_TYPE_OD specifies an open drain pin x_WPU specifies a weak pull up _WPD specifies a weak pull down and GPIO_PIN_TYPE_ANALOG specifies an analog input for the comparators The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Returns None GP1IOPinConfigure Configures the alternate function of a GPIO pin Prototype void GPIOPinConfigure unsigned long ulPinConfig Parameters ulPinConfig is the pin configuration value specified as only one of the GPIO_P _ val ues Description This function configures the pin mux that selects the peripheral function associated with a particular GPIO pin Only one peripheral function at a time can be associated with a GPIO pin and each peripheral function should only be associated with a single GPIO pin at a time despite the fact that many of them can be associa
105. stop counting when the processor is stopped by the debugger By doing so the watchdog is prevented from expiring typically almost immediately from a human time perspective and resetting the system if reset is enabled The watchdog will instead expired after the appropriate number of processor cycles have been executed while debugging or at the appropriate time after the processor has been restarted Returns None 25 2 2 16 WatchdogUnlock Disables the watchdog timer lock mechanism 400 January 11 2011 Watchdog Timer Prototype void WatchdogUnlock unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description Enables write access to the watchdog timer configuration registers Returns None 25 2 2 17 WatchdogValueGet 25 3 Gets the current watchdog timer value Prototype unsigned long WatchdogValueGet unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description This function reads the current value of the watchdog timer Returns Returns the current value of the watchdog timer Programming Example The following example shows how to set up the watchdog timer API to reset the processor after two timeouts Check to see if the registers are locked and if so unlock them if WatchdogLockState WATCHDOGO_BASE true WatchdogUnlock WATCHDOGO_BASE Initialize the watchdog timer
106. such as the ADC module used to capture real time analog data January 11 2011 11 Programming Model 12 January 11 2011 3 1 3 2 3 2 1 Analog Comparator Analog Comparator PROUT HON wack casio tdatanie ahaa palibiddebada a aa a ideas enna ananed 13 Re eR ho rales eon no ew td apenas ew een he A eee eae ees 13 Pregramnimng ExamMPIS c csccucaeieneceeoasareieeecdigpideadaneccessuadeipeeeeetnseeheasnredieanareeenties 19 Introduction The comparator API provides a set of functions for programming and using the analog comparators A comparator can compare a test voltage against an individual external reference voltage a shared single external reference voltage or a shared internal reference voltage It can provide its output to a device pin acting as a replacement for an analog comparator on the board or it can be used to signal the application via interrupts or triggers to the ADC to start capturing a sample sequence The interrupt generation logic is independent from the ADC triggering logic As a result the comparator can generate an interrupt based on one event and an ADC trigger based on another event For example an interrupt can be generated on a rising edge and the ADC triggered on a falling edge This driver is contained in driverlib comp c with driverlib comp h containing the API definitions for use by applications API Functions Functions m void ComparatorConfigure unsigned long ulBase unsigned long ulComp u
107. support is available Returns None 22 2 2 31 UARTModemStatusGet Gets the states of the RI DCD DSR and CTS modem status signals Prototype unsigned long UARTModemStatusGet unsigned long ulBase Parameters ulBase is the base address of the UART port Description Returns the current states of each of the four UART modem status signals RI DCD DSR and CTS Note The availability of hardware modem handshake signals varies with the Stellaris part and UART in use Please consult the datasheet for the part you are using to determine whether this support is available Returns Returns the states of the handshake output signals This will be a logical logical OR combination of values UART_INPUT_RI UART_INPUT_DCD UART_INPUT_CTS and UART_INPUT_DSR where the presence of each flag indicates that the associated signal is asserted 22 2 2 32 UARTParityModeGet Gets the type of parity currently being used Prototype unsigned long UARTParityModeGet unsigned long ulBase January 11 2011 323 UART Parameters ulBase is the base address of the UART port Description This function gets the type of parity used for transmitting data and expected when receiving data Returns Returns the current parity settings specified as one of UART_CONFIG_PAR_NONE UART_CONFIG_PAR_EVEN UART_CONFIG_PAR_ODD UART_CONFIG_PAR_ONE or UART_CONFIG_PAR_ZERO 22 2 2 33 UARTParityModeSet Sets the type of parity Prototyp
108. synchronous serial interface Prototype void SSIDisable unsigned long ulBase Parameters ulBase specifies the SSI module base address Description This function disables operation of the synchronous serial interface Returns None SSIDMADisable Disable SSI DMA operation Prototype void SSIDMADisable unsigned long ulBase unsigned long ulDMAFlags Parameters ulBase is the base address of the SSI port ulDMAFlags is a bit mask of the DMA features to disable Description This function is used to disable SSI DMA features that were enabled by SSIDMAEnable The specified SSI DMA features are disabled The u DMAFlags parameter is the logical OR of any of the following values SSI_DMA_RX disable DMA for receive m SSI_DMA_TX disable DMA for transmit Returns None January 11 2011 Synchronous Serial Interface SS 18 2 2 9 SSIDMAEnable Enable SSI DMA operation Prototype void SSIDMAEnable unsigned long ulBase unsigned long ulDMAFlags Parameters ulBase is the base address of the SSI port ulDMAFlags is a bit mask of the DMA features to enable Description The specified SSI DMA features are enabled The SSI can be configured to use DMA for transmit and or receive data transfers The u DMAFlags parameter is the logical OR of any of the following values m SSI_DMA_RX enable DMA for receive m SSI_DMA_TX enable DMA for transmit Note The uDMA controller
109. that utilize different parts if the part definition is provided to the compiler instead of in the source code each project can provide its own definition and the code will automatically reconfigure itself based on the target part Since the peripheral pin mapping functions configure a single pin at a time it may be more efficient to use the GPIOPinTypex functions instead of the PinTypex functions although this requires explicit knowledge of the GPIO pin s to be used For example it will take four PinTypeSSI calls to configure the four pins on the SSI peripheral but this could be done with a single call to GPI OPinTypeSSI if the pins are all in the same GPIO module But using GPIOPinTypex instead of PinTypex results in the code no longer automatically reconfiguring itself without the use of explicit conditionals in the code of course This driver is contained in driverlib pin_map h 15 2 API Functions Functions m void PeripheralEnable unsigned long ulName void PinTypeADC unsigned long ulName void PinTypeCAN unsigned long ulName void PinTypeComparator unsigned long ulName void PinTypel2C unsigned long ulName void PinTypePWM unsigned long ulName void PinTypeQE unsigned long ulName void PinTypeSSI unsigned long ulName void PinTypeTimer unsigned long ulName void PinTypeUART unsigned long ulName January 11 2011 207 Peripheral Pin Mapping 15 2 1 15 2 2 15 2 2 1 15 2 2 2 208
110. the SSIO interface This function assumes that the SSIO interface has already been configured and is currently operational Returns Never returns 26 4 2 3 ROM _UpdateUART Starts an update over the UARTO interface Prototype void ROM_Updat eUART void Description Calling this function commences an update of the firmware via the UARTO interface This function assumes that the UARTO interface has already been configured and is currently oper ational Returns Never returns 406 January 11 2011 27 Error Handling Error Handling Invalid arguments and error conditions are handled in a non traditional manner in the peripheral driver library Typically a function would check its arguments to make sure that they are valid if required some may be unconditionally valid such as a 32 bit value used as the load value for a 32 bit timer If an invalid argument is provided it would return an error code The caller then has to check the return code from each invocation of the function to make sure that it succeeded This results in a sizable amount of argument checking code in each function and return code check ing code at each call site For a self contained application this extra code becomes an unneeded burden once the application is debugged Having a means of removing it allows the final code to be smaller and therefore run faster In the peripheral driver library most functions do not return errors FlashProgram Fl
111. the actual unregistering of the interrupt handler This function will clear the handler to be called when a watchdog timer interrupt occurs This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for important information about registering interrupt handlers Returns None WatchdogLock Enables the watchdog timer lock mechanism Prototype void WatchdogLock unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description Locks out write access to the watchdog timer configuration registers Returns None WatchdogLockState Gets the state of the watchdog timer lock mechanism Prototype tBoolean WatchdogLockState unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description Returns the lock state of the watchdog timer registers Returns Returns true if the watchdog timer registers are locked and false if they are not locked WatchdogReloadGet Gets the watchdog timer reload value January 11 2011 397 Watchdog Timer Prototype unsigned long WatchdogReloadGet unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description This function gets the value that is loaded into the watchdog timer when the count reaches zero for the first time See also WatchdogReloadSet Returns
112. the meanings of all USB_INCTRL_ flags and the modes for which they are valid These values apply to any calls to USBIntStatusControl USBIntEnableControl and USBIntDisableConrol Some of these flags are only valid in the following modes as indicated in the parenthesis Host Device and OTG USB_INTCTRL_ALL A full mask of all control interrupt sources USB_INTCTRL_VBUS_ERR A VBUS error has occurred Host Only USB_INTCTRL_SESSION Session Start Detected on A side of cable OTG Only USB_INTCTRL_SESSION_END Session End Detected Device Only USB_INTCTRL_DISCONNECT Device Disconnect Detected Host Only USB_INTCTRL_CONNECT Device Connect Detected Host Only m USB_INTCTRL_SOF Start of Frame Detected USB_INTCTRL_BABBLE USB controller detected a device signaling past the end of a frame Host Only USB_INTCTRL_RESET Reset signaling detected by device Device Only USB_INTCTRL_RESUME Resume signaling detected USB_INTCTRL_SUSPEND Suspend signaling detected by device Device Only USB_INTCTRL_MODE_DETECT OTG cable mode detection has completed OTG Only January 11 2011 387 USB Controller USB_INTCTRL_POWER_FAULT Power Fault detected Host Only Note This call will clear the source of all of the control status interrupts Returns Returns the status of the control interrupts for a USB controller 24 3 2 55 USBIntStatusEndpoint Returns the endpoint interrupt status on a
113. the priority level such that all interrupts of that and lesser priority are masked A value of 0 means that priority masking is disabled Smaller numbers correspond to higher interrupt priorities So for example a priority level mask of 4 will allow interrupts of priority level 0 3 and interrupts with a numerical priority of 4 and greater will be blocked The hardware priority mechanism will only look at the upper N bits of the priority level where N is 3 for the Stellaris family so any prioritization must be performed in those bits Returns Returns the value of the interrupt priority level mask 192 January 11 2011 Interrupt Controller NVIC 13 2 2 11 IntPriorityMaskSet Sets the priority masking level Prototype void IntPriorityMaskSet unsigned long ulPriorityMask Parameters ulPriorityMask is the priority level that will be masked Description This function sets the interrupt priority masking level so that all interrupts at the specified or lesser priority level is masked This can be used to globally disable a set of interrupts with priority below a predetermined threshold A value of 0 disables priority masking Smaller numbers correspond to higher interrupt priorities So for example a priority level mask of 4 will allow interrupts of priority level 0 3 and interrupts with a numerical priority of 4 and greater will be blocked The hardware priority mechanism will only look at the upper N bits of the priority
114. this warranty Except where mandated by government requirements testing of all parameters of each product is not necessarily performed Tl assumes no liability for applications assistance or customer product design Customers are responsible for their products and applications using TI components To minimize the risks associated with customer products and applications customers should provide adequate design and operating safeguards TI does not warrant or represent that any license either express or implied is granted under any TI patent right copyright mask work right or other TI intellectual property right relating to any combination machine or process in which TI products or services are used Information published by TI regarding third party products or services does not constitute a license from TI to use such products or services or a warranty or endorsement thereof Use of such information may require a license from a third party under the patents or other intellectual property of the third party or a license from TI under the patents or other intellectual property of TI Reproduction of TI information in TI data books or data sheets is permissible only if reproduction is without alteration and is accompanied by all associated warranties conditions limitations and notices Reproduction of this information with alteration is an unfair and deceptive business practice TI is not responsible or liable for such altered documentation Inform
115. transaction 0 255 Description This function is used to configure the interface when used in general purpose operation as chosen with the function EPIModeSet The parameter u Config is the logical OR of any of the following EPl_GPMODE_CLKPIN interface clock is output on a pin EPl_GPMODE_CLKGATE clock is stopped when there is no transaction otherwise it is free running EPI GPMODE_RDYEN the external peripheral drives an iRDY signal into pin EPI0S27 If absent the peripheral is assumed to be ready at all times This flag may only be used with a free running clock EPI_GPMODE_CLKGATE is absent EPI_GPMODE_FRAMEPIN framing signal is emitted on a pin EPl_GPMODE_FRAME5S0 framing signal is 50 50 duty cycle otherwise it is a pulse EPl_GPMODE_READWRITE read and write strobes are emitted on pins EPl_GPMODE_WRITE2CYCLE a two cycle write is used otherwise a single cycle write is used EPl_GPMODE_READ2CYCLE a two cycle read is used otherwise a single cycle read is used EPl_GPMODE_ASIZE_NONE EPl_GPMODE_ASIZE_4 EPI_GPMODE_ASIZE_12 or EPl_GPMODE_ASIZE_20 to choose no address bus or and address bus size of 4 12 or 20 bits EPl_GPMODE_DSIZE_8 EPI_GPMODE_DSIZE_16 EPI_GPMODE_DSIZE 24 or EPIl_GPMODE_DSIZE_32 to select a data bus size of 8 16 24 or 32 bits EPl_GPMODE_WORD_ACCESS use Word Access mode to route bytes to the correct byte lanes allowing data to be stored in the upper bits of the word when necessary The p
116. transmit message object The message object pointed to by pMsgObject must be populated by the caller as follows ulMsg D contains the message ID either 11 or 29 bits ulMsg DMask mask of bits from u Msg D that must match if identifier filtering is enabled ulFlags e Set MSG_OBJ_TX_INT_ENABLE flag to enable interrupt on transmission e Set MSG_OBJ_RX_INT_ENABLE flag to enable interrupt on receipt e Set MSG_OBJ_USE_ID_FILTER flag to enable filtering based on the identifier mask specified by ul MsgiDMask ulMsgLen the number of bytes in the message data This should be non zero even for a remote frame it should match the expected bytes of the data responding data frame pucMsgData points to a buffer containing up to 8 bytes of data for a data frame Example To send a data frame or remote frame in response to a remote request take the following steps 1 2 3 4 5 6 Set eMsgType to MSG_OBJ_TYPE_TX Set pMsgObject gt ulMsgID to the message ID Set pMsgObject gt ulFlags Make sure to set MSG_OBJ_TX_INT_ENABLE to allow an interrupt to be generated when the message is sent Set pMsgObject gt ulMsgLen to the number of bytes in the data frame Set pMsgObject gt pucMsgData to point to an array containing the bytes to send in the message Call this function with u ObjID set to one of the 32 object buffers Example To receive a specific data frame take the following steps Set eMsgObjType to MSG_OBJ_
117. ulBase is the base address of the CAN controller pulRxCount is a pointer to storage for the receive error counter pulTxCount is a pointer to storage for the transmit error counter Description Reads the error counter register and returns the transmit and receive error counts to the caller along with a flag indicating if the controller receive counter has reached the error passive limit The values of the receive and transmit error counters are returned through the pointers provided as parameters After this call xpu RxCount will hold the current receive error count and xpulTxCount will hold the current transmit error count Returns Returns true if the receive error count has reached the error passive limit and false if the error count is below the error passive limit 5 2 5 7 CANInit Initializes the CAN controller after reset Prototype void CANInit unsigned long ulBase Parameters ulBase is the base address of the CAN controller Description After reset the CAN controller is left in the disabled state However the memory used for message objects contains undefined values and must be cleared prior to enabling the CAN controller the first time This prevents unwanted transmission or reception of data before the message objects are configured This function must be called before enabling the controller the first time Returns None 5 2 5 8 CANIntClear Clears a CAN interrupt source Prototype void CANIntCl
118. ulParity void UARTRxErrorClear unsigned long ulBase unsigned long UARTRxErrorGet unsigned long ulBase void UARTSmartCardDisable unsigned long ulBase void UARTSmartCardEnable unsigned long ulBase tBoolean UARTSpaceAvail unsigned long ulBase unsigned long UARTTxIntModeGet unsigned long ulBase void UARTTxIntModeSet unsigned long ulBase unsigned long ulMode Detailed Description The UART API provides the set of functions required to implement an interrupt driven UART driver These functions may be used to control any of the available UART ports on a Stellaris microcon troller and can be used with one port without causing conflicts with the other port The UART API is broken into three groups of functions those that deal with configuration and con trol of the UART modules those used to send and receive data and those that deal with interrupt handling Configuration and control of the UART are handled by the UARTConfigGetExpClk UARTCon figSetExpClk UARTDisable UARTEnable UARTParityModeGet and UARTParityModeSet January 11 2011 22 2 2 22 2 2 1 22 2 2 2 UART functions The DMA interface can be enabled or disabled by the UARTDMAEnable and UARTD MADisable functions Sending and receiving data via the UART is handled by the UARTCharGet UARTCharGet NonBlocking UARTCharPut UARTCharPutNonBlocking VARTBreakCtl UARTCharsAvail and UARTSpaceAvail functions Managing the U
119. ulTaskCount void xpvTaskList unsigned long ullIsPeriphSG Parameters ulChannel Num is the UDMA channel number ulTaskCount is the number of scatter gather tasks to execute pvTaskList is a pointer to the beginning of the scatter gather task list ullsPeriphSG is a flag to indicate it is a peripheral scatter gather transfer else it will be mem ory scatter gather transfer Description This function is used to configure a channel for scatter gather mode The caller must have already set up a task list and pass a pointer to the start of the task list as the pvJaskList parameter The u TaskCount parameter is the count of tasks in the task list not the size of the task list The flag b sPeriohSG should be used to indicate if the scatter gather should be configured for a peripheral or memory scatter gather operation See also uDMATaskStructEntry Returns None 23 2 3 11 uDMAChannelSelectDefault Selects the default peripheral for a set of UDMA channels Prototype void uDMAChannelSelectDefault unsigned long ulDefPeriphs January 11 2011 341 uDMA Controller Parameters ulDefPeriphs is the logical or of the UDMA channels for which to use the default peripheral instead of the secondary peripheral Description This function is used to select the default peripheral assignment for a set of UDMA channels The parameter u DefPeriphs can be the logical OR of any of the following macros If one of the macros
120. unsigned long ulBase m void WatchdogUnlock unsigned long ulBase m unsigned long Watchdog ValueGet unsigned long ulBase Detailed Description The Watchdog Timer API is broken into two groups of functions those that deal with interrupts and those that handle status and configuration The Watchdog Timer interrupts are handled by the WatchdogIntRegister WatchdogIntUnregis ter WatchdogIntEnable WatchdogIntClear and WatchdogIntStatus functions Status and configuration functions for the Watchdog Timer module are WatchdogEnable Watch dogRunning WatchdogLock WatchdogUnlock WatchdogLockState WatchdogReloadSet WatchdogReloadGet WatchdogValueGet WatchdogResetEnable WatchdogResetDisable WatchdogStallEnable and WatchdogStallDisable Function Documentation WatchdogEnable Enables the watchdog timer Prototype void WatchdogEnable unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description This will enable the watchdog timer counter and interrupt Note This function will have no effect if the watchdog timer has been locked See also WatchdogLock WatchdogUnlock Returns None WatchdogIntClear Clears the watchdog timer interrupt January 11 2011 25 2 2 3 25 2 2 4 Watchdog Timer Prototype void WatchdogIntClear unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module
121. unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint specifies the endpoint to reset the data toggle ulFlags specifies whether to access the IN or OUT endpoint Description This function will cause the controller to clear the data toggle for an endpoint This call is not valid for endpoint zero and can be made with host or device controllers The ulFlags parameter should be one of USB_EP_HOST_OUT USB_EP_HOST_IN USB_EP_DEV_OUT or USB_EP_DEV IN 366 January 11 2011 USB Controller Returns None 24 3 2 17 USBEndpointDMAChannel Sets the DMA channel to use for a given endpoint Prototype void USBEndpointDMAChannel unsigned long ulBase unsigned long ulEndpoint unsigned long ulChannel Parameters ulBase specifies the USB module base address ulEndpoint specifies which endpoint s FIFO address to return ulChannel specifies which DMA channel to use for which endpoint Description This function is used to configure which DMA channel to use with a given endpoint Receive DMA channels can only be used with receive endpoints and transmit DMA channels can only be used with transmit endpoints This allows the 3 receive and 3 transmit DMA channels to be mapped to any endpoint other than 0 The values that should be passed into the u Channel value are the UDMA_CHANNEL_USBEP values defined in udm
122. unsigned long ulPort unsigned char ucPin unsigned long pulStrength unsigned long pulPinType void GPIOPadConfigSet unsigned long ulPort unsigned char ucPins unsigned long ul Strength unsigned long ulPinType void GPIOPinConfigure unsigned long ulPinConfig void GPIOPinIntClear unsigned long ulPort unsigned char ucPins void GPIOPinIntDisable unsigned long ulPort unsigned char ucPins void GPIOPinIntEnable unsigned long ulPort unsigned char ucPins long GP IOPinIntStatus unsigned long ulPort tBoolean bMasked long GPIOPinRead unsigned long ulPort unsigned char ucPins void GPIOPinTypeADC unsigned long ulPort unsigned char ucPins void GPIOPinTypeCAN unsigned long ulPort unsigned char ucPins void GPIOPinTypeComparator unsigned long ulPort unsigned char ucPins void GPIOPinTypeEPI unsigned long ulPort unsigned char ucPins void GPIOPinTypeEthernetLED unsigned long ulPort unsigned char ucPins void GPIOPinTypeGP OlInput unsigned long ulPort unsigned char ucPins void GPIOPinTypeGP IOOutput unsigned long ulPort unsigned char ucPins void GPIOPinTypeGP IOOutputOD unsigned long ulPort unsigned char ucPins void GPIOPinTypel2C unsigned long ulPort unsigned char ucPins void GPIOPinTypel2S unsigned long ulPort unsigned char ucPins void GPIOPinTypePWM unsigned long ulPort unsigned char ucPins void GPIOPinTypeQEI unsigned long ulPort unsigned char ucPins void GPIOPinTypeSSI unsigned long ulPor
123. unsigned long ulWidth Parameters ulBase is the base address of the PWM module ulPWMoOut is the PWM output to modify Must be one of PWM_OUT_0 PWM_OUT_1 PWM_OUT_2 PWM_OUT_3 PWM_OUT 4 PWM_OUT_5 PWM_OUT 6 or PWM_OUT_7 ulWidth specifies the width of the positive portion of the pulse Description This function sets the pulse width for the specified PWM output where the pulse width is defined as the number of PWM clock ticks Note Any subsequent calls made to this function before an update occurs will cause the previous values to be overwritten Returns None 16 2 2 32 PWMSyncTimeBase Synchronizes the counters in one or multiple PWM generator blocks Prototype void PWMSyncTimeBase unsigned long ulBase unsigned long ulGenBits Parameters ulBase is the base address of the PWM module ulGenBits are the PWM generator blocks to be synchronized Must be the logical OR of any of PWM_GEN_0_ BIT PWM_GEN_1_ BIT PWM_GEN_2 BIT or PWM_GEN_3 BIT Description For the selected PWM module this function synchronizes the time base of the generator blocks by causing the specified generator counters to be reset to zero Returns None 16 2 2 33 PWMSyncUpdate Synchronizes all pending updates January 11 2011 235 Pulse Width Modulator PWM 16 3 236 Prototype void PWMSyncUpdate unsigned long ulBase unsigned long ulGenBits Parameters ulBase is the base address of the
124. when a transfer is complete The function UDMAChannelModeGei can be used to find the transfer mode of a UDMA channel This is usually used to see if the mode indicates stopped which means that a transfer has completed January 11 2011 331 uDMA Controller 332 on a channel that was previously running The function UDMAChannellsEnabled can be used to determine if a particular channel is enabled If the application is using run time interrupt registration see IntRegister then the function uD MAIntRegister can be used to install an interrupt handler for the UDMA controller This function will also enable the interrupt on the system interrupt controller If compile time interrupt registration is used then call the function IntEnable to enable uDMA interrupts When an interrupt handler has been installed with uUDMAIntRegister it can be removed by calling uUDMAIntUnregister This interrupt handler is only for software initiated transfers or errors UDMA interrupts for a periph eral occur on the peripheral s dedicated interrupt channel and should be handled by the peripheral interrupt handler It is not necessary to acknowledge or clear UDMA interrupt sources They are cleared automatically when they are serviced The uDMA interrupt handler should use the function uUDMAErrorStatusGet to test if a UDMA error occurred If so the interrupt must be cleared by calling UDMAErrorStatusClear Note Many of the API functions tak
125. www ti com wireless Mailing Address Texas Instruments Post Office Box 655303 Dallas Texas 75265 Copyright 2006 2011 Texas Instruments Incorporated 408 January 11 2011
126. 1 The channel select must be the number of the channel pair to sample for example ADC_CTL_CHO for 0 and 1 or ADC_CTL_CH1 for 2 and 3 or undefined results will be returned by the ADC Additionally if differential mode is selected when the temperature sensor is being sampled undefined results will be returned by the ADC It is the responsibility of the caller to ensure that a valid configuration is specified this function does not check the validity of the specified configuration Returns None ADCSequenceUnderflow Determines if a sample sequence underflow occurred Prototype long ADCSequenceUnderflow unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description This determines if a sample sequence underflow has occurred This will happen if too many samples are read from the FIFO Returns Returns zero if there was not an underflow and non zero if there was ADCSequenceUnderflowClear Clears the underflow condition on a sample sequence January 11 2011 37 Analog to Digital Converter ADC 4 2 2 29 4 2 2 30 38 Prototype void ADCSequenceUnderflowClear unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description This will clear an underflow condition on one of the samp
127. 12S 12 2 2 20 l2STxEnable Enables the I2S transmit module for operation Prototype void I2STxEnable unsigned long ulBase Parameters ulBase is the 2S module base address Description This function enables the transmit module for operation The module should be enabled after configuration When the module is disabled no data or clocks will be generated on the 12S signals Returns None 12 2 2 21 I2STxFlFOLevelGet Gets the number of samples in the transmit FIFO Prototype unsigned long I2STxFIFOLevelGet unsigned long ulBase Parameters ulBase is the 2S module base address Description This function is used to get the number of samples in the transmit FIFO For the purposes of measuring the FIFO level a left right sample pair counts as 2 whether the mode is dual or compact stereo When mono mode is used internally the mono sample is still treated as a sample pair so a single mono sample counts as 2 Since the FIFO always deals with sample pairs normally the level will be an even number from 0 to 16 If dual stereo mode is used and only the left sample has been written without the matching right sample then the FIFO level will be an odd value If the FIFO level is odd it indicates a left right sample mismatch Returns Returns the number of samples in the transmit FIFO which will normally be an even number 12 2 2 22 I2STxFIFOLimitGet Gets the current setting of the FIFO service request level
128. 5 Analog to Digital Converter ADC 4 2 2 25 4 2 2 26 36 Returns Returns zero if there was not an overflow and non zero if there was ADCSequenceOverflowClear Clears the overflow condition on a sample sequence Prototype void ADCSequenceOverflowClear unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description This will clear an overflow condition on one of the sample sequences The overflow condition must be cleared in order to detect a subsequent overflow condition it otherwise causes no harm Returns None ADCSequenceStepConfigure Configure a step of the sample sequencer Prototype void ADCSequenceStepConfigure unsigned long ulBase unsigned long ulSequenceNum unsigned long ulStep unsigned long ulConfig Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number ulStep is the step to be configured ulConfig is the configuration of this step must be a logical OR of ADC_CTL_TS ADC_CTL_IE ADC_CTL_END ADC_CTL_D and one of the input channel selects ADC_CTL_CHO through ADC_CTL_CH15 For parts with the digital comparator feature the follow values may also be OR d into the u Config value to enable the digital compara ter feature ADC_CTL_CE and one of the comparater selects ADC_CTL_CMPO0 through ADC_CTL_CMP7 Description
129. ADC_PHASE_112_5 ADC _PHASE_ 135 ADC PHASE 157 5 ADC PHASE 180 ADC PHASE 202 5 ADC _PHASE_ 225 ADC PHASE _ 247 5 ADC PHASE 270 ADC PHASE 292 5 ADC_PHASE_ 315 or ADC_PHASE_337_5 4 2 2 16 ADCPhaseDelaySet Sets the phase delay between a trigger and the start of a sequence Prototype void ADCPhaseDelaySet unsigned long ulBase unsigned long ulPhase Parameters ulBase is the base address of the ADC module ulPhase is the phase delay specified as one of ADC_PHASE_0 ADC_PHASE 22 5 ADC PHASE 45 ADC PHASE 67 5 ADC PHASE 90 ADC _PHASE_112_ 5 ADC PHASE 135 ADC PHASE 157 5 ADC PHASE 180 ADC PHASE 202 5 ADC PHASE 225 ADC_PHASE 247 5 ADC PHASE 270 ADC PHASE 292 5 ADC_PHASE_315 or ADC_PHASE_337_5 Description This function sets the phase delay between the detection of an ADC trigger event and the start of the sample sequence By selecting a different phase delay for a pair of ADC modules such as ADC_PHASE_0 and ADC_PHASE_180 and having each ADC module sample the same analog input it is possible to increase the sampling rate of the analog input with samples N N 2 N 4 and so on coming from the first ADC and samples N 1 N 3 N 5 and so on coming from the second ADC The ADC module has a single phase delay that is applied to all sample sequences within that module Note This capability is not available on all parts Returns None 4 2 2 17 ADCProcessorTrigger Causes a processor trigger for a
130. AN controller pClikParms points to the structure with the clock parameters Description Configures the various timing parameters for the CAN bus bit timing Propagation segment Phase Buffer 1 segment Phase Buffer 2 segment and the Synchronization Jump Width The values for Propagation and Phase Buffer 1 segments are derived from the combina tion pCikParms gt uSyncPropPhase1Seg parameter Phase Buffer 2 is determined from the pCikParms gt uPhase2Seg parameter These two parameters along with pC kParms gt uSJW are based in units of bit time quanta The actual quantum time is determined by the pC ikParms gt uQuantumPrescaler value which specifies the divisor for the CAN module clock The total bit time in quanta will be the sum of the two Seg parameters as follows bit_time_gq uSyncPropPhase1Seg uPhase2Seg 1 Note that the Sync_Seg is always one quantum in duration and will be added to derive the correct duration of Prop_Seg and Phase1_Seg The equation to determine the actual bit rate is as follows CAN Clock uSyncPropPhase1Seg uPhase2Seg 1 x uQuantumPrescaler This means that with uSyncPropPhase1Seg 4 uPhase2Seg 1 uQuantumPrescaler 2 and an 8 MHz CAN clock that the bit rate will be 8 MHz 5 2 1 x 2 or 500 Kbit sec This function replaces the original CANSetBitTiming API and performs the same actions A macro is provided in can h to map the original API to this API Returns None Ja
131. ANNEL_SSI1RX for SSI1 receive UDMA_SEC_CHANNEL_SSI1TX for SSI1 transmit UDMA_SEC_CHANNEL_UART2RX_12 for UART2 receive using UDMA channel 12 January 11 2011 uDMA Controller UDMA_SEC_CHANNEL_UART2TX_13 for UART2 transmit using UDMA channel 13 UDMA_SEC_CHANNEL_TMR2A_14 for Timer 2A using UDMA channel 14 UDMA_SEC_CHANNEL_TMR2B_15 for Timer 2B using UDMA channel 15 UDMA_SEC_CHANNEL_TMRI1A for Timer 1A UDMA_SEC_CHANNEL_TMR1B for Timer 1B UDMA_SEC_CHANNEL_EPIORX for EPI read UDMA_SEC_CHANNEL_EPIOTX for EPI write UDMA_SEC_CHANNEL_ADC10 for ADC1 sequencer 0 UDMA_SEC_CHANNEL_ADC11 for ADC1 sequencer 1 m UDMA_SEC_CHANNEL_ADC12 for ADC1 sequencer 2 UDMA_SEC_CHANNEL_ADC13 for ADC1 sequencer 3 UDMA_SEC_CHANNEL_SW for the software dedicated uUDMA channel 23 2 2 Define Documentation 23 2 2 1 uDMATaskStructEntry A helper macro for building scatter gather task table entries Definition define uDMATaskStructEntry ulTransferCount lItemSize lSrcIncrement vSrcAddr 1DstIncrement vDstAddr lArbSize 1Mode E G D ct ag Parameters ulTransferCount is the count of items to transfer for this task ulltemSize is the bit size of the items to transfer for this task ulSrcincrement is the bit size increment for source data pvSrcAddr is the starting address of the data to transfer ulDstincrement is the bit size increment for destination data pvDstAdadr is the starting address of the destination da
132. ART interrupts is handled by the UARTIntClear UARTIntDisable UARTIntEn able UARTIntRegister UARTIntStatus and UARTIntUnregister functions The UARTConfigSet UARTConfigGet UARTCharNonBlockingGet and UARTCharNonBlock ingPut APIs from previous versions of the peripheral driver library have been replaced by the UARTConfigSetExpClk UARTConfigGetExpClk UARTCharGetNonBlocking and UARTCharPutNonBlocking APIs respectively Macros have been provided in uart h to map the old APIs to the new APIs allowing existing applications to link and run with the new APIs It is recommended that new applications utilize the new APIs in favor of the old ones Function Documentation UARTBreakCll Causes a BREAK to be sent Prototype void UARTBreakCtl unsigned long ulBase tBoolean bBreakState Parameters ulBase is the base address of the UART port bBreakState controls the output level Description Calling this function with bBreakState set to true asserts a break condition on the UART Calling this function with bBreakState set to false removes the break condition For proper transmis sion of a break command the break must be asserted for at least two complete frames Returns None UARTBusy Determines whether the UART transmitter is busy or not Prototype tBoolean UARTBusy unsigned long ulBase Parameters ulBase is the base address of the UART port January 11 2011 309 UART 22 2
133. B interrupts Prototype unsigned long USBIntStatus unsigned long ulBase Parameters ulBase specifies the USB module base address 386 January 11 2011 USB Controller Description This function will read the source of the interrupt for the USB controller There are three groups of interrupt sources IN Endpoints OUT Endpoints and general status changes This call will return the current status for all of these interrupts The bit values returned should be compared against the USB_HOST_IN USB_HOST_OUT USB_HOST_EP0O USB_DEV_IN USB_DEV_OUT and USB_DEV_EP0 values Note This call will clear the source of all of the general status interrupts WARNING This API cannot be used on endpoint numbers greater than endpoint 3 so US BintStatusControl or USBIntStatusEndpoint should be used instead Returns Returns the status of the sources for the USB controller s interrupt 24 3 2 54 USBIntStatusControl Returns the control interrupt status on a given USB controller Prototype unsigned long USBIntStatusControl unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function will read control interrupt status for a USB controller This call will return the current status for control interrupts only the endpoint interrupt status is retrieved by calling USBIntStatusEndpoint The bit values returned should be compared against the USB_INTCTRL_ values The following are
134. BOTGSessionRequest unsigned long ulBase tBoolean bStart void USBPHY PowerOff unsigned long ulBase void USBPHYPowerOn unsigned long ulBase Detailed Description The USB APIs provide all of the functions needed by an application to implement a USB device or USB host stack The APIs abstract the IN OUT nature of endpoints based on the type of USB controller that is in use Any API that uses the IN OUT terminology will comply with the standard USB interpretation of these terms For example an OUT endpoint on a microcontroller that has only a device interface will actually receive data on this endpoint while a microcontroller that has a host interface will actually transmit data on an OUT endpoint Another important fact to understand is that all endpoints in the USB controller whether host or device have two sides to them This allows each endpoint to both transmit and receive data An application can use a single endpoint for both and IN and OUT transactions For example In device mode endpoint 1 could be configured to have BULK IN and BULK OUT handled by endpoint 1 It is important to note that the endpoint number used is the endpoint number reported to the host For microcontrollers with host controllers the application can use an endpoint communicate with January 11 2011 357 USB Controller 24 3 2 24 3 2 1 358 both IN and OUT endpoints of different types as well For example Endpoint 2 could be used to communicate with
135. Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None 11 2 2 13 2CMasterIntDisable Disables the 12C Master interrupt Prototype void I2CMasterIntDisable unsigned long ulBase 160 January 11 2011 Inter Integrated Circuit 12C Parameters ulBase is the base address of the I2C Master module Description Disables the 12C Master interrupt source Returns None 11 2 2 14 l2CMasterlntEnable Enables the I2C Master interrupt Prototype void I2CMasterIntEnable unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description Enables the 12C Master interrupt source Returns None 11 2 2 15 2CMasterlntStatus Gets the current 12C Master interrupt status Prototype tBoolean I2CMasterIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the base address of the I2C Master module bMasked is false if the raw interrupt status is requested and true if the maske
136. DCSoftwareOversampleConfigure ADCSoft wareOversampleStepConfigure and ADCSoftwareOversampleDataGet The processor trigger is generated with ADCProcessorTrigger The interrupt handler for the ADC sample sequence interrupts are managed with ADCIntRegister and ADCIntUnregister The sample sequence interrupt sources are managed with ADCIntDis able ADCIntEnable ADCIntStatus and ADCIntClear Function Documentation ADCComparatorConfigure Configures an ADC digital comparator Prototype void ADCComparatorConfigure unsigned long ulBase unsigned long ulComp unsigned long ulConfig Parameters ulBase is the base address of the ADC module ulComp is the index of the comparator to configure ulConfig is the configuration of the comparator Description This function will configure a comparator The u Config parameter is the result of a logical OR operation between the ADC_COMP_TRIG_xxx and ADC_COMP_INT_xxx values The ADC_COMP_TRIG_xxx term can take on the following values ADC_COMP_TRIG_NONE to never trigger PWM fault condition ADC_COMP_TRIG_LOW_ALWAYS to always trigger PWM fault condition when ADC out put is in the low band ADC_COMP_TRIG_LOW_ONCE io trigger PWM fault condition once when ADC output transitions into the low band ADC_COMP_TRIG_LOW_HALWAYS to always trigger PWM fault condition when ADC output is in the low band only if ADC output has been in the high band since the la
137. DEMUX EPI_HB16_MODE_SRA M or EPI_HB16_MODE_FIFO to select the HB16 mode EPI_HB16_USE_TXEMPTY enable TXEMPTY signal with FIFO EPI_HB16_USE_RXFULL enable RXFULL signal with FIFO EPI_HB16_WRHIGH use active high write strobe otherwise it is active low EP I_HB16_RDHIGH use active high read strobe otherwise it is active low one of EPI_HB16 WRWAIT_0O EPI_HB16_WRWAIT_1 EPI_HB16_WRWAIT_2 or EPI_HB16_ WRWAIT_3 to select the number of write wait states default is 0 wait states m one of EPIHB16_RDWAIT_0 EPI _HB16_ RDWAIT_1 EPI_HB16_RDWAIT 2 or EPIl_HB16_RDWAIT_3 to select the number of read wait states default is 0 wait states EPI_HB16_WORD_ACCESS use Word Access mode to route bytes to the correct byte lanes allowing data to be stored in bits 31 8 If absent all data transfers use bits 7 0 EPI_HB16_BSEL enables byte selects In this mode two EPI signals operate as byte selects allowing 8 bit transfers If this flag is not specified data must be read and written using only 16 bit transfers EPl_HB16_CSBAUD_DUAL use different baud rates when accessing devices on each CSn CSOn uses the baud rate specified by the lower 16 bits of the divider passed to EP DividerSet and CS1n uses the divider passed in the upper 16 bits If this option is absent both chip selects use the baud rate resulting from the divider in the lower 16 bits of the parameter passed to EP DividerSet m one of EPI_HB16_CSCFG_CS EPI_HB16_CSCFG_ALE
138. DE_DEV USB_OTG_MODE_NONE USB_DUAL_MODE_HOST USB_DUAL_MODE_DEVICE or USB_DUAL_MODE_NONE 24 3 2 58 USBOTGSessionRequest Starts or ends a session January 11 2011 389 USB Controller Prototype void USBOTGSessionRequest unsigned long ulBase tBoolean bStart Parameters ulBase specifies the USB module base address bStart specifies if this call starts or ends a session Description This function is used in OTG mode to start a session request or end a session If the bStart parameter is set to true then this function start a session and if it is false it will end a session Returns None 24 3 2 59 USBPHYPowerOff Powers off the USB PHY Prototype void USBPHYPowerOff unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function will power off the USB PHY reducing the current consuption of the device While in the powered off state the USB controller will be unable to operate Returns None 24 3 2 60 USBPHYPowerOn Powers on the USB PHY Prototype void USBPHYPowerOn unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function will power on the USB PHY enabling it return to normal operation By default the PHY is powered on so this function only needs to be called if USBPHYPowerOff has previously been called Returns None 390 January 11 2011 24 4 Programming Example
139. DMA_SIZE_8 UDMA_SIZE_16 or UDMA_SIZE_32 to select a data size of 8 16 or 32 bits Choose the source address increment from one of UDMA_SRC INC 8 UDMA_SRC_INC_16 UDMA_SRC_INC_32 or UDMA_SRC_INC_NONE io select an address increment of 8 bit bytes 16 bit halfwords 32 bit words or to select non incrementing Choose the destination address increment from one of UDMA_DST_INC 8 UDMA_DST_INC_16 UDMA_DST_INC_32 or UDMA_DST_INC_NONE to select an address increment of 8 bit bytes 16 bit halfwords 32 bit words or to select non incrementing The arbitration size determines how many items are transferred before the uDMA controller re arbitrates for the bus Choose the arbitration size from one of UDMA_ARB_1 UDMA_ARB_2 UDMA_ARB_4 UDMA_ARB 8 through UDMA_ARB_ 1024 to select the arbitration size from 1 to 1024 items in powers of 2 January 11 2011 23 2 3 5 23 2 3 6 uDMA Controller The value UDMA_NEXT_USEBURST is used to force the channel to only respond to burst requests at the tail end of a scatter gather transfer Note The address increment cannot be smaller than the data size Returns None uDMAChannelDisable Disables a UDMA channel for operation Prototype void uDMAChannelDisable unsigned long ulChannelNum Parameters ulChannelNum is the channel number to disable Description This function disables a specific UDMA channel Once disabled a channel will not respond to uDMA transfer requests until re en
140. DO 2 25V SYSCTL_LDO 2 30V SYSCTL_LDO 2 35V SYSCTL_LDO 2 40V SYSCTL_LDO 2 45V SYSCTL_LDO_ 2 _50V SYSCTL_LDO_2_55V SYSCTL_LDO 2 60V SYSCTL_LDO 2 65V SYSCTL_LDO 2 70V or SYSCTL_LDO 2 75V 19 2 2 22 SysCtlLDOSet Sets the output voltage of the LDO Prototype void SysCt1LDOSet unsigned long ulVoltage Parameters ulVoltage is the required output voltage from the LDO Must be one of SYSCTL_LDO_2_ 25V SYSCTL_LDO 2 30V SYSCTL_LDO 2 35V SYSCTL_LDO 2 40V SYSCTL_LDO 2 45V SYSCTL_LDO 2 _50V SYSCTL_LDO_2_55V January 11 2011 271 System Control SYSCTL_LDO_2 60V SYSCTL_LDO_2_ 65V SYSCTL_LDO_2 70V or SYSCTL_LDO_2_75V Description This function sets the output voltage of the LDO The default voltage is 2 5 V it can be adjusted 10 Returns None 19 2 2 23 SysCtIMOSCVerificationSet Configures the main oscillator verification timer Prototype void SysCt1lMOSCVerificationSet tBoolean bEnable Parameters bEnable is a boolean that is true if the main oscillator verification timer should be enabled Description This function allows the main oscillator verification timer to be enabled or disabled When enabled an interrupt will be generated if the main oscillator ceases to operate The main oscillator verification timer is only available on Sandstorm class devices Note Both oscillators main and internal must be enabled for this verification timer to operate as the internal oscillator will ve
141. E VelocityGet The interrupt handler for the QEI interrupt is managed with QElIntRegister and QElIntUnregis ter The individual interrupt sources within the QEI module are managed with QElIntEnable QElIntDisable QElIntStatus and QElIntClear Function Documentation QEIConfigure Configures the quadrature encoder January 11 2011 Quadrature Encoder QE Prototype void QETConfigure unsigned long ulBase unsigned long ulConfig unsigned long ulMaxPosition Parameters ulBase is the base address of the quadrature encoder module ulConfig is the configuration for the quadrature encoder See below for a description of this parameter ulMaxPosition specifies the maximum position value Description This will configure the operation of the quadrature encoder The u Config parameter provides the configuration of the encoder and is the logical OR of several values QEI_CONFIG_CAPTURE_A or QEIl_CONFIG_CAPTURE_A_B to specify if edges on channel A or on both channels A and B should be counted by the position integrator and velocity accumulator QEI_CONFIG_NO_RESET or QEI_CONFIG_RESET_IDX to specify if the position inte grator should be reset when the index pulse is detected QEI_CONFIG_QUADRATURE or QEI_CONFIG_CLOCK_DIR to specify if quadrature sig nals are being provided on ChA and ChB or if a direction signal and a clock are being provided instead QEI_CONFIG_NO_SWAP or QEI_CONFIG_SWAP to
142. EN_MODE_LATCH_FAULT in the ulConfig parameter in which case the returned status is the latched fault trigger status If latched faults are configured the application must call PWMGenFaultClear to clear each trigger Note This function is only available on devices supporting extended PWM fault handling Returns Returns the current state of the fault triggers for the given PWM generator A set bit indicates that the associated trigger is active For PWM_FAULT_GROUP_ the returned value will be a logical OR of PWM_FAULT_FAULT0 PWM_FAULT_FAULT1 PWM_FAULT_FAULT2 or PWM_FAULT_FAULT3 For PWM_FAULT_GROUP_1 the return value will be the logical OR of PWM_FAULT_DCMP0 PWM_FAULT_DCMP1 PWM_FAULT_DCMP2 PWM_FAULT_DCMP3 PWM_FAULT_DCMP4 PWM_FAULT_DCMP5 PWM_FAULT_DCMP6 or PWM_FAULT_DCMP7 January 11 2011 Pulse Width Modulator PWM 16 2 2 138 PWMGenFaultTriggerGet Returns the set of fault triggers currently configured for a given PWM generator Prototype unsigned long PWMGenFaultTriggerGet unsigned long ulBase unsigned long ulGen unsigned long ulGroup Parameters ulBase is the base address of the PWM module ulGen is the PWM generator whose fault triggers are being queried Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 ulGroup indicates the subset of faults that are being queried This must be PWM_FAULT_GROUP_0 or PWM_FAULT_GROUP_1 Description This function allows an application to quer
143. EPI_HB16_CSCFG_DUAL_CS or EPI_HB16_CSCFG_ALE DUAL CS EPI_HB16_ CSCFG_CS sets EPI30 to operate as a Chip Select CSn sig nal EPILHB16 CSCFG_ALE sets EPI30 to operate as an address latch ALE January 11 2011 89 External Peripheral Interface EP 7 2 2 4 90 EPI_HB16_CSCFG_DUAL_CS sets EPI30 to operate as CSOn and EPI27 as CS1n with the asserted chip select determined from the most significant address bit for the respective external address map EPI_HB16_CSCFG_ALE DUAL CS sets EPI30 as an address latch ALE EPI27 as CSOn and EPI26 as CS1n with the asserted chip select determined from the most significant address bit for the respective external address map The parameter u MaxWait is used if the FIFO mode is chosen If a FIFO is used along with RXFULL or TXEMPTY ready signals then this parameter determines the maximum number of clocks to wait when the transaction is being held off by by the FIFO using one of these ready signals A value of 0 means to wait forever Returns None EPIConfigHB8Set Configures the interface for Host bus 8 operation Prototype void EPIConfigHB8Set unsigned long ulBase unsigned long ulConfig unsigned long ulMaxWait Parameters ulBase is the EPI module base address ulConfig is the interface configuration ulMaxWait is the maximum number of external clocks to wait if a FIFO ready signal is holding off the transaction Description This function is used to co
144. ERROR Failed to communicate with a device using this OUT end point a USB_HOST_OUT_FIFO_NE This endpoint s OUT FIFO is not empty USB_HOST_OUT_PKTPEND The data transfer on this OUT endpoint has not com pleted USB_HOST_EPO_NAK_TO NAKS received on endpoint zero for more than the specified timeout period USB_HOST_EPO_ERROR The device failed to respond to a request on endpoint zero USB_HOST_EPO_IN_ STALL A stall was received on endpoint zero for an IN transaction USB_HOST_EPO_IN_PKTRDY Data packet ready on endpoint zero for an IN transaction The following are the status flags for device mode USB_DEV_OUT_SENT_STALL A stall was sent on this OUT endpoint USB_DEV_OUT_DATA_ERROR There was a CRC or bit stuff error on an OUT endpoint a USB_DEV_OUT_OVERRUN An OUT packet was not loaded due to a full FIFO a USB_DEV_OUT_FIFO_FULL The OUT endpoint s FIFO is full a USB_DEV_OUT_PKTRDY There is a data packet ready in the OUT endpoint s FIFO USB_DEV_IN_NOT_COMP A larger packet was split up more data to come USB_DEV_IN_SENT_STALL A stall was sent on this IN endpoint USB_DEV_IN_UNDERRUN Data was requested on the IN endpoint and no data was ready USB_DEV_IN_FIFO_NE The IN endpoint s FIFO is not empty USB_DEV_IN_PKTPEND The data transfer on this IN endpoint has not completed USB_DEV_EPO SETUP _END A control transaction ended before Data End condition was sent USB_D
145. EV_EPO SENT_STALL A stall was sent on endpoint zero USB_DEV_EPO_IN_PKTPEND The data transfer on endpoint zero has not completed USB_DEV_EPO_OUT_PKTRDY There is a data packet ready in endpoint zero s OUT FIFO Returns The current status flags for the endpoint depending on mode 24 3 2 21 USBFIFOAddrGet Returns the absolute FIFO address for a given endpoint January 11 2011 369 USB Controller Prototype unsigned long USBFIFOAddrGet unsigned long ulBase unsigned long ulEndpoint Parameters ulBase specifies the USB module base address ulEndpoint specifies which endpoint s FIFO address to return Description This function returns the actual physical address of the FIFO This is needed when the USB is going to be used with the uDMA controller and the source or destination address needs to be set to the physical FIFO address for a given endpoint Returns None 24 3 2 22 USBFIFOConfigGet Returns the FIFO configuration for an endpoint Prototype void USBFIFOConfigGet unsigned long ulBase unsigned long ulEndpoint unsigned long xpulFIFOAddress unsigned long pulFIFOSize unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access pulFlFOAddress is the starting address for the FIFO pulFIFOSize is the size of the FIFO in bytes ulFlags specifies what information to retrieve from the FIFO configuration
146. FG_CS EPI_HB8_ CSCFG_ALE EPI_HB8_CSCFG_DUAL_CS or EPI_HB8 CSCFG_ALE_DUAL_CS EPl_HB8 CSCFG_CS sets EPI30 to operate as a Chip Select CSn signal EPI_LHB8_CSCFG_ALE sets EPI30 to operate as an address latch ALE EPLHB8 CSCFG_DUAL_CS sets EPI30 to operate as CSOn and EPI27 as CS1n with the asserted chip select determined from the most significant address bit for the respective external address map EPI_HB8_ CSCFG_ALE DUAL CS sets EPI30 as an address latch ALE EPI27 as CSOn and EPI26 as CSin with the asserted chip select determined from the most significant address bit for the respective external address map The parameter u MaxWait is used if the FIFO mode is chosen If a FIFO is used along with RXFULL or TXEMPTY ready signals then this parameter determines the maximum number of clocks to wait when the transaction is being held off by by the FIFO using one of these ready signals A value of 0 means to wait forever Returns None 7 2 2 5 EPlConfigSDRAMSet Configures the SDRAM mode of operation Prototype void EPIConfigSDRAMSet unsigned long ulBase unsigned long ulConfig unsigned long ulRefresh Parameters ulBase is the EPI module base address ulConfig is the SDRAM interface configuration ulRefresh is the refresh count in core clocks 0 2047 Description January 11 2011 This function is used to configure the SDRAM interface when the SDRAM mode is chosen with the function EPIModeSet The pa
147. Get Gets the timer load value Prototype unsigned long TimerLoadGet unsigned long ulBase unsigned long ulTimer Parameters ulBase is the base address of the timer module ulTimer specifies the timer must be one of TIMER_A or TIMER_B Only TIMER_A should be used when the timer is configured for 32 bit operation Description This function gets the currently programmed interval load value for the specified timer Returns Returns the load value for the timer 21 2 2 16 TimerLoadSet Sets the timer load value Prototype void TimerLoadSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue Parameters ulBase is the base address of the timer module ulTimer specifies the timer s to adjust must be one of TIMER_A TIMER_B or TIMER_BOTH Only TIMER_A should be used when the timer is configured for 32 bit operation ulValue is the load value Description This function sets the timer load value if the timer is running then the value will be immediately loaded into the timer Returns None 300 January 11 2011 Timer 21 2 2 17 TimerMatchGet Gets the timer match value Prototype unsigned long TimerMatchGet unsigned long ulBase unsigned long ulTimer Parameters ulBase is the base address of the timer module ulTimer specifies the timer must be one of TIMER_A or TIMER_B Only TIMER_A should be used when the timer is configured for 32 bit operation
148. H and PWM_FAULTn_SENSE_LOW January 11 2011 223 Pulse Width Modulator PWM Description This function sets the minimum fault period for a given generator along with the sense of each of the 4 possible fault inputs The minimum fault period is expressed in PWM clock cycles and takes effect only if PWMGenConfigure is called with flag PWM_GEN_MODE_FAULT_PER set in the u Config parameter When a fault input is asserted the minimum fault period timer ensures that it remains asserted for at least the number of clock cycles specified Note This function is only available on devices supporting extended PWM fault handling Returns None 16 2 2 12 PWMGenFaultStatus 224 Returns the current state of the fault triggers for a given PWM generator Prototype unsigned long PWMGenFaultStatus unsigned long ulBase unsigned long ulGen unsigned long ulGroup Parameters ulBase is the base address of the PWM module ulGen is the PWM generator whose fault trigger states are being queried Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 ulGroup indicates the subset of faults that are being queried This must be PWM_FAULT_GROUP_0 or PWM_FAULT_GROUP_1 Description This function allows an application to query the current state of each of the fault trigger inputs to a given PWM generator The current state of each fault trigger input is returned unless PWMGenConfigure has previously been called with flag PWM_G
149. HibClk is the rate of the clock supplied to the Hibernation module Description Enables the Hibernation module for operation This function should be called before any of the Hibernation module features are used The peripheral clock will be the same as the processor clock This will be the value returned by SysCtlClockGet or it can be explicitly hard coded if it is constant and known to save the code execution overhead of a call to SysCtlClockGet This function replaces the original HibernateEnable API and performs the same actions A macro is provided in hibernate h to map the original API to this API Returns None 10 2 2 6 HibernatelntClear Clears pending interrupts from the Hibernation module Prototype void HibernateIntClear unsigned long ulIntFlags Parameters ullntFlags is the bit mask of the interrupts to be cleared Description Clears the specified interrupt sources This must be done from within the interrupt handler or else the handler will be called again upon exit The ulintFlags parameter has the same definition as the ullntFlags parameter to the Hiber nateIntEnable function Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt h
150. HibernateIntRegister void pfnHandler void January 11 2011 Hibernation Module Parameters pfnHandler points to the function to be called when a hibernation interrupt occurs Description Registers the interrupt handler in the system interrupt controller The interrupt is enabled at the global level but individual interrupt sources must still be enabled with a call to HibernatelntEn able See also IntRegister for important information about registering interrupt handlers Returns None 10 2 2 10 HibernatelntStatus 10 2 2 11 Gets the current interrupt status of the Hibernation module Prototype unsigned long HibernateIntStatus tBoolean bMasked Parameters bMasked is false to retrieve the raw interrupt status and true to retrieve the masked interrupt status Description Returns the interrupt status of the Hibernation module The caller can use this to determine the cause of a hibernation interrupt Either the masked or raw interrupt status can be returned Returns Returns the interrupt status as a bit field with the values as described in the HibernatelntEn able function HibernatelntUnregister Unregisters an interrupt handler for the Hibernation module interrupt Prototype void HibernateIntUnregister void Description Unregisters the interrupt handler in the system interrupt controller The interrupt is disabled at the global level and the interrupt handler will no longer be call
151. Interrupts from the SSI module are managed using the SSllntClear SSllntDisable SSIlntEn able SSIIntRegister SSIIntStatus and SSIIntUnregister functions The SSIConfig SSIDataNonBlockingGet and SSIDataNonBlockingPut APIs from previous versions of the peripheral driver library have been replaced by the SSIConfigSetExpClk SSI DataGetNonBlocking and SSIDataPutNonBlocking APIs Macros have been provided in ssi h to map the old APIs to the new APIs allowing existing applications to link and run with the new APIs It is recommended that new applications utilize the new APIs in favor of the old ones Function Documentation SSIBusy Determines whether the SSI transmitter is busy or not Prototype tBoolean SSIBusy unsigned long ulBase Parameters ulBase is the base address of the SSI port Description Allows the caller to determine whether all transmitted bytes have cleared the transmitter hard ware lf false is returned then the transmit FIFO is empty and all bits of the last transmitted word have left the hardware shift register Returns Returns true if the SSI is transmitting or false if all transmissions are complete January 11 2011 Synchronous Serial Interface SS 18 2 2 2 SSlConfigSetExpClk Configures the synchronous serial interface Prototype void SSIConfigSetExpClk unsigned long ulBase unsigned long ulSSIC1k unsigned long ulProtocol unsigned long ulMode unsigned l
152. L_INT_MOSC FAIL SYSCTL_INT_POR SYSCTL_INT_BOR and or SYSCTL_INT_PLL_FAIL 267 System Control Description The specified system control interrupt sources are cleared so that they no longer assert This must be done in the interrupt handler to keep it from being called again immediately upon exit Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None 19 2 2 14 SysCtllntDisable Disables individual system control interrupt sources Prototype void SysCtlIntDisable unsigned long ullInts Parameters ullnts is a bit mask of the interrupt sources to be disabled Must be a logical OR of SYSCTL_INT_PLL_LOCK SYSCTL_INT_CUR_LIMIT SYSCTL_INT_IOSC FAIL SYSCTL_INT_MOSC FAIL SYSCTL_INT_POR SYSCTL_INT_BOR and or SYSCTL_INT_PLL_FAIL Description Disables the indicated system control interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor Returns None
153. MERO SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_TEMP SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO or SYSCTL_PERIPH_WDOG1 Returns None 19 2 2 31 SysCtlPeripheralSleepDisable Disables a peripheral in sleep mode Prototype void SysCt1lPeripheralSleepDisable unsigned long ulPeripheral Parameters ulPeripheral is the peripheral to disable in sleep mode Description January 11 2011 This function causes a peripheral to stop operating when the processor goes into sleep mode Disabling peripherals while in sleep mode helps to lower the current draw of the device If en abled via SysCtlPeripheralEnable the peripheral will automatically resume operation when the processor leaves sleep mode maintaining its entire state from before sleep mode was entered Sleep mode clocking of peripherals must be enabled via SysCtlPeripheralClockGating if dis abled the peripheral sleep mode configuration is maintained but has no effect when sleep mode is entered The ulPeripheral parameter must be only one of the following values SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CANO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_G
154. Modulator PWM 16 2 2 8 16 2 2 9 222 Note Changes to the counter mode will affect the period of the PWM signals produced PWMGen PeriodSet and PWMPulseWidthSet should be called after any changes to the counter mode of a generator Returns None PWMGenDisable Disables the timer counter for a PWM generator block Prototype void PWMGenDisable unsigned long ulBase unsigned long ulGen Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to be disabled Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_ 2 or PWM_GEN_3 Description This function blocks the PWM clock from driving the timer counter for the specified generator block Returns None PWMGenEnable Enables the timer counter for a PWM generator block Prototype void PWMGenEnable unsigned long ulBase unsigned long ulGen Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to be enabled Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_ 2 or PWM_GEN_3 Description This function allows the PWM clock to drive the timer counter for the specified generator block Returns None January 11 2011 Pulse Width Modulator PWM 16 2 2 10 PWMGenFaultClear 16 2 2 11 Clears one or more latched fault triggers for a given PWM generator Prototype void PWMGenFaultClear unsigned long ulBase unsigned long ulGen unsigned long ulGroup unsigned long ulFault
155. NMessageGet The pucMsgData variable in tC ANMsgObject is the pointer to the data to send ulMsgLen bytes or the pointer to the buffer to read ulMsgLen bytes into 5 4 Programming Examples This example code will send out data from CAN controller 0 to be received by CAN controller 1 In order to actually receive the data an external cable must be connected between the two ports In this example both controllers are configured for 1 Mbit operation tCANBitClkParms CANBitClk tCANMsgObject sMsgObjectRx tCANMsgObject sMsgObjectTx unsigned char ucBufferIn 8 unsigned char ucBufferOut 8 Reset the state of all the message objects and the state of the CAN module to a known state ff CANInit CANO_BASE CANInit CAN1_BASE Configure the controller for 1 Mbit operation ff CANSetBitTiming CAN1_BASE amp CANBitClk Take the CANO device out of INIT state CANEnable CANO_BASE CANEnable CAN1_BASE Configure a receive object sMsgObjectRx ulMsgID 0x400 January 11 2011 65 Controller Area Network CAN sMsgObjectRx sMsgObjectRx Lf The first that they CANMessageSet CANO_BASE CANMessageSet CANO_BASE CANMessageSet CANO_BASE Last message object does ulMsgIDMask 0x7f8 ulFlags MSG_OBJ_USE_ID_FILTER MSG_OBJ_FIFO three message objects have the MSG_OBJ_FIFO set to indicate are part of a FIFO 1 amp sMsgObjectRx
156. N_PERM_NOEXEC MPU_RGN_PERM_PRV_RW_USR_RW MPU_RGN_ENABLB tf Define an additional 8 KB region 2 in RAM from 0x20008000 to 0x2000A000 which will be read write accessible only from privileged mode This region will be initially disabled to be enabled later if January 11 2011 Memory Protection Unit MPU MPURegionSet 2 0x20008000 MPU_RGN_SIZE_8K MPU_RGN_PERM_NOEXEC MPU_RGN_PERM_PRV_RW_USR_NO MPU_RGN_DISABLE Define a region 3 in peripheral space from 0x40000000 to 0x40100000 1 MB This region is accessible only in privileged mode There is a an area from 0x40020000 to 0x40040000 that has no peripherals and is not accessible at all This is created by disabling the second sub region 1 and creating a hole Further there is an area from 0x40080000 to 0x400A0000 that should be accessible from user mode as well This is created by disabling the fifth sub region 4 and overlaying an additional region 4 in that space with the appropriate permissions 0x40000000 PU_RGN_SIZE_1M PU_RGN_PERM_NOEXEC PU_RGN_PERM_PRV_RW_USR_NO PU_SUB_RGN_DISABLE_1 MPU_SUB_RGN_DISABLE_4 MPURegionSet 3 M M M M MPU_RGN_ENABLBE 4 M M M M MPURegionSet 4 0x40080000 PU_RGN_SIZE_128K PU_RGN_PERM_NOEXEC PU_RGN_PERM_PRV_RW_USR_RW PU_RGN_ENABLE In this example compile time registration of interrupts is used so the hand
157. N_STATUS_LEC_MASK CAN_STATUS_LEC_MSK CAN_STATUS_LEC_NONE CAN_STATUS_LEC_STUFF CAN_STATUS_RXOK CAN_STATUS_TXOK MSG_OBJ_DATA_LOST MSG_OBJ_EXTENDED_ID MSG_OBJ_FIFO MSG_OBJ_NEW_DATA MSG_OBJ_NO_FLAGS MSG_OBJ_REMOTE_FRAME MSG_OBJ_RX_INT_ENABLE MSG_OBJ_STATUS_MASK MSG_OBJ_TX_INT_ENABLE MSG_OBJ_USE_DIR_FILTER MSG_OBJ_USE_EXT_FILTER MSG_OBJ_USE_ID_FILTER Enumerations tCANintStsReg tCANStsReg tMsgObjType Functions unsigned long CANBitRateSet unsigned long ulBase unsigned long ulSourceClock unsigned long ulBitRate void CANBitTimingGet unsigned long ulBase tCANBitClkParms xpClkParms void CANBitTimingSet unsigned long ulBase tCANBitClkParms xpClkParms void CANDisable unsigned long ulBase void CANEnable unsigned long ulBase tBoolean CANErrCntrGet unsigned long ulBase unsigned long pulRxCount unsigned long pulT xCount void CANInit unsigned long ulBase void CANIntClear unsigned long ulBase unsigned long ullntClr void CANIntDisable unsigned long ulBase unsigned long ullntFlags void CANIntEnable unsigned long ulBase unsigned long ullntFlags void CANIntRegister unsigned long ulBase void xpfnHandler void unsigned long CANIntStatus unsigned long ulBase tCANIntStsReg elntStsReg void CANIntUnregister unsigned long ulBase void CANMessageClear unsigned long ulBase unsigned long ulObjID January 11 2011 Controller Area Network CAN void CANMessageGet unsigned long ulBase unsign
158. None 5 2 5 12 CANIntStatus Returns the current CAN controller interrupt status Prototype unsigned long CANIntStatus unsigned long ulBase tCANIntStsReg eIntStsReg Parameters ulBase is the base address of the CAN controller elntSisReg indicates which interrupt status register to read Description Returns the value of one of two interrupt status registers The interrupt status register read is determined by the e ntStsReg parameter which can have one of the following values m CAN_INT_STS_CAUSE indicates the cause of the interrupt m CAN_INT_STS_ OBJECT indicates pending interrupts of all message objects CAN_INT_STS_CAUSE returns the value of the controller interrupt register and indicates the cause of the interrupt It will be a value of CAN_INT_INTID_STATUS if the cause is a status interrupt In this case the status register should be read with the CANStatusGet function Calling this function to read the status will also clear the status interrupt If the value of the interrupt register is in the range 1 32 then this indicates the number of the highest priority message object that has an interrupt pending The message object interrupt can be cleared by using the CANIntClear function or by reading the message using CANMessageGet in the case of a received message The interrupt handler can read the interrupt status again to make sure all pending interrupts are cleared before returning from the interrupt CAN_INT_S
159. ODE_IN GPIO_DIR_MODE_OUT GPIO_DIR_MODE_HW where GPIO_DIR_MODE_IN specifies that the pin will be programmed as a software controlled input GPIO_DIR_MODE_OUT specifies that the pin will be programmed as a software con trolled output and GPIO_DIR_MODE_HW specifies that the pin will be placed under hardware control The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note GPIOPadConfigSet must also be used to configure the corresponding pad s in order for them to propagate the signal to from the GPIO Returns None GP1 OlIntTypeGet Gets the interrupt type for a pin Prototype unsigned long GPIOIntTypeGet unsigned long ulPort unsigned char ucPin Parameters ulPort is the base address of the GPIO port ucPin is the pin number Description This function gets the interrupt type for a specified pin on the selected GPIO port The pin can be configured as a falling edge rising edge or both edge detected interrupt or it can be configured as a low level or high level detected interrupt The type of interrupt detection mechanism is returned as an enumerated data type Returns Returns one of the enumerated data types described for GPIOIntTypeSet GP1 OIntTypeSet Sets the interrupt type for the specified pin s January 11 2011 GPIO Prototyp
160. P2RxX for USB endpoint 2 receive UDMA_CHANNEL_USBEP2TX for USB endpoint 2 transmit UDMA_CHANNEL_USBEPS3RxX for USB endpoint 3 receive UDMA_CHANNEL_USBEPS3TX for USB endpoint 3 transmit UDMA_CHANNEL_ETHORX for ethernet receive UDMA_CHANNEL_ETHOTX for ethernet transmit UDMA_CHANNEL_UARTORX for UART 0 receive channel UDMA_CHANNEL_UARTOTX for UART 0 transmit channel UDMA_CHANNEL_UART1RX for UART 1 receive channel UDMA_CHANNEL_UART1TX for UART 1 transmit channel UDMA_CHANNEL_SSIORX for SSI 0 receive channel UDMA_CHANNEL_SSIOTX for SSI 0 transmit channel January 11 2011 333 uDMA Controller 334 UDMA_CHANNEL_SSI1RX for SSI 1 receive channel UDMA_CHANNEL_SSI1TX for SSI 1 transmit channel UDMA_CHANNEL_ADCO for ADCO sequencer 0 UDMA_CHANNEL_ADC1 for ADCO sequencer 1 UDMA_CHANNEL_ADC2 for ADCO sequencer 2 UDMA_CHANNEL_ADC3 for ADCO sequencer 3 UDMA_CHANNEL_TMROA for Timer 0A UDMA_CHANNEL_TMROB for Timer 0B UDMA_CHANNEL_TMRIY1A for Timer 1A UDMA_CHANNEL_TMR1B for Timer 1B UDMA_CHANNEL_I2SORX for I2S receive UDMA_CHANNEL_I2SO0TX for 12S transmit UDMA_CHANNEL_SW for the software dedicated uDMA channel Some Stellaris parts also provide a secondary channel mapping For those parts each channel has a secondary peripheral mapping This is to allow more choices in channel mapping and to allow some additional peripherals to use UDMA that are not available in the default mapping In order to s
161. PH_ETH SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_12C1 SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_ UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOG1 Returns None 19 2 2 33 SysCtlPinPresent Determines if a pin is present 278 one of the SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_12S0 SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UART1 following values SYSCTL_PERIPH_CANO SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_I2C0O SYSCTL_PERIPH_PWM SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TEMP SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_WDOGO or January 11 2011 Prototype tBoolean System Control SysCt1lPinPresent unsigned long ulPin Parameters ulPin is the pin in question Description Determines if a particular pin is present in the device The PWM analog comparators ADC and timers have a varying number of pins acro determine which are present on this device The ulPin argument must be only one of th ss members of the Stellaris family this will e following values SYSCTL_PIN_PWMO SYSCTL_PIN_PWM1 SYSCTL_PIN_PWM2 SYSCTL_PIN_PWM3 SYSCTL_PIN_PWM4 SYSCTL
162. PH_TIMERO SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_TEMP SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO or SYSCTL_PERIPH_WDOG1 Returns None 19 2 2 27 SysCtlPeripheralDisable Disables a peripheral Prototype void SysCtlPeripheralDisable unsigned long ulPeripheral Parameters ulPeripheral is the peripheral to disable Description 274 Peripherals are disabled with this function Once disabled they will not operate or respond to register reads writes The ulPeripheral parameter must be only one of the following values SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CANO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOE January 11 2011 SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOG1 Returns None 19 2 2 28 SysCtlPeripheralEnable Enables a peripheral Prototype void
163. PIOD SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2CO SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_PWM SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_TEMP SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART2 277 System Control SYSCTL_PERIPH_ UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOG1 Returns None 19 2 2 32 SysCtlPeripheralSleepEnable Enables a peripheral in sleep mode Prototype void SYSCTL_PERIPH_WDOGO or SysCtlPeripheralSleepEnable unsigned long ulPeripheral Parameters ulPeripheral is the peripheral to enable in sleep mode Description This function allows a peripheral to continue operating when the processor goes into sleep mode Since the clocking configuration of the device does not change any peripheral can safely continue operating while the processor is in sleep mode and can therefore wake the processor from sleep mode Sleep mode clocking of peripherals must be enabled via SysCtlPeripheralClockGating if dis abled the peripheral sleep mode configuration is maintained but has no effect when sleep mode is entered The ulPeripheral parameter must be only SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP1 SYSCTL_PERI
164. PWM module ulGenBits are the PWM generator blocks to be updated Must be the logical OR of any of PWM_GEN_0_BIT PWM_GEN_1_BIT PWM_GEN_2 BIT or PWM_GEN_3 BIT Description For the selected PWM generators this function causes all queued updates to the period or pulse width to be applied the next time the corresponding counter becomes zero Returns None Programming Example The following example shows how to use the PWM API to initialize the PWMO with a 50 KHz frequency and with a 25 duty cycle on PWMO and a 75 duty cycle on PWM1 Configure the PWM generator for count down mode with immediate updates to the parameters PWMGenConfigure PWM_BASE PWM_GEN_O PWM_GEN_MODE_DOWN PWM_GEN_MODE_NO_SYNC Lf Set the period For a 50 KHz frequency the period 1 50 000 or 20 microseconds For a 20 MHz clock this translates to 400 clock ticks Use this value to set the period PWMGenPeriodSet PWM_BASE PWM_GEN_0O 400 Set the pulse width of PWMO for a 25 duty cycle PWMPulseWidthSet PWM_BASE PWM_OUT_0O 100 Set the pulse width of PWM1 for a 75 duty cycle PWMPulseWidthSet PWM_BASE PWM_OUT_1 300 Start the timers in generator 0 PWMGenEnable PWM_BASE PWM_GEN_0O Enable the outputs PWMOutputState PWM_BASE PWM_OUT_O_BIT PWM_OUT_1_BIT true January 11 2011 Quadrature Encoder QE 17 Quadrature Encoder QEl iio
165. PWMOutputlnvert Selects the inversion mode for PWM outputs Prototype void PWMOutput Invert unsigned unsigned long ul long ul Base PWMOutBits tBoolean bInvert Parameters ulBase is the base address of the PWM module ulPWMOutBits are the PWM outputs to be modified Must be the logical OR of any of PWM_OUT_0 BIT PWM_OUT_1_BIT PWM_OUT_2_ BIT PWM_OUT_3 BIT PWM_OUT_4 BIT PWM_OUT_5_ BIT PWM_OUT_6_BIT or PWM_OUT_7_BIT binvert determines if the signal is inverted or passed through Description This function is used to select the inversion mode for the selected PWM outputs The outputs are selected using the parameter u PWMOutBits The parameter b nvert determines the in version mode for the selected outputs If b nvert is true this function will cause the specified PWM output signals to be inverted or made active low If binvert is false the specified output will be passed through as is or be made active high Returns None 16 2 2 29 PWMOutputState Enables or disables PWM outputs January 11 2011 233 Pulse Width Modulator PWM Prototype void PWMOutputState unsigned long ulBase unsigned long ulPWMOutBits tBoolean bEnable Parameters ulBase is the base address of the PWM module ulPWMOutBits are the PWM outputs to be modified Must be the logical OR of any of PWM_OUT_0 BIT PWM_OUT_1_BIT PWM_OUT_2_BIT PWM_OUT_3 BIT PWM_OUT_4 BIT PWM_OUT_5 BIT PWM_OUT_6 BIT o
166. R can be added to ignore small short drops in VBUS level caused by high power consumption This is mainly used to avoid causing VBUS errors caused by devices with high in rush current Note The following values have been deprecated and should no longer be used USB_HOST_PWREN_LOW Automatically drive USBnEPEN low when power is enabled USB_HOST_PWREN_HIGH Automatically drive USBnEPEN high when power is en abled USB_HOST_PWREN_VBLOW Automatically drive USBnEPEN low when power is en abled 378 January 11 2011 USB Controller USB_HOST_PWREN_VBHIGH Automatically drive USBnEPEN high when power is en abled This function should only be called on microcontrollers that support host mode or OTG opera tion Returns None 24 3 2 36 USBHostPwrDisable Disables the external power pin Prototype void USBHostPwrDisable unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function disables the USBEPEN signal to disable an external power supply in host mode operation Note This function should only be called in host mode Returns None 24 3 2 37 USBHostPwrEnable Enables the external power pin Prototype void USBHostPwrEnable unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function enables the USBEPEN signal to enable an external power supply in host mode operation Note This functi
167. S receive FIFO with blocking Prototype void I2SRxDataGet unsigned long ulBase unsigned long pulData Parameters ulBase is the 12S module base address pulData points to storage for the returned I2S sample data Description This function reads a single channel sample or combined left right samples from the 12S receive FIFO The format of the sample is determined by the configuration that was used with the func tion I2SRxConfigSet If the receive mode is 12S MODE_DUAL_STEREO then the returned value contains either the left or right sample The left and right sample alternate with each read from the FIFO left sample first If the receive mode is 128 MODE_COMPACT_STEREO_16 or 125 _ MODE_COMPACT_STEREO_8 then the returned data contains both the left and right samples If the receive mode is 12S MODE_SINGLE_MONDO then the returned data contains the single channel sample For the compact modes both the left and right samples are read at the same time If 16 bit compact mode is used then the least significant 16 bits contain the left sample and the most significant 16 bits contain the right sample If 8 bit compact mode is used then the lower 8 bits contain the left sample and the next 8 bits contain the right sample with the upper 16 bits unused If there is no data in the receive FIFO then this function will wait in a polling loop until data is available Returns None 12 2 2 10 l2SRxDataGetNonBlocking Reads data
168. SB module base address Description This function returns the current operating mode on USB controllers with OTG or Dual mode functionality For OTG controllers The function will return on of the following values on OTG con trollers USB_OTG_MODE_ASIDE_HOST USB_OTG_MODE_ASIDE_DEV USB_OTG_MODE_BSIDE_HOST USB_OTG_MODE_BSIDE_DEV USB_OTG_MODE_NONE USB_OTG_MODE_ASIDE_HOST indicates that the controller is in host mode on the A side of the cable USB_OTG_MODE_ASIDE_DEV indicates that the controller is in device mode on the A side of the cable USB_OTG_MODE_BSIDE_HOST indicates that the controller is in host mode on the B side of the cable USB_OTG_MODE_BSIDE_DEV indicates that the controller is in device mode on the B side of the cable If and OTG session request is started with no cable in place this is the default mode for the controller USB_OTG_MODE_NONE indicates that the controller is not attempting to determine its role in the system For Dual Mode controllers The function will return on of the following values USB _DUAL_MODE_HOST USB_DUAL_MODE_ DEVICE or USB DUAL MODE_NONE USB_DUAL_MODE_HOST indicates that the controller is acting as a host USB_DUAL_MODE_DEVICE indicates that the controller acting as a device USB_DUAL_MODE_NONE indicates that the controller is not active as either a host or device Returns Returns USB_OTG_MODE_ASIDE_HOST USB _OTG_MODE ASIDE DEV USB_OTG_MODE _BSIDE_ HOST USB OTG MODE BSI
169. SSI_CRO_DSS_8 Alternatively the following has the same effect although it is not as easy to understand SSIO_CRO_R 0x000005c7 Extracting the value of the SCR field from the CRO register is as follows ulValue SSIO_CRO_R amp SSI_CRO_SCR_M gt gt SSIO_CRO_SCR_S The GPIO modules have many registers that do not have bit field definitions For these registers the register bits represent the individual GPIO pins so bit zero in these registers corresponds to the Px0 pin on the part where x is replaced by a GPIO module letter bit one corresponds to the Px1 pin and so on The blinky example for each board uses the direct register access model to blink the on board LED Note The hw_x h header files that are used by the drivers in the library contain many of the same definitions as the header files used for direct register access As a result the two cannot both be included into the same source file without the compiler producing warnings about the redefinition of symbols Software Driver Model In the software driver model the API provided by the peripheral driver library is used by applications to control the peripherals Because these drivers provide complete control of the peripherals in their normal mode of operation it is possible to write an entire application without direct access to the hardware This method provides for rapid development of the application without requiring detailed knowledge of how to program
170. SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_TEMP SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO or SYSCTL_PERIPH_WDOG1 Returns Returns true if the specified peripheral is present and false if it is not 19 2 2 30 SysCtlPeripheralReset Performs a software reset of a peripheral Prototype void SysCt1lPeripheralReset unsigned long ulPeripheral Parameters ulPeripheral is the peripheral to reset Description 276 This function performs a software reset of the specified peripheral An individual peripheral reset signal is asserted for a brief period and then deasserted returning the internal state of the peripheral to its reset condition The ulPeripheral parameter must be only one of the following values SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CANO January 11 2011 System Control SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2CO SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_PWM SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TI
171. Sound 12S DSRS SON maneia naa phatase cate ial Wiha debe dak ding De ade eed he ae danke 169 Pe VPM CMON 6 acco ec tek oleate aca ts CS sent ca a oe daha knee ea eee eteesewnes 169 Programming Example ccc connrenaegeisnisen edd camtagemeeentbagenecEsepesarsouquenerseabedsqneeematdes 184 Introduction The 12S API provides functions to use the I2S peripheral in the Stellaris microcontroller The l2S peripheral provides an interface for serial transfer of variable sized data samples typically for audio or analog applications The 12S peripheral automatically handles left and right channels in audio data The 12S peripheral contains two modules one for transmit and one for receive These two modules can be independently configured for clock time base and data format Some features of the I2S peripheral are m independently configurable transmit and receive modules 8 sample pair FIFOs adjustable FIFO service request levels interrupt on FIFO service request or error DMA interface adjustable time base for clocking clock slave or master left justified right justified and 12S format modes adjustable sample data size adjustable wire word size m single or dual channel stereo mono This driver is contained in driverlib i2s c with driverlib i2s h containing the API defi nitions for use by applications API Functions Functions void I2SIntClear unsigned long ulBase unsigned long ullntFlags void I2SIntDisable unsigned lo
172. Stellaris Peripheral Driver Library USER S GUIDE I TEXAS INSTRUMENTS SW DRL UG 6852 Copyright 2006 2011 Texas Instruments Incorporated Copyright Copyright 2006 2011 Texas Instruments Incorporated All rights reserved Stellaris and StellarisWare are registered trademarks of Texas Instruments ARM and Thumb are registered trademarks and Cortex is a trademark of ARM Limited Other names and brands may be claimed as the property of others A Please be aware that an important notice concerning availability standard warranty and use in critical applications of Texas Instruments semicon ductor products and disclaimers thereto appears at the end of this document Texas Instruments 108 Wild Basin Suite 350 m Austin TX 78746 IA TEXAS E INSTRUMENTS http www ti com stellaris an E E E HE ortex Intelligent Processors by ARM a lu oc Llu 5 a E Revision Information This is version 6852 of this document last updated on January 11 2011 2 January 11 2011 Table of Contents Table of Contents COMUNGNE 25 8 dca Gee beet ee Pew ae ee ee BGG aa oe Se Oh GE eee ee 2 Revision Information 2 ee a 2 1 MOAUCHOT fo 5 ae eg a as i hh emer kas aes ua ke teeters eel ee eee E Bes chek aime eee aa S 7 2 Programming Model 22 eee eee es 9 2i POOUEBION 3 4 4 hk a eee a A ee eS OE EE ee ee i 9 2 2 Direct Register Access Model 0 0 ee ee 9 2 3 Software Driver Mode
173. T or UDMA_ALT_SELECT Description This function is used to get the transfer mode for the UDMA channel It can be used to query the status of a transfer on a channel When the transfer is complete the mode will be UDMA_MODE_ STOP Returns Returns the transfer mode of the specified channel and control structure which will be one of the following values UDMA_MODE_STOP UDMA_MODE_BASIC UDMA_MODE_ AUTO UDMA_MODE_PINGPONG UDMA_MODE_MEM_SCATTER_GATHER or UDMA_MODE_PER_SCATTER_GATHER uDMAChannelReaquest Requests a UDMA channel to start a transfer Prototype void uDMAChannelRequest unsigned long ulChannelNum Parameters ulChannelNum is the channel number on which to request a UDMA transfer January 11 2011 uDMA Controller Description This function allows software to request a UDMA channel to begin a transfer This could be used for performing a memory to memory transfer or if for some reason a transfer needs to be initiated by software instead of the peripheral associated with that channel Note If the channel is UDMA_CHANNEL_SW and interrupts are used then the completion will be signaled on the uDMA dedicated interrupt If a peripheral channel is used then the completion will be signaled on the peripheral s interrupt Returns None 23 2 3 10 uDMAChannelScatterGatherSet Configures a UDMA channel for scatter gather mode Prototype void uDMAChannelScatterGatherSet unsigned long ulChannelNum unsigned
174. TO_BASE SysCtlClockGet 38400 UART_CONFIG_WLEN_8 UART_CONFIG_STOP_ONE UART_CONFIG_PAR_NONE eh Enable the UART January 11 2011 327 UART 328 UARTEnable UARTO_BASE Check for characters This will spin here until a character is placed into the receive FIFO while UARTCharsAvail UARTO_BASE Get the character s in the receive FIFO while UARTCharGetNonBlocking UARTO_BASE Put a character in the output buffer UARTCharPut UARTO_BASE c Disable the UART UARTDisable UARTO_BASE January 11 2011 23 23 1 uDMA Controller uDMA Controller MOGUCOM maneia ala a hatin a debe a din De a he ae aenk on Laas 329 APOPO ROIS 6 tanec ee ec aah orate caiman ee Cs sunet ca aoe daha aed enue beaep aoe dew aes 330 Pregrammmg ERIN DIE ccc sannreaeaeiapisdn edd cameagemeeeribagenecEsepeggrsouquaneckaabedeqnememadaas 349 Introduction The microDMA uDMA API provides functions to configure the Stellaris UDMA Direct Memory Access controller The UDMA controller is designed to work with the the ARM Cortex M3 processor and provides an efficient and low overhead means of transferring blocks of data in the system The uDMA controller has the following features m dedicated channels for supported peripherals m one channel each for receive and transmit for devices with receive and transmit paths dedicated channel
175. TS_OBJECT returns a bit mask indicating which message objects have pending interrupts This can be used to discover all of the pending interrupts at once as opposed to repeatedly reading the interrupt register by using CAN_INT_STS_ CAUSE Returns Returns the value of one of the interrupt status registers 5 2 5 138 CANIntUnregister Unregisters an interrupt handler for the CAN controller Prototype void CANIntUnregister unsigned long ulBase 58 January 11 2011 5 2 5 14 5 2 5 15 Controller Area Network CAN Parameters ulBase is the base address of the controller Description This function unregisters the previously registered interrupt handler and disables the interrupt on the interrupt controller See also IntRegister for important information about registering interrupt handlers Returns None CANMessageClear Clears a message object so that it is no longer used Prototype void CANMessageClear unsigned long ulBase unsigned long ulObjID Parameters ulBase is the base address of the CAN controller ulObjID is the message object number to disable 1 32 Description This function frees the specified message object from use Once a message object has been cleared it will no longer automatically send or receive messages or generate interrupts Returns None CANMessageGet Reads a CAN message from one of the message object buffers Prototype void CANMessageGet u
176. TYPE_RX 2 Set pMsgObject gt ulMsgID to the full message ID or a partial mask to use partial ID match ing 3 Set pMsgObject gt ulMsg DMask bits that should be used for masking during comparison 4 Set pMsgObject gt ulFlags as follows Set MSG_OBJ_RX_INT_ENABLE flag to be interrupted when the data frame is re ceived Set MSG_OBJ_USE_ID_FILTER flag to enable identifier based filtering 5 Set pMsgObject gt ulMsgLen to the number of bytes in the expected data frame 6 The buffer pointed to by pMsgObject gt pucMsgData is not used by this call as no data is present at the time of the call 7 Call this function with ulObjID set to one of the 32 object buffers If you specify a message object buffer that already contains a message definition it will be overwritten Returns None January 11 2011 61 Controller Area Network CAN 5 2 5 17 5 2 5 18 5 2 5 19 62 CANRetryGet Returns the current setting for automatic retransmission Prototype tBoolean CANRetryGet unsigned long ulBase Parameters ulBase is the base address of the CAN controller Description Reads the current setting for the automatic retransmission in the CAN controller and returns it to the caller Returns Returns true if automatic retransmission is enabled false otherwise CANRetrySet Sets the CAN controller automatic retransmission behavior Prototype void CANRetrySet unsigned long ulBase tBoolean bAutoRetry Pa
177. TYPE_TX_REMOTE Transmit remote request message object MSG_OBJ_TYPE_RX Receive message object MSG_OBJ_TYPE_RX_REMOTE Receive remote request message object MSG_OBJ_TYPE_RXTX_REMOTE Remote frame receive remote with auto transmit mes sage object January 11 2011 51 Controller Area Network CAN 5 2 5 5 2 5 1 5 2 5 2 52 Function Documentation CANBitRateSet This function is used to set the CAN bit timing values to a nominal setting based on a desired bit rate Prototype unsigned long CANBitRateSet unsigned long ulBase unsigned long ulSourceClock unsigned long ulBitRate Parameters ulBase is the base address of the CAN controller ulSourceClock is the system clock for the device in Hz ulBitRate is the desired bit rate Description This function will set the CAN bit timing for the bit rate passed in the u BitRate parameter based on the u SourceClock parameter Since the CAN clock is based off of the system clock the calling function should pass in the source clock rate either by retrieving it from SysCtlClockGet or using a specific value in Hz The CAN bit timing is calculated assuming a minimal amount of propagation delay which will work for most cases where the network length is short If tighter timing requirements or longer network lengths are needed then the CANBitTimingSet function is available for full customization of all of the CAN bit timing values Since not all bit rates can be ma
178. The ullnt Flags parameter can be the logical OR of any of the following values I2S_INT_RXERR I2S_INT_RXREQ I2S_INT_TXERR or I2S_INT_TXREQ Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns Returns None I2SIntDisable Disables 12S interrupt sources Prototype void T2SIntDisable unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the 2S module base address ullntFlags is a bit mask of the interrupt sources to be disabled January 11 2011 171 Inter IC Sound 12S 12 2 2 3 12 2 2 4 172 Description This function disables the specified I2S sources for interrupt generation The ullntFlags param eter can be the logical OR of any of the following values I2S_INT_RXERR I2S_INT_RXREQ I2S_INT_TXERR or 12S_INT_TXREQ Returns Returns None I2SIntEnable Enables 12S interrupt sources Prototype void T2SIntEnable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase
179. Triggers Parameters ulBase is the base address of the PWM module ulGen is the PWM generator whose fault trigger states are being queried Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 ulGroup indicates the subset of faults that are being queried This must be PWM_FAULT_GROUP_0 or PWM_FAULT_GROUP_1 ulFaultTriggers is the set of fault triggers which are to be cleared Description This function allows an application to clear the fault triggers for a given PWM genera tor This is only required if PWMGenConfigure has previously been called with flag PWM_GEN_MODE_LATCH_FAULLT in parameter u Config Note This function is only available on devices supporting extended PWM fault handling Returns None PWMGenFaultConfigure Configures the minimum fault period and fault pin senses for a given PWM generator Prototype void PWMGenFaultConfigure unsigned long ulBase unsigned long ulGen unsigned long ulMinFaultPeriod unsigned long ulFaultSenses Parameters ulBase is the base address of the PWM module ulGen is the PWM generator whose fault configuration is being set Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 ulMinFaultPeriod is the minimum fault active period expressed in PWM clock cycles ulFaultSenses indicates which sense of each FAULT input should be considered the as serted state Valid values are logical OR combinations of PWM_FAULTn_SENSE_HIG
180. UAL_STEREO then the u Data parameter contains either the left or right sample The left and right sample alternate with each write to the FIFO left sample first If the transmit mode is 125 MODE_COMPACT_STEREO_16 or 12S MODE_COMPACT_STEREO_8 then the ulData parameter contains both the left and right samples If the transmit mode is I2S_ MODE_SINGLE_MONO then the u Data parameter contains the single channel sample For the compact modes both the left and right samples are written at the same time If 16 bit compact mode is used then the least significant 16 bits contain the left sample and the most significant 16 bits contain the right sample If 8 bit compact mode is used then the lower 8 bits contain the left sample and the next 8 bits contain the right sample with the upper 16 bits unused If there is no room in the transmit FIFO then this function will return immediately without writing any data to the FIFO Returns The number of elements written to the 12S transmit FIFO 1 or 0 12 2 2 19 l2STxDisable Disables the 12S transmit module for operation Prototype void I2STxDisable unsigned long ulBase Parameters ulBase is the I2S module base address Description This function disables the transmit module for operation The module should be disabled before configuration When the module is disabled no data or clocks will be generated on the 12S signals Returns None 180 January 11 2011 Inter IC Sound
181. UDMA channel which can be any of the following UDMA_ATTR_USEBURST is used to restrict transfers to use only a burst mode UDMA_ATTR_ALTSELECT is used to select the alternate control structure for this chan nel UDMA_ATTR_HIGH_PRIORITY is used to set this channel to high priority UDMA_ATTR_REQMASK is used to mask the hardware request signal from the periph eral for this channel 23 2 3 4 uDMAChannelControlSet 338 Sets the control parameters for a UDMA channel control structure Prototype void uDMAChannelControlSet unsigned long ulChannelStructIndex unsigned long ulControl Parameters ulChannelStructindex is the logical OR of the uDMA channel number with UDMA_PRI_SELECT or UDMA_ALT_SELECT ulControl is logical OR of several control values to set the control parameters for the channel Description This function is used to set control parameters for a UDMA transfer These are typically param eters that are not changed often The u ChannelStructindex parameter should be the logical OR of the channel number with one of UDMA_PRI_SELECT or UDMA_ALT_SELECT to choose whether the primary or alternate data structure is used The ulControl parameter is the logical OR of five values the data size the source address increment the destination address increment the arbitration size and the use burst flag The choices available for each of these values is described below Choose the data size from one of U
182. UP 32 bit one shot timer that counts up instead of down not available on all parts TIMER_CFG_32_BIT_PER 32 bit periodic timer TIMER_CFG_32_BIT_PER_UP 32 bit periodic timer that counts up instead of down not available on all parts m TIMER_CFG_32_RTC 32 bit real time clock timer TIMER_CFG_16_BIT_PAIR Two 16 bit timers When configured for a pair of 16 bit timers each timer is separately configured The first timer is configured by setting u Config to the result of a logical OR operation between one of the following values and u Config TIMER_CFG_A_ONE_SHOT 16 bit one shot timer TIMER_CFG_A_ONE_SHOT_UP 16 bit one shot timer that counts up instead of down not available on all parts TIMER_CFG_A_PERIODIC 16 bit periodic timer TIMER_CFG_A_PERIODIC_UP 16 bit periodic timer that counts up instead of down not available on all parts TIMER_CFG_A_CAP_COUNT 16 bit edge count capture TIMER_CFG_A_CAP_TIME 16 bit edge time capture a TIMER_CFG_A_PWM 16 bit PWM output Similarly the second timer is configured by setting u Config to the result of a logical OR oper ation between one of the corresponding TIMER_CFG_B_ values and u Config Returns None January 11 2011 293 Timer 21 2 2 2 21 2 2 3 21 2 2 4 294 TimerControlEvent Controls the event type Prototype void TimerControlEvent unsigned long ulBase unsigned long ulTimer unsigned long ulEvent Pa
183. USB Controller This example code makes the calls necessary to configure end point 1 in device mode as a bulk IN end point The first call configures end point 1 to have a maximum packet size of 64 bytes and makes it a bulk IN end point The call to USBFIFOConfig sets the starting address to 64 bytes in and 64 bytes long It specifies USB_EP_DEV_IN to indicate that this is a device mode IN endpoint The next two calls demonstrate how to fill the data FIFO for this endpoint and then have it scheduled for transmission on the USB bus The USBEndpointDataPut call puts data into the FIFO but does not actually start the data transmission The USBEndpointDataSend call will schedule the transmission to go out the next time the host controller requests data on this endpoint January 11 2011 d Configure Endpoint 1 USBDevEndpointConfigSet USBO_BASE USB_EP_1 64 DISABLE_NAK_LIMIT USB_EP_MODE_BULK USB_EP_DEV_IN Configure FIFO as a device IN endpoint FIFO starting at address 64 and is 64 bytes in size USBFIFOConfig USBO_BASE USB_EP_1 64 USB_FIFO_SZ_64 USB_EP_DEV_IN Put the data in the FIFO USBEndpointDataPut USBO_BASE USB_EP_1 pucData 64 Start the transmission of data USBEndpointDataSend USBO_BASE USB_EP_1 USB_TRANS_IN 391 USB Controller 392 January 11 2011 25 25 1 25 2 Watchdog Timer Watchdog Timer PRET S OT ane iaa a arei a debe da
184. USBDevEndpointConfigSet for this endpoint Note This function should only be called in device mode Returns None 360 January 11 2011 USB Controller 24 3 2 6 USBDevEndpointConfigSet Sets the configuration for an endpoint Prototype void USBDevEndpointConfigSet unsigned long ulBase unsigned long ulEndpoint unsigned long ulMaxPacketSize unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulMaxPacketSize is the maximum packet size for this endpoint ulFlags are used to configure other endpoint settings Description This function will set the basic configuration for an endpoint in device mode Endpoint zero does not have a dynamic configuration so this function should not be called for endpoint zero The ulFlags parameter determines some of the configuration while the other parameters provide the rest The USB_EP_MODE__ flags define what the type is for the given endpoint a USB_EP_MODE_ CTRL is a control endpoint USB_EP_MODE_ISOC is an isochronous endpoint USB_EP_MODE_BULK is a bulk endpoint USB_EP_MODE_INT is an interrupt endpoint The USB_EP_DMA_MODE_ flags determines the type of DMA access to the endpoint data Fl FOs The choice of the DMA mode depends on how the DMA controller is configured and how it is being used See the Using USB with the UDMA Controller section for more information on DMA configura
185. V_IN Returns None 24 3 2 25 USBFrameNumberGet Get the current frame number Prototype unsigned long USBF rameNumberGet unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function returns the last frame number received Returns The last frame number received 24 3 2 26 USBHostAddrGet Gets the current functional device address for an endpoint Prototype unsigned long USBHostAddrGet unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulFlags determines if this is an IN or an OUT endpoint Description This function returns the current functional address that an endpoint is using to communicate with a device The u Flags parameter determines if the IN or OUT endpoint s device address is returned Note This function should only be called in host mode Returns Returns the current function address being used by an endpoint 372 January 11 2011 USB Controller 24 3 2 27 USBHostAddrSet Sets the functional address for the device that is connected to an endpoint in host mode Prototype void USBHostAddrSet unsigned long ulBase unsigned long ulEndpoint unsigned long ulAddr unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulAddr is the
186. XINT_MODE_EOT 22 2 2 40 UARTTxIntModeSet Sets the operating mode for the UART transmit interrupt Prototype void UARTTxIntModeSet unsigned long ulBase unsigned long ulMode Parameters ulBase is the base address of the UART port ulMode is the operating mode for the transmit interrupt It may be UART_TXINT_MODE_EOT to trigger interrupts when the transmitter is idle or VART_TXINT_MODE_FIFO to trigger based on the current transmit FIFO level Description This function allows the mode of the UART transmit interrupt to be set By default the transmit interrupt is asserted when the FIFO level falls past a threshold set via a call to UARTFIFOLevelSet Alternatively if this function is called with u Mode set to UART_TXINT_MODE_EOT the transmit interrupt will only be asserted once the transmitter is completely idle the transmit FIFO is empty and all bits including any stop bits have cleared the transmitter Note The availability of end of transmission mode varies with the Stellaris part in use Please consult the datasheet for the part you are using to determine whether this support is available Returns None 22 3 Programming Example The following example shows how to use the UART API to initialize the UART transmit characters and receive characters Initialize the UART Set the baud rate number of data bits turn off parity number of stop bits and stick mode UARTConfigSetExpClk UAR
187. _PIN_PWM5 SYSCTL_PIN_COO SYSCTL_PIN_C10 SYSCTL_PIN_C2MINUS SYSCTL_PIN_ADCO SYSCTL_PIN_ADC1 SYSCTL_PIN_ADC4 SYSCTL_PIN_ADC5 SYSCTL_PIN_CCP0 SYSCTL_PIN_CCP1 SYSCTL_PIN_CCP4 SYSCTL_PIN_CCP5 SYSCTL_PIN_ SYSCTL_PIN_C1MINUS COMINUS SYSCTL_PIN_COPLUS SYSCTL_PIN_C1PLUS SYSCTL_PIN_C2PLUS SYSCTL_PIN_C20 SYSCTL_PIN_ADC2 SYSCTL_PIN_ADC3 SYSCTL_PIN_ADC6 SYSCTL_PIN_ADC7 SYSCTL_PIN_CCP2 SYSCTL_PIN_CCP3 SYSCTL_PIN_CCP6 SYSCTL_PIN_CCP7 SYSCTL_PIN_32KHZ or SYSCTL_PIN_MC_FAULTO Returns Returns true if the specified pin is present and f 19 2 2 34 SysCtlIPLLVerificationSet Configures the PLL verification timer Prototype void SysCt1PLLVerificationSet tBoolean b Parameters bEnable is a boolean that is true if the PLL veri Description alse if it is not Enable fication timer should be enabled This function allows the PLL verification timer to be enabled or disabled When enabled an interrupt will be generated if the PLL ceases to operate The PLL verification timer is only available on Sandstorm class devices Note The main oscillator must be enabled for this veri fication timer to operate as it is used to check the PLL Also the verification timer should be disabled while the PLL is being reconfigured via SysCtlClockSet Returns None January 11 2011 279 System Control 19 2 2 35 SysCtIPWMClockGet Gets the current PWM clock configuration Prototype unsi
188. a UDMA channel control structure Prototype unsigned long uDMAChannelSizeGet unsigned long ulChannelStruct Index Parameters ulChannelStructindex is the logical OR of the uDMA channel number with either UDMA_PRI_SELECT or UDMA_ALT_SELECT Description This function is used to get the uDMA transfer size for a channel The transfer size is the number of items to transfer where the size of an item might be 8 16 or 32 bits If a partial transfer has already occurred then the number of remaining items will be returned If the transfer is complete then 0 will be returned Returns Returns the number of items remaining to transfer 23 2 3 14 uDMAChannelTransferSet Sets the transfer parameters for a UDMA channel control structure Prototype void uDMAChannelTransferSet unsigned long ulChannelStructIndex unsigned long ulMode void xpvSrcAddr void xpvDstAddr unsigned long ulTransferSize Parameters ulChannelStructindex is the logical OR of the uDMA channel number with either UDMA_PRI_SELECT or UDMA_ALT_SELECT ulMode is the type of uDMA transfer pvSrcAddr is the source address for the transfer pvDstAddr is the destination address for the transfer ulTransferSize is the number of data items to transfer Description 344 This function is used to set the parameters for a UDMA transfer These are typically parameters that are changed often The function UDMAChannelControlSet MUST be called at l
189. a call to SysCtlClockGet This function replaces the original UARTConfigGet API and performs the same actions A macro is provided in uart h to map the original API to this API Returns None UARTConfigSetExpClk Sets the configuration of a UART Prototype void UARTConfigSetExpClk unsigned long ulBase unsigned long ulUARTCLk unsigned long ulBaud unsigned long ulConfig January 11 2011 UART Parameters ulBase is the base address of the UART port ulIUARTCIk is the rate of the clock supplied to the UART module ulBaud is the desired baud rate ulConfig is the data format for the port number of data bits number of stop bits and parity Description This function configures the UART for operation in the specified data format The baud rate is provided in the u Baud parameter and the data format in the u Config parameter The ulConfig parameter is the logical OR of three values the number of data bits the number of stop bits and the parity UART_CONFIG_WLEN_8 UART_CONFIG_WLEN_7 UART_CONFIG_WLEN_6 and UART_CONFIG_WLEN_5 select from eight to five data bits per byte respectively UART_CONFIG_STOP_ONE and UART_CONFIG_STOP_TWO select one or two stop bits respectively UART_CONFIG_PAR_NONE UART_CONFIG_PAR_EVEN UART_CONFIG_PAR_ODD UART_CONFIG_PAR_ONE and UART_CONFIG_PAR_ZERO select the parity mode no parity bit even parity bit odd parity bit parity bit always one and parity bit always zero
190. a h Note This function only has an effect on microcontrollers that have the ability to change the DMA channel for an endpoint Calling this function on other devices will have no effect Returns None 24 3 2 18 USBEndpointDMADisable Disable DMA on a given endpoint Prototype void USBEndpointDMADisable unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulFlags specifies which direction to disable Description This function will disable DMA on a given end point to allow non DMA USB transactions to gen erate interrupts normally The ulFlags should be USB_EP_DEV_IN or USB_EP_DEV_OUT all other bits are ignored January 11 2011 367 USB Controller Returns None 24 3 2 19 USBEndpointDMAEnable Enable DMA on a given endpoint Prototype void USBEndpointDMAEnable unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulFlags specifies which direction and what mode to use when enabling DMA Description This function will enable DMA on a given endpoint and set the mode according to the val ues in the u Flags parameter The ulFlags parameter should have USB_EP_DEV_IN or USB_EP_DEV_OUT set Returns None 24 3 2 20 USBEndpointStatus
191. able 2CSlaveDisable and I2CSlaveStatus Sending and receiving data from the 12C modules are handled by the I2CMasterSlaveAddrSet I2CMasterControl l2CMasterDataGet l2CMasterDataPut I2CSlaveDataGet and I2CSlaveDataPut functions The I2CMasterInit API from previous versions of the peripheral driver library has been replaced by the I2CMaster nitExpClk API A macro has been provided in i2c h to map the old API to the new API allowing existing applications to link and run with the new API It is recommended that new applications utilize the new API in favor of the old one 11 2 2 Function Documentation 11 2 2 1 l2ClntRegister Registers an interrupt handler for the 12C module Prototype void I2CIntRegister unsigned long ulBase void pfnHandler void January 11 2011 155 Inter Integrated Circuit 12C 11 2 2 2 11 2 2 3 Parameters ulBase is the base address of the I2C Master module pfnHandler is a pointer to the function to be called when the 12C interrupt occurs Description This sets the handler to be called when an 12C interrupt occurs This will enable the global inter rupt in the interrupt controller specific 12C interrupts must be enabled via 2CMasterlntEnable and I2CSlavelntEnable If necessary it is the interrupt handler s responsibility to clear the in terrupt source via I2CMaster ntClear and I2CSlavelntClear See also IntRegister for important information abou
192. abled can be reflected to the processor interrupt disabled sources have no effect on the processor Returns None QEllIntRegister Registers an interrupt handler for the quadrature encoder interrupt Prototype void QEIIntRegister unsigned long ulBase void pfnHandler void Parameters ulBase is the base address of the quadrature encoder module pfnHandler is a pointer to the function to be called when the quadrature encoder interrupt occurs Description This sets the handler to be called when a quadrature encoder interrupt occurs This will enable the global interrupt in the interrupt controller specific quadrature encoder interrupts must be enabled via QEllntEnable It is the interrupt handler s responsibility to clear the interrupt source via QElIntClear See also IntRegister for important information about registering interrupt handlers Returns None January 11 2011 Quadrature Encoder QE 17 2 2 10 QElIntStatus 17 2 2 11 Gets the current interrupt status Prototype unsigned long QETIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the base address of the quadrature encoder module bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required Description This returns the interrupt status for the quadrature encoder module Either the raw interrupt status or the status of interrupts that are allow
193. abled via uUDMAChannelEnable Returns None uDMAChannelEnable Enables a uUDMA channel for operation Prototype void uDMAChannelEnable unsigned long ulChannelNum Parameters ulChannelNum is the channel number to enable Description This function enables a specific UDMA channel for use This function must be used to enable a channel before it can be used to perform a uDMA transfer When a uDMA transfer is completed the channel will be automatically disabled by the UDMA controller Therefore this function should be called prior to starting up any new transfer Returns None January 11 2011 339 uDMA Controller 23 2 3 7 23 2 3 8 23 2 3 9 340 uDMAChannellsEnabled Checks if a UDMA channel is enabled for operation Prototype tBoolean uDMAChannellIsEnabled unsigned long ulChannelNum Parameters ulChannelNum is the channel number to check Description This function checks to see if a specific UDMA channel is enabled This can be used to check the status of a transfer since the channel will be automatically disabled at the end of a transfer Returns Returns true if the channel is enabled false if disabled uDMAChannelModeGet Gets the transfer mode for a UDMA channel control structure Prototype unsigned long uDMAChannelModeGet unsigned long ulChannelStruct Index Parameters ulChannelStructindex is the logical OR of the uDMA channel number with either UDMA_PRI_SELEC
194. acket assume that the packet has been filled in appropriately elsewhere in the code EthernetPacketPut ETH_BASE pucMyTxPacket ulMyTxPacketLength Lele Wait for a packet to come in EthernetPacketGet ETH_BASE pucMyRxPacket sizeof pucMyRxPacket Ethernet Controller 83 Ethernet Controller 84 January 11 2011 External Peripheral Interface EP 7 External Peripheral Interface EPI ie Ns Me Leese eet Te eee Te ete eee errr Trews eee Ler TEE reer en eee eT re emer rer ee Te eres tere 85 APIFOMGCIONS 23 sive ute eueealap shee ue lin iuedieid a sie eek sande odhiedalebieeetinan etalon eendeeic 85 Programming Example ccusornrieikgompiseaweareeagonseens agguniack E 101 7 1 Introduction The EPI API provides functions to use the EPI module available in the Stellaris microcontroller The EPI module provides a physical interface for external peripherals and memories The EPI can be configured to support several types of external interfaces and different sized address and data buses Some features of the EPI module are configurable interface modes including SDRAM HostBus and simple read write protocols m configurable address and data sizes m configurable bus cycle timing blocking and non blocking reads and writes a FIFO for streaming reads m interrupt and UDMA support This driver is contained in driverlib epi c with driverlib epi h containing the API defi nitions for use by applications
195. alues associated with setting up the bit timing for a CAN controller The structure is used when calling the CANGetBitTiming and CANSetBitTiming functions 5 2 2 2 tCANMsgObject Definition typedef struct nsigned long ulMsgID nsigned long ulMsgIDMask nsigned long ulFlags nsigned long ulMsgLen nsigned char pucMsgData Gr Gs Gs GG tCANMsgObject Members ulMsgID The CAN message identifier used for 11 or 29 bit identifiers ulMsg lDMask The message identifier mask used when identifier filtering is enabled ulFlags This value holds various status flags and settings specified by tCANObjFlags ulMsgLen This value is the number of bytes of data in the message object pucMsgData This is a pointer to the message object s data Description The structure used for encapsulating all the items associated with a CAN message object in the CAN controller January 11 2011 45 Controller Area Network CAN 5 2 3 5 2 3 1 5 2 3 2 5 2 3 3 5 2 3 4 5 2 3 5 46 Define Documentation CAN_INT_ERROR Definition define CAN_INT_ERROR Description This flag is used to allow a CAN controller to generate error interrupts CAN_INT_MASTER Definition define CAN_INT_MASTER Description This flag is used to allow a CAN controller to generate any CAN interrupts If this is not set then no interrupts will be generated by the CAN controller CAN_INT_STATUS Definition define CAN_INT_STATUS D
196. an be pro grammed to automatically transmit and receive CAN messages under certain conditions Message objects allow the application to perform some actions automatically without interaction from the microcontroller Some examples of these actions are the following Send a data frame immediately Send a data frame when a matching remote frame is seen on the CAN bus m Receive a specific data frame m Receive data frames that match a certain identifier pattern To configure message objects to perform any of these actions the application must first set up one of the 32 message objects using CANMessageSet This function must be used to configure a message object to send data or to configure a message object to receive data Each message object can be configured to generate interrupts on transmission or reception of CAN messages When data is received from the CAN bus the application can use the CANMessageGet function to read the received message This function can also be used to read a message object that is already configured in order to populate a message structure prior to making changes to the configuration of a message object Reading the message object using this function will also clear any pending interrupt on the message object Once a message object has been configured using CANMessageSet it has allocated the mes sage object and will continue to perform its programmed function unless it is released with a call to CANMessageClea
197. an interrupt when the value of the RTC counter is the same as the match register Returns None 10 2 2 21 HibernateRTCMatch1 Get Gets the value of the RTC match 1 register Prototype unsigned long HibernateRTCMatch1Get void Description Gets the value of the match 1 register for the RTC Returns Returns the value of the match register 10 2 2 22 HibernateRTCMatch1 Set Sets the value of the RTC match 1 register Prototype void HibernateRTCMatch1lSet unsigned long ulMatch Parameters ulMatch is the value for the match register Description Sets the match 1 register for the RTC The Hibernation module can be configured to wake from hibernation and or generate an interrupt when the value of the RTC counter is the same as the match register January 11 2011 145 Hibernation Module Returns None 10 2 2 23 HibernateRTCSet Sets the value of the real time clock RTC counter Prototype void HibernateRTCSet unsigned long ulRTCValue Parameters ulRTCValue is the new value for the RTC Description Sets the value of the RTC The RTC will count seconds if the hardware is configured correctly The RTC must be enabled by calling HibernateRTCEnable before calling this function Returns None 10 2 2 24 HibernateRTCTrimGet Gets the value of the RTC predivider trim register Prototype unsigned long HibernateRTCTrimGet void Description Gets the value of the pre divider trim re
198. and when no other regions are defined If this option is not enabled then there must be at least one valid region already defined when the MPU is enabled MPU_CONFIG_HARDFLT_NMI enables the MPU while in a hard fault or NMI exception handler If this option is not enabled then the MPU is disabled while in one of these exception handlers and the default memory map is applied MPU_CONFIG_NONE chooses none of the above options In this case no default mem ory map is provided in privileged mode and the MPU will not be enabled in the fault handlers Returns None 14 2 2 3 MPUIntRegister Registers an interrupt handler for the memory management fault Prototype void MPUIntRegister void xpfnHandler void Parameters pfnHandler is a pointer to the function to be called when the memory management fault oc curs January 11 2011 199 Memory Protection Unit MPU 14 2 2 4 14 2 2 5 14 2 2 6 200 Description This sets and enables the handler to be called when the MPU generates a memory manage ment fault due to a protection region access violation See also IntRegister for important information about registering interrupt handlers Returns None MPUIntUnregister Unregisters an interrupt handler for the memory management fault Prototype void MPUIntUnregister void Description This function will disable and clear the handler to be called when a memory management fault occurs See also In
199. andler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None January 11 2011 139 Hibernation Module 10 2 2 7 10 2 2 8 10 2 2 9 HibernateIntDisable Disables interrupts for the Hibernation module Prototype void HibernateIntDisable unsigned long ullIntFlags Parameters ullntFlags is the bit mask of the interrupts to be disabled Description Disables the specified interrupt sources from the Hibernation module The ul ntFlags parameter has the same definition as the ul lntFlags parameter to the Hiber natelntEnable function Returns None HibernateIntEnable Enables interrupts for the Hibernation module Prototype void HibernateIntEnable unsigned long ullIntFlags Parameters ullntFlags is the bit mask of the interrupts to be enabled Description Enables the specified interrupt sources from the Hibernation module The ullntFlags parameter must be the logical OR of any combination of the following HIBERNATE_INT_PIN_WAKE wake from pin interrupt HIBERNATE_INT_LOW_BAT low battery interrupt HIBERNATE_INT_RTC_MATCH_0 RTC match 0 interrupt HIBERNATE_INT_RTC_MATCH_1 RTC match 1 interrupt Returns None HibernatelIntRegister Registers an interrupt handler for the Hibernation module interrupt Prototype void
200. arameter u FrameCount is the number of clocks used to form the framing signal if the framing signal is used The behavior depends on whether the frame signal is a pulse or a 50 50 duty cycle This value is not used if the framing signal is not enabled with the option EPI_GPMODE_FRAMEPIN The parameter u MaxWait is used if the external clock enable is turned on with the EPI_GPMODE_CLKENA option is used In the case that external clock enable is used this parameter determines the maximum number of clocks to wait when the external clock enable January 11 2011 7 2 2 3 External Peripheral Interface EP signal is holding off a transaction A value of 0 means to wait forever If a non zero value is used and exceeded an interrupt will occur and the transaction aborted Returns None EPIConfigHB16Set Configures the interface for Host bus 16 operation Prototype void EPIConfigHBl 6Set unsigned long ulBase unsigned long ulConfig unsigned long ulMaxWait Parameters ulBase is the EPI module base address ulConfig is the interface configuration ulMaxWait is the maximum number of external clocks to wait if a FIFO ready signal is holding off the transaction Description This function is used to configure the interface when used in Host bus 16 operation as cho sen with the function EPIModeSet The parameter u Config is the logical OR of any of the following m one of EPI_HB16_MODE_ADMUX EPI_HB16_MODE_AD
201. as received successfully independent of any mes sage filtering CAN_STATUS_TXOK a message was successfully transmitted CAN_STATUS_LEC_ MSK mask of last error code bits 3 bits CAN_STATUS LEC NONE no error m CAN_STATUS_LEC STUFF stuffing error detected m CAN_STATUS_LEC FORM a format error occurred in the fixed format part of a message CAN_STATUS LEC ACK a transmitted message was not acknowledged CAN_STATUS LEC BIT1 dominant level detected when trying to send in recessive mode m CAN_STATUS LEC BITO recessive level detected when trying to send in dominant mode m CAN_STATUS_LEC CRC CRC error in received message The remaining status registers are 32 bit bit maps to the message objects They can be used to quickly obtain information about the status of all the message objects without needing to query each one They contain the following information CAN_STS_TXREQUEST if a message object s TxRequest bit is set that means that a transmission is pending on that object The application can use this to determine which objects are still waiting to send a message CAN_STS_NEWDAT if a message objects NewDat bit is set that means that a new message has been received in that object and has not yet been picked up by the host application CAN_STS_MSGVAL if a message object s MsgVal bit is set that means it has a valid configuration programmed The host application can use this to determine which message o
202. ase UARTO_BASE ulBase UART1_BASE ulBase UART2_BASE ASSERT ulParity UART_CONFIG_PAR_NONE ulParity UART_CONFIG_PAR_EVEN ulParity UART_CONFIG_PAR_ODD ulParity UART_CONFIG_PAR_ONE ulParity UART_CONFIG_PAR_ZERO Each argument is individually checked so the line number of the failing ASSERT will indicate the argument that is invalid The debugger will be able to display the values of the arguments from the stack backtrace as well as the caller of the function that had the argument error This allows the problem to be quickly identified at the cost of a small amount of code January 11 2011 407 IMPORTANT NOTICE Texas Instruments Incorporated and its subsidiaries Tl reserve the right to make corrections modifications enhancements improvements and other changes to its products and services at any time and to discontinue any product or service without notice Customers should obtain the latest relevant information before placing orders and should verify that such information is current and complete All products are sold subject to Tl s terms and conditions of sale supplied at the time of order acknowledgment Tl warrants performance of its hardware products to the specifications applicable at the time of sale in accordance with Tl s standard warranty Testing and other quality control techniques are used to the extent TI deems necessary to support
203. ase specifies the USB module base address Description This function changes the mode of the USB controller to device mode This is only valid on microcontrollers that have the host and device capabilities and not the OTG capabilities Returns None 24 3 2 12 USBEndpointDataAvail Determine the number of bytes of data available in a given endpoint s FIFO Prototype unsigned long USBEndpointDataAvail unsigned long ulBase unsigned long ulEndpoint Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access Description This function will return the number of bytes of data currently available in the FIFO for the given receive OUT endpoint It may be used prior to calling USBEndpointDataGet to determine the size of buffer required to hold the newly received packet Returns This call will return the number of bytes available in a given endpoint FIFO 24 3 2 13 USBEndpointDataGet Retrieves data from the given endpoint s FIFO 364 January 11 2011 USB Controller Prototype long USBEndpointDataGet unsigned long ulBase unsigned long ulEndpoint unsigned char xpucData unsigned long xpulSize Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access pucDaia is a pointer to the data area used to return the data from the FIFO pulSize is initially the size of the buffer passed into this call via the
204. ashErase FlashProtectSet and FlashProtectSave are the notable exceptions Argument checking is done via a call to the ASSERT macro provided in driverlib debug h This macro has the usual definition of an assert macro it takes an expression that must be true By making this macro be empty the argument checking is removed from the code There are two definitions of the ASSERT macro provided in driverlib debug h one that is empty used for normal situations and one that evaluates the expression used when the library is built with debugging The debug version will call the __ error__ function whenever the expression is not true passing the file name and line number of the ASSERT macro invocation The__error__ function is prototyped in driverlib debug h and must be provided by the application since it is the application s responsibility to deal with error conditions By setting a breakpoint on the __error___ function the debugger will immediately stop whenever an error occurs anywhere in the application something that would be very difficult to do with other error checking methods When the debugger stops the arguments to the __error___ function and the backtrace of the stack will pinpoint the function that found an error what it found to be a problem and where it was called from As an example void UARTParityModeSet unsigned long ulBase unsigned long ulParity Check the arguments ASSERT ulB
205. aster mode m FSSI gt 12 x bit rate Slave modes where FSSI is the frequency of the clock supplied to the SSI module The ulData Width parameter defines the width of the data transfers and can be a value between 4 and 16 inclusive The peripheral clock will be the same as the processor clock This will be the value returned by SysCtlClockGet or it can be explicitly hard coded if it is constant and known to save the code execution overhead of a call to SysCtlClockGet 249 Synchronous Serial Interface SSI 18 2 2 3 18 2 2 4 250 This function replaces the original SSIConfig API and performs the same actions A macro is provided in ssi h to map the original API to this API Returns None SS IDataGet Gets a data element from the SSI receive FIFO Prototype void SSIDataGet unsigned long ulBase unsigned long pulData Parameters ulBase specifies the SSI module base address pulDaita is a pointer to a storage location for data that was received over the SSI interface Description This function gets received data from the receive FIFO of the specified SSI module and places that data into the location specified by the pu Data parameter Note Only the lower N bits of the value written to pu Data contain valid data where N is the data width as configured by SSIConfigSetExpClk For example if the interface is configured for 8 bit data width only the lower 8 bits of the value written to pu D
206. at 20 MHz from the PLL using a 4 MHz crystal as the input SysCtlClockSet SYSCTL_SYSDIV_10 Enable t SysCtlPerip SysCtlPerip SysCtlPerip Enable t SysCtlPerip SysCtlPerip SysCtlPerip SYSCTL_USE_PLL SYSCTL_XTAL_4MHZ SYSCTL_OSC_MAIN he GPIO blocks and the SSI heralEnable SYSCTL_PERIPH_GPIOA heralEnable SYSCTL_PERIPH_GPIOB heralEnable SYSCTL_PERIPH_SSI he GPIO blocks and the SSI in sleep mode heralSleepEnable SYSCTL_PERIPH_GPIOA heralSleepEnable SYSCTL_PERIPH_GPIOB heralSleepEnable SYSCTL_PERIPH_SSI Enable peripheral clock gating SysCtlPeripheralClockGating true 283 System Control 284 January 11 2011 20 20 1 20 2 20 2 1 20 2 2 20 2 2 1 System Tick SysTick System Tick SysTick DRT SOIT anera a aa Ea a Ded adeeb a dain bias 285 APOPO MOU aiia EE aE 285 Pregrammmg ERIN DIE cecar rear a AE E a 289 Introduction SysTick is a simple timer that is part of the NVIC controller in the Cortex M3 microprocessor Its intended purpose is to provide a periodic interrupt for a RTOS but it can be used for other simple timing purposes The Sys Tick interrupt handler does not need to clear the SysTick interrupt source This will be done automatically by NVIC when the SysTick interrupt handler is called This driver is contained in driverlib systick c with driverlib systick h containing the API definitions for use by appl
207. ata contain valid data Returns None SSIDataGetNonBlocking Gets a data element from the SSI receive FIFO Prototype long SSIDataGetNonBlocking unsigned long ulBase unsigned long xpulData Parameters ulBase specifies the SSI module base address pulDaita is a pointer to a storage location for data that was received over the SSI interface Description This function gets received data from the receive FIFO of the specified SSI module and places that data into the location specified by the u Data parameter If there is no data in the FIFO then this function returns a zero This function replaces the original SSIDataNonBlockingGet API and performs the same ac tions A macro is provided in ssi h to map the original API to this API January 11 2011 18 2 2 5 18 2 2 6 Synchronous Serial Interface SSI Note Only the lower N bits of the value written to pulData contain valid data where N is the data width as configured by SSIConfigSetExpClk For example if the interface is configured for 8 bit data width only the lower 8 bits of the value written to pu Data contain valid data Returns Returns the number of elements read from the SSI receive FIFO SS IDataPut Puts a data element into the SSI transmit FIFO Prototype void SSIDataPut unsigned long ulBase unsigned long ulData Parameters ulBase specifies the SSI module base address ulData is the data to be transmitted over t
208. ata on a single message object that may be receiving data faster than the application can handle when using a single message object If multiple message objects are going to be used in a FIFO they must be read in sequential order based on the message object number and have the exact same message identifiers and filtering values All but the last of the message objects in a FIFO should have the MSG_OBJ_FIFO and the last message object in the FIFO should not have the MSG_OBJ_FIFO flag set to specify that is the last entry in the FIFO See the CAN FIFO configuration example in the Programming Examples section of this document The remaining flags are all used when calling CANMessageGet when reading data or checking the status of a message object If the MSG_OBJ_NEW_DATA flag is set in the tCANMsgObject ulFlags variable then the data returned was new and not stale data from a previous call to CAN MessageGet If the MSG_OBJ_DATA_LOST flag is set then data was lost since this message object was last read with CANMessageGet The MSG_OBJ_REMOTE_FRAME flag will be set if the message object was configured as a remote message object and a remote request was received When sending or receiving data the last two variables define the size and a pointer to the data used by CANMessageGet and CANMessageSet The ulMsgLen variable in tC ANMsgObject specifies the number of bytes to send when calling CANMessageSet and the number of bytes to read when calling CA
209. ate of the ADC Prototype unsigned long SysCtlADCSpeedGet void Description This function gets the current sample rate of the ADC Returns Returns the current ADC sample rate will be one of SYSCTL_ADCSPEED_1MSPS SYSCTL_ADCSPEED_500KSPS SYSCTL_ADCSPEED_250KSPS or SYSCTL_ADCSPEED_125KSPS SysCtlIADCSpeedSet Sets the sample rate of the ADC Prototype void SysCtlADCSpeedSet unsigned long ulSpeed Parameters ulSpeed is the desired sample rate of the ADC must be one of SYSCTL_ADCSPEED_1MSPS SYSCTL_ADCSPEED_500KSPS SYSCTL_ADCSPEED_250KSPS or SYSCTL_ADCSPEED_125KSPS Description This function sets the rate at which the ADC samples are captured by the ADC block The sampling speed may be limited by the hardware so the sample rate may end up being slower than requested SysCtIADCSpeedGet will return the actual speed in use Returns None SysCtlIBrownOutConfigSet Configures the brown out control January 11 2011 System Control Prototype void SysCt1lBrownOutConfigSet unsigned long ulConfig unsigned long ulDelay Parameters ulConfig is the desired configuration of the brown out control Must be the logical OR of SYSCTL_BOR_RESET and or SYSCTL_BOR_RESAMPLE ulDelay is the number of internal oscillator cycles to wait before resampling an asserted brown out signal This value only has meaning when SYSCTL_BOR_RESAMPLE is set and must be less than 8192 Description This function configures ho
210. ation of third parties may be subject to additional restrictions Resale of TI products or services with statements different from or beyond the parameters stated by TI for that product or service voids all express and any implied warranties for the associated TI product or service and is an unfair and deceptive business practice TI is not responsible or liable for any such statements TI products are not authorized for use in safety critical applications such as life support where a failure of the TI product would reasonably be expected to cause severe personal injury or death unless officers of the parties have executed an agreement specifically governing such use Buyers represent that they have all necessary expertise in the safety and regulatory ramifications of their applications and acknowledge and agree that they are solely responsible for all legal regulatory and safety related requirements concerning their products and any use of TI products in such safety critical applications notwithstanding any applications related information or support that may be provided by TI Further Buyers must fully indemnify TI and its representatives against any damages arising out of the use of TI products in such safety critical applications TI products are neither designed nor intended for use in military aerospace applications or environments unless the TI products are specifi cally designated by TI as military grade or enhanced plastic Only produ
211. ator PWM Parameters ulBase is the base address of the PWM module ulGenFault contains the interrupts to be disabled Must be a logical OR of any of PWM_INT_GEN_0 PWN_INT_GEN_1 PWMN_INT_GEN_ 2 PWM_INT_GEN_3 PWM_INT_FAULTO PWM_INT_FAULT1 PWM_INT_FAULT2 or PWM_INT_FAULTS3 Description Masks the specified interrupt s by clearing the specified bits of the interrupt enable register for the selected PWM module Returns None 16 2 2 24 PWMIntEnable Enables generator and fault interrupts for a PWM module Prototype void PWMIntEnable unsigned long ulBase unsigned long ulGenFault Parameters ulBase is the base address of the PWM module ulGenFault contains the interrupts to be enabled Must be a logical OR of any of PWM_INT_GEN_O PWN_INT_GEN_1 PWM_INT_GEN 2 PWM_INT_GEN_3 PWM_INT_FAULTO PWM_INT_FAULT1 PWM_INT_FAULT2 or PWM_INT_FAULTS3 Description Unmasks the specified interrupt s by setting the specified bits of the interrupt enable register for the selected PWM module Returns None 16 2 2 25 PWMIntStatus Gets the interrupt status for a PWM module Prototype unsigned long PWMIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the base address of the PWM module bMasked specifies whether masked or raw interrupt status is returned Description If bDMasked is set as true then the masked interrupt status is returned otherwise the raw interrupt status will be returne
212. availability of hardware flow control varies with the Stellaris part and UART in use Please consult the datasheet for the part you are using to determine whether this support is available Returns Returns the current flow control mode in use This is a logical OR combination of values UART_FLOWCONTROL_TX if transmit CTS flow control is enabled and UART_FLOWCONTROL_RXx if receive RTS flow control is in use If hardware flow control is disabled VART_FLOWCONTROL_NONE will be returned UARTFlowControlSet Sets the UART hardware flow control mode to be used Prototype void UARTFlowControlSet unsigned long ulBase unsigned long ulMode Parameters ulBase is the base address of the UART port ulMode indicates the flow control modes to be used This is a logical OR combination of val ues UART_FLOWCONTROL_TX and UART_FLOWCONTROL_RX to enable hardware transmit CTS and receive RTS flow control or UART_FLOWCONTROL_NONE to dis able hardware flow control Description Sets the required hardware flow control modes If ulMode contains flag UART_FLOWCONTROL_TX data is only transmitted if the incoming CTS signal is as serted If u Mode contains flag UART_FLOWCONTROL_RXxX the RTS output is controlled by the hardware and is asserted only when there is space available in the receive FIFO If no hardware flow control is required VART_FLOWCONTROL_NONE should be passed Note The availability of hardware flow control varies with the
213. ave set the slave address and have enabled the I2C Slave block The parameter ucSlaveAdoar is the value that will be compared against the slave address sent by an I2C master Returns None 11 2 2 22 2CSlavelntClear Clears I2C Slave interrupt sources Prototype void I2CSlaveIntClear unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description The 12C Slave interrupt source is cleared so that it no longer asserts This must be done in the interrupt handler to keep it from being called again immediately upon exit Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None 11 2 2 23 2CSlavelntClearEx Clears 12C Slave interrupt sources Prototype void T2CSlaveIntClearEx unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the base address of the I2C Slave module ullntFlags is a bit mask of the interrupt sources to be cleared 164 January 11 2011 Inter Int
214. before the the peripheral is actually enabled During this time attempts to access the peripheral will result in a bus fault Care should be taken to ensure that the peripheral is not accessed during this brief time period Returns January 11 2011 None 275 System Control 19 2 2 29 SysCtlPeripheralPresent Determines if a peripheral is present Prototype tBoolean SysCtlPeripheralPresent unsigned long ulPeripheral Parameters ulPeripheral is the peripheral in question Description Determines if a particular peripheral is present in the device Each member of the Stellaris family has a different peripheral set this will determine which are present on this device The ulPeripheral parameter must be only one of the following values SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CANO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2CO SYSCTL_PERIPH_12C1 SYSCTL_PERIPH_12S0 SYSCTL_PERIPH_IEEE1588 SYSCTL_PERIPH_MPU SYSCTL_PERIPH_PLL SYSCTL_PERIPH_ PWM SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER1
215. below is in the list passed to this function then the default peripheral marked as _DEF_ will be selected UDMA_DEF_USBEP1RX_SEC_UART2RX UDMA_DEF_USBEP1TX_SEC_UART2TX UDMA_DEF_USBEP2RX_SEC_TMR3A UDMA_DEF_USBEP2TX_SEC_TMR3B UDMA_DEF_USBEP3RX_SEC_TMR2A UDMA_DEF_USBEP3TX_SEC_TMR2B UDMA_DEF_ETHORX_SEC_TMR2A UDMA_DEF_ETHOTX_SEC_TMR2B UDMA_DEF_UARTORX_SEC_UART1RX UDMA_DEF_UARTOTX_SEC_UART1TX UDMA_DEF_SSIORX_SEC_SSI1RX UDMA_DEF_SSIOTX_SEC_SSI1TX UDMA_DEF_RESERVED_SEC_UART2RX UDMA_DEF_RESERVED_SEC_UART2TX UDMA_DEF_ADC00_SEC_TMR2A UDMA_DEF_ADC01_SEC_TMR2B UDMA_DEF_ADC02_SEC_RESERVED UDMA_DEF_ADC03_SEC_RESERVED UDMA_DEF_TMROA_SEC_TMR1A UDMA_DEF_TMROB_SEC_TMR1B UDMA_DEF_TMR1A_SEC_EPIORX UDMA_DEF_TMR1B_SEC_EPIOTX UDMA_DEF_UART1RX_SEC_RESERVED UDMA_DEF_UART1TX_SEC_RESERVED UDMA_DEF_SSI1RX_SEC_ADC10 UDMA_DEF_SSI1TX_SEC_ADC11 UDMA_DEF_RESERVED_SEC_ADC12 UDMA_DEF_RESERVED_SEC_ADC13 UDMA_DEF_I2SORX_SEC_RESERVED UDMA_DEF_I2S0TX_SEC_RESERVED Returns None 23 2 3 12 uDMAChannelSelectSecondary Selects the secondary peripheral for a set of UDMA channels 342 January 11 2011 uDMA Controller Prototype void uDMAChannelSelectSecondary unsigned long ulSecPeriphs Parameters ulSecPeriphs is the logical or of the UDMA channels for which to use the secondary periph eral instead of the default peripheral Description This function is used to select th
216. bjects are empty unused Returns Returns the value of the status register 5 3 CAN Message Objects This section will explains how to configure the CAN message objects in various modes using the CANMessageSet and CANMessageGet APIs The configuration of a message object is deter January 11 2011 63 Controller Area Network CAN 64 mined by two parameters that are passed into the CANMessageSet API These are the tCANMs gObject structure and the tMsgObjType type field It is important to note that the ulObjID parameter is the index of one of the 32 message objects that are available and is not the message object s identifier Message objects can be defined as one of five types based on the needs of the application They are defined in the tMsgObjlype enumeration and can only be one of those values The simplest of the message object types are MSG_OBJ_TYPE_TX and MSG_OBJ_TYPE_RX which are used to send or receive messages for a given message identifier or a range of identifiers The mes sage type MSG_OBJ_TYPE_TX_REMOTE is used to transmit a remote request for data from another CAN node on the network These message objects do not transmit any data but once they send the request will automatically turn into receive message object and wait for data from a remote CAN device The message type MSG_OBJ_TYPE_RX_REMOTE is the receiving end of a remote request and receive remote requests for data and generate an interrupt to let the a
217. ble depends on the oversampling factor set by AD CSoftwareOversampleConfigure The value of ulConfig is the same as defined for ADCSe quenceStepConfigure Returns None January 11 2011 39 Analog to Digital Converter ADC 4 3 40 Programming Example The following example shows how to use the ADC API to initialize a sample sequence for processor triggering trigger the sample sequence and then read back the data when it is ready unsigned long ulValue Enable the first sample sequence to capture the value of channel 0 when the processor trigger occurs ADCSequenceConfigure ADCO_BASE 0 ADC_TRIGGER_PROCESSOR 0 ADCSequenceStepConfigure ADCO_BASE 0 0 ADC_CTL_IE ADC_CTL_END ADC_CTL_CH0O ADCSequenceEnable ADCO_BASE 0 Trigger the sample sequence ADCProcessorTrigger ADCO_BASE 0 Wait until the sample sequence has completed while ADCIntStatus ADCO_BASE 0 false Read the value from the ADC ADCSequenceDataGet ADCO_BASE 0 amp ulValue January 11 2011 5 1 Controller Area Network CAN Controller Area Network CAN ul erot e o IE EE EEE E A TTT E E T A E A E ETET 41 AP POMC corrandatda niread o Aa eA eaa a E 41 CAN MeSS30e ODECIE aiinknleusdendemmea nie aainadecadameniont ease O OIER 63 Programming Example coicciranirhentcanennaprrniennew oni E IRET EE OPEN NRE ER ENEE 65 Introduction The Controller Area Netwo
218. bout registering interrupt handlers Returns None SysTickintUnregister Unregisters the interrupt handler for the SysTick interrupt Prototype void SysTickIntUnregister void Description This function will clear the handler to be called when a SysTick interrupt occurs See also IntRegister for important information about registering interrupt handlers January 11 2011 287 System Tick SysTick Returns None 20 2 2 7 SysTickPeriodGet Gets the period of the SysTick counter Prototype unsigned long SysTickPeriodGet void Description This function returns the rate at which the SysTick counter wraps this equates to the number of processor clocks between interrupts Returns Returns the period of the SysTick counter 20 2 2 8 SysTickPeriodSet Sets the period of the SysTick counter Prototype void SysTickPeriodSet unsigned long ulPeriod Parameters ulPeriod is the number of clock ticks in each period of the SysTick counter must be between 1 and 16 777 216 inclusive Description This function sets the rate at which the SysTick counter wraps this equates to the number of processor clocks between interrupts Note Calling this function does not cause the SysTick counter to reload immediately If an immediate reload is required the NVIC_ST_CURRENT register must be written Any write to this register clears the SysTick counter to 0 and will cause a reload with the u Period supplied h
219. can be marked as read only or execute only providing differing levels of code protection Read only blocks cannot be erased or programmed protecting the contents of those blocks from being modified Execute only blocks can not be erased or programmed and can only be read by the processor instruction fetch mechanism protecting the contents of those blocks from being read by either the processor or by debuggers The flash can be programmed on a word by word basis Programming causes 1 bits to become 0 bits where appropriate because of this a word can be repeatedly programmed so long as each programming operation only requires changing 1 bits to 0 bits The timing for the flash is automatically handled by the flash controller In order to do this the flash controller must know the clock rate of the system in order to be able to time the number of micro seconds certain signals are asserted The number of clock cycles per micro second must be provided to the flash controller for it to accomplish this timing The flash controller has the ability to generate an interrupt when an invalid access is attempted such as reading from execute only flash This can be used to validate the operation of a program the interrupt will keep invalid accesses from being silently ignored hiding potential bugs The flash protection can be applied without being permanently enabled this along with the interrupt allows the program to be debugged before the flash prot
220. ccesses a region may occur while that region is in the process of being changed The safest way to handle this is to disable a region before changing it Refer to the discussion of this in the API Detailed Description section Returns None 14 3 Programming Example The following example sets up a basic set of protection regions to provide the following m a 28 KB region in flash for read only code execution m 32 KB of RAM for read write access in privileged and user modes m an additional 8 KB of RAM for use only in privileged mode 204 1 MB of peripheral space for access only in privileged mode except for a 128 KB hole that is not accessible at all and another 128 KB region within that is accessible from user mode Define a 28 KB region of flash from 0x00000000 to 0x00007000 The region will be executable and read only for both privileged and user modes To set up the region a 32 KB region 0 will be defined starting at address 0 and then a 4 KB hole removed at the end by disabling the last sub region The region will be initially enabled MPURegionSet 0 0 MPU_RGN_SIZE_32K MPU_RGN_PERM_EXEC MPU_RGN_PERM_PRV_RO_USR_RO MPU_SUB_RGN_DISABLE_7 MPU_RGN_ENABLBE Define a 32 KB region 1 of RAM from 0x20000000 to 0x20008000 The region will not be executable and will be read write access for privileged and user modes fil MPURegionSet 1 0x20000000 MPU_RGN_SIZE_32K MPU_RG
221. ccurs while the region attributes are being changed The attributes of a region that has already been programmed can be retrieved and saved using the MPURegionGet function This function is intended to save the attributes in a format that can be used later to reload the region using the MPURegionSet function Note that the enable state of the region is saved with the attributes and will take effect when the region is reloaded When one or more regions are defined the MPU can be enabled by calling MPUEnable This turns on the MPU and also defines the behavior in privileged mode and in the Hard Fault and NMI fault handlers The MPU can be configured so that when in privileged mode and no regions are en abled a default memory map is applied If this feature is not enabled then a memory management fault is generated if the MPU is enabled and no regions are configured and enabled The MPU can also be set to use a default memory map when in the Hard Fault or NMI handlers instead of using the configured regions All of these features are selected when calling MPUEnable When the MPU is enabled it can be disabled by calling MPUDisable Finally if the application is using run time interrupt registration see IntRegister then the function MPUIntRegister can be used to install the fault handler which will be called whenever a memory protection violation occurs This function will also enable the fault handler If compile time interrupt regis
222. ceive FIFO Prototype tBoolean UARTCharsAvail unsigned long ulBase January 11 2011 311 UART 22 2 2 8 22 2 2 9 312 Parameters ulBase is the base address of the UART port Description This function returns a flag indicating whether or not there is data available in the receive FIFO Returns Returns true if there is data in the receive FIFO or false if there is no data in the receive FIFO UARTConfigGetExpClk Gets the current configuration of a UART Prototype void UARTConfigGetExpClk unsigned long ulBase unsigned long ulUARTC1lk unsigned long x pulBaud unsigned long pulConfig Parameters ulBase is the base address of the UART port ulUARTCIk is the rate of the clock supplied to the UART module pulBaud is a pointer to storage for the baud rate pulConfig is a pointer to storage for the data format Description The baud rate and data format for the UART is determined given an explicitly provided periph eral clock hence the ExpClk suffix The returned baud rate is the actual baud rate it may not be the exact baud rate requested or an official baud rate The data format returned in pulConfig is enumerated the same as the u Config parameter of UARTConfigSetExpClk The peripheral clock will be the same as the processor clock This will be the value returned by SysCtlClockGet or it can be explicitly hard coded if it is constant and known to save the code execution overhead of
223. ces values above SYSCTL_XTAL_8 _19MHZ are not valid The oscillator source is chosen with one of the following values SYSCTL_OSC_MAIN SYSCTL_OSC_INT SYSCTL_OSC_INT4 SYSCTL_OSC_INT30 or SYSCTL_OSC_EXT32 On Sandstorm class devices SYSCTL_OSC_INT30 and SYSCTL_OSC_EXT32 are not valid SYSCTL_OSC_EXT32 is only available on devices with the hibernate module and then only when the hibernate module has been enabled The internal and main oscillators are disabled with the SYSCTL_INT_OSC DIS and SYSCTL_MAIN_OSC_DIS flags respectively The external oscillator must be enabled in order to use an external clock source Note that attempts to disable the oscillator used to clock the device will be prevented by the hardware January 11 2011 System Control To clock the system from an external source such as an external crystal oscillator use SYSCTL_USE_OSC SYSCTL_OSC_MAIN To clock the system from the main oscillator use SYSCTL_USE_OSC SYSCTL_OSC_MAIN To clock the system from the PLL use SYSCTL_USE_PLL SYSCTL_OSC_MAIN and select the appropriate crystal with one of the SYSCTL_XTAL_xxx values Note If selecting the PLL as the system clock source that is via SYSCTL_USE_PLL this function will poll the PLL lock interrupt to determine when the PLL has locked If an interrupt handler for the system control interrupt is in place and it responds to and clears the PLL lock interrupt this function will delay until its timeout has occurred in
224. controllers once the mode of the USB controller is configured the device or host APIs should be used The remainder of the APIs are used for both USB host and USB device controllers The USBEndpoint APIs are used to configure and access the endpoints while the USBFIFO APIs are used to configure the size and location of the FIFOs Using USB with the uDMA Controller The USB controller can be used with the uDMA for either sending or receiving data with both host and device controllers The uDMA controller cannot be used to access endpoint 0 however all other endpoints are capable of using the uDMA controller The uDMA channel numbers for USB are defined by the following values m DMA_CHANNEL_USBEP1RX DMA_CHANNEL_USBEP1TX m DMA_CHANNEL_USBEP2RX DMA_CHANNEL_USBEP2TX DMA_CHANNEL_USBEP3RX DMA_CHANNEL_USBEP3TX Since the uDMA controller views transfers as either transmit or receive and the USB controller operates on IN OUT transactions some care must be taken to use the correct UDMA channel with the correct endpoint USB host IN and USB device OUT endpoints both use receive UDMA channels while USB host OUT and USB device IN endpoints will use transmit UDMA channels When configuring the endpoint there are additional DMA settings needed When calling USB DevEndpointConfigSet for an endpoint that will use UDMA extra flags need to be added to the ulFlags parameter These flags are one of USB_EP_DMA_MODE_0 or USB_EP_DMA_MODE_1 to control the mode o
225. cts designated by TI as military grade meet military specifications Buyers acknowledge and agree that any such use of TI products which TI has not designated as military grade is solely at the Buyer s risk and that they are solely responsible for compliance with all legal and regulatory requirements in connection with such use TI products are neither designed nor intended for use in automotive applications or environments unless the specific TI products are designated by TI as compliant with ISO TS 16949 requirements Buyers acknowledge and agree that if they use any non designated products in automotive applications TI will not be responsible for any failure to meet such requirements Following are URLs where you can obtain information on other Texas Instruments products and application solutions Products Applications Amplifiers amplifier ti com Audio Ser ree Data Converters dataconverter ti com Automotive ma DLP Products www dlp com Broadband RRE eee ee DSP dsp ti com Digital Control add atolls Meeae lili Clocks and Timers www ti com clocks Medical sevens T commedia Interface interface ti com Military www tconmmiitary Logic logic ti com Optical Networking www ti com opticalnetwork Power Mgmt power ti com Security www ti com security Microcontrollers microcontroller ti com Telephony www ti com telephony RFID www ti rfid com Video amp Imaging www ti com video RF IF and ZigBee Solutions www ti com Iprf Wireless
226. d January 11 2011 231 Pulse Width Modulator PWM Returns The current interrupt status enumerated as a bit field of PWM_INT_GEN 0 PWM_INT_GEN 1 PWM_INT_GEN 2 PWM_INT_GEN_3 PWM_INT_FAULTO PWM_INT_FAULT1 PWM_INT_FAULT2 and PWM_INT_FAULTS3 16 2 2 26 PWMOutputFault Specifies the state of PWM outputs in response to a fault condition Prototype void PWMOutputFault unsigned long ulBase unsigned long ulPWMOutBits tBoolean bFaultSuppress Parameters ulBase is the base address of the PWM module ulPWMOutBits are the PWM outputs to be modified Must be the logical OR of any of PWM_OUT_0 BIT PWM_OUT_1_BIT PWM_OUT_2_ BIT PWM_OUT_ 3 BIT PWM_OUT_4 BIT PWM_OUT_5 BIT PWM_OUT 6 BIT or PWM_OUT_7 BIT bFaultSuppress determines if the signal is suppressed or passed through during an active fault condition Description This function sets the fault handling characteristics of the selected PWM outputs The outputs are selected using the parameter u PWMOutBits The parameter bFaultSuppress determines the fault handling characteristics for the selected outputs If bFau tSuppress is true then the selected outputs will be made inactive If bFaultSuppress is false then the selected outputs are unaffected by the detected fault On devices supporting extended PWM fault handling the state the affected output pins are driven to can be configured with PWMOutputFaultLevel If not configured or if the device does not support
227. d disable interrupts register interrupt handlers and set the priority of interrupts The NVIC provides global interrupt masking prioritization and handler dispatching This version of the Stellaris family supports thirty two interrupt sources and eight priority levels Individual inter rupt sources can be masked and the processor interrupt can be globally masked as well without affecting the individual source masks The NVIC is tightly coupled with the Cortex M3 microprocessor When the processor responds to an interrupt NVIC will supply the address of the function to handle the interrupt directly to the processor This eliminates the need for a global interrupt handler that queries the interrupt controller to determine the cause of the interrupt and branch to the appropriate handler reducing interrupt response time The interrupt prioritization in the NVIC allows higher priority interrupts to be handled before lower priority interrupts as well as allowing preemption of lower priority interrupt handlers by higher prior ity interrupts Again this helps reduce interrupt response time for example a 1 ms system control interrupt is not held off by the execution of a lower priority 1 second housekeeping interrupt handler Sub prioritization is also possible instead of having N bits of preemptable prioritization NVIC can be configured via software for N M bits of preemptable prioritization and M bits of subpriority In this scheme two
228. d interrupt status is requested Description This returns the interrupt status for the 12C Master module Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned Returns The current interrupt status returned as true if active or false if not active January 11 2011 161 Inter Integrated Circuit 12C 11 2 2 16 2CMasterSlaveAddrSet Sets the address that the 12C Master will place on the bus Prototype void I2CMasterSlaveAddrSet unsigned long ulBase unsigned char ucSlaveAddr tBoolean bReceive Parameters ulBase is the base address of the 12C Master module ucSlaveAddr 7 bit slave address bReceive flag indicating the type of communication with the slave Description This function will set the address that the 12C Master will place on the bus when initiating a transaction When the bReceive parameter is set to true the address will indicate that the I2C Master is initiating a read from the slave otherwise the address will indicate that the 12C Master is initiating a write to the slave Returns None 11 2 2 17 2CSlaveDataGet Receives a byte that has been sent to the I2C Slave Prototype unsigned long I2CSlaveDataGet unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description This function reads a byte of data from the 12C Slave Data Register Returns Returns the byte received from by
229. d long ulRegion unsigned long ulAddr unsigned long ulFlags January 11 2011 197 Memory Protection Unit MPU 14 2 1 14 2 2 14 2 2 1 198 Detailed Description The MPU APIs provide a means to enable and configure the MPU and memory protection regions Generally the memory protection regions should be defined before enabling the MPU The regions can be configured by calling MPURegionSet once for each region to be configured A region that is defined by MPURegionSet can be initially enabled or disabled If the region is not initially enabled it can be enabled later by calling MPURegionEnable An enabled region can be disabled by calling MPURegionDisable When a region is disabled its configuration is preserved as long as it is not overwritten In this case it can be enabled again with MPURegionEnable without the need to reconfigure the region Care must be taken when setting up a protection region using MPURegionSet The function will write to multiple registers and is not protected from interrupts Therefore it is possible that an interrupt which accesses a region may occur while that region is in the process of being changed The safest way to protect against this is to make sure that a region is always disabled before making any changes Otherwise it is up to the caller to ensure that MPURegionSei is always called from within code that cannot be interrupted or from code that will not be affected if an interrupt o
230. d long ull2CClk tBoolean bFast Parameters ulBase is the base address of the I2C Master module ull2CClk is the rate of the clock supplied to the 12C module bFast set up for fast data transfers January 11 2011 159 Inter Integrated Circuit 12C Description This function initializes operation of the 12C Master block Upon successful initialization of the I2C block this function will have set the bus speed for the master and will have enabled the 12C Master block If the parameter bFast is true then the master block will be set up to transfer data at 400 kbps otherwise it will be set up to transfer data at 100 kbps The peripheral clock will be the same as the processor clock This will be the value returned by SysCtlClockGet or it can be explicitly hard coded if it is constant and known to save the code execution overhead of a call to SysCtlClockGet This function replaces the original 2CMasterlInit API and performs the same actions A macro is provided in i2c h to map the original API to this API Returns None 11 2 2 12 2CMasterlntClear Clears I2C Master interrupt sources Prototype void I2CMasterIntClear unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description The I2C Master interrupt source is cleared so that it no longer asserts This must be done in the interrupt handler to keep it from being called again immediately upon exit Note
231. d when the function was called or false if they were initially enabled IntPendClear Unpends an interrupt Prototype void IntPendClear unsigned long ulInterrupt Parameters ullnterrupt specifies the interrupt to be unpended Description The specified interrupt is unpended in the interrupt controller This will cause any previously generated interrupts that have not been handled yet due to higher priority interrupts or the interrupt no having been enabled yet to be discarded January 11 2011 Interrupt Controller NVIC Returns None 13 2 2 6 IntPendSet Pends an interrupt Prototype void IntPendSet unsigned long ulInterrupt Parameters ullnterrupt specifies the interrupt to be pended Description The specified interrupt is pended in the interrupt controller This will cause the interrupt con troller to execute the corresponding interrupt handler at the next available time based on the current interrupt state priorities For example if called by a higher priority interrupt handler the specified interrupt handler will not be called until after the current interrupt handler has completed execution The interrupt must have been enabled for it to be called Returns None 13 2 2 7 IntPriorityGet Gets the priority of an interrupt Prototype long IntPriorityGet unsigned long ulInterrupt Parameters ullnterrupt specifies the interrupt in question Description This function gets the
232. d with Gen0 PWM2 and PWM3 are associated with Gen1 PWM4 and PWM5 are associated with Gen2 and PWM6 and PWM7 are associated with Gen3 Also as a simplifying assumption for this API comparator A for each generator block is used ex clusively to adjust the pulse width of the even numbered PWM outputs PWMO0 PWM2 PWM4 and PWM6 In addition comparator B is used exclusively for the odd numbered PWM outputs PWM1 PWM3 PWM5 and PWM7 Note that the number of generators and PWM outputs supported varies depending upon the Stel laris part in use Please consult the datasheet for the part you are using to determine whether it supports 3 or 4 generators and 6 or 8 outputs 16 2 2 Function Documentation 16 2 2 1 PWMDeadBandDisable Disables the PWM dead band output Prototype void PWMDeadBandDisable unsigned long ulBase unsigned long ulGen Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to modify Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_ 2 or PWM_GEN_ 3 Description This function disables the dead band mode for the specified PWM generator Doing so decou ples the OutA and OutB signals Returns None January 11 2011 217 Pulse Width Modulator PWM 16 2 2 2 16 2 2 3 218 PWMDeadBandEnable Enables the PWM dead band output and sets the dead band delays Prototype void PWMDeadBandEnable unsigned long ulBase unsigned long ulGen unsigned short usRise un
233. ddress of the timer module ullntFlags is the bit mask of the interrupt sources to be enabled Description Enables the indicated timer interrupt sources Only the sources that are enabled can be re flected to the processor interrupt disabled sources have no effect on the processor The ullntFlags parameter must be the logical OR of any combination of the following TIMER_CAPB_EVENT Capture B event interrupt TIMER_CAPB_MATCH Capture B match interrupt TIMER_TIMB_TIMEOUT Timer B timeout interrupt TIMER_RTC_MATCH RTC interrupt mask a TIMER_CAPA_EVENT Capture A event interrupt TIMER_CAPA_MATCH Capture A match interrupt TIMER_TIMA_TIMEOUT Timer A timeout interrupt Returns None 21 2 2 12 TimerlntRegister Registers an interrupt handler for the timer interrupt Prototype void TimerIntRegister unsigned long ulBase unsigned long ulTimer void pfnHandler void 298 January 11 2011 Timer Parameters ulBase is the base address of the timer module ulTimer specifies the timer s must be one of TIMER_A TIMER_B or TIMER_BOTH pfnHandler is a pointer to the function to be called when the timer interrupt occurs Description This sets the handler to be called when a timer interrupt occurs This will enable the global in terrupt in the interrupt controller specific timer interrupts must be enabled via TimerlntEnable It is the interrupt handler s responsibility to clear the interr
234. diately If space is available the function will return once BufLen bytes of the packet have been placed into the FIFO and the transmitter has been started The function will not wait for the transmission to complete The function will return the negated BufLen if the length is larger than the space available in the transmit FIFO This function replaces the original EthernetPacketNonBlockingPut API and performs the same actions A macro is provided in ethernet h to map the original API to this API Note This function does not block and will return immediately if no space is available for the transmit packet Returns Returns 0 if no space is available in the transmit FIFO the negated packet length IBufLen if the packet is too large for FIFO and the packet length IBufLen otherwise EthernetPHYPowerOff Powers off the Ethernet PHY Prototype void EthernetPHYPowerOff unsigned long ulBase Parameters ulBase is the base address of the controller January 11 2011 6 2 2 20 6 2 2 21 6 2 2 22 Ethernet Controller Description This function will power off the Ethernet PHY reducing the current consuption of the device While in the powered off state the Ethernet controller will be unable to connect to the Ethernet Returns None EthernetPHYPowerOn Powers on the Ethernet PHY Prototype void EthernetPHYPowerOn unsigned long ulBase Parameters ulBase is the base address of the controller
235. ds to be enabled so it can start sending data I2STxEnable I12S0_BASE At this point the I2S should be generating an interrupt with a service request Within the interrupt handler Get the interrupt status to see what the interrupt is ulStatus I2SIntStatus I2SO_BASE true Clear the pending interrupts I2SIntClear I2SO_BASE ulStatus Determine if there was an error if ulStatus amp I2S_INT_TXERR handle the error Handle the TX service request if ulStatus amp I2S_INT_TXREQ needs more data so write as much more data as will fit while I2STxFIFOLevelGet I2SO_BASE lt 14 Get next L R sample pair in compact 16 format from some buffer code not shown here I2STxDataPutNonBlocking I2SO_BASE ulDataSamples Inter IC Sound 12S 185 Inter IC Sound 12S 186 January 11 2011 Interrupt Controller NVIC 13 Interrupt Controller NVIC iio le pee estes et ee eee rere AE Y E ERTE TA Teeter ree A SS TTET 187 AP PONCHO chc2ccc ida divoncianietneheale well ewsriaecdd auc ee alee dates sie euerl ASi 188 Programming ERIN DIE ccc sarnremaeaeiapisdn edd caeeagemeeertbagenecEsepegarsouqueneckeebedeqramemaedes 195 13 1 Introduction The interrupt controller API provides a set of functions for dealing with the Nested Vectored Inter rupt Controller NVIC Functions are provided to enable an
236. e void SysCtlPeripheralClockGating tBoolean bEnable void SysCtlPeripheralDeepSleepDisable unsigned long ulPeripheral void SysCtlPeripheralDeepSleepEnable unsigned long ulPeripheral void SysCtlPeripheralDisable unsigned long ulPeripheral void SysCtlPeripheralEnable unsigned long ulPeripheral tBoolean SysCtlPeripheralPresent unsigned long ulPeripheral void SysCtlPeripheralReset unsigned long ulPeripheral void SysCtlPeripheralSleepDisable unsigned long ulPeripheral void SysCtlPeripheralSleepEnable unsigned long ulPeripheral tBoolean SysCtlPinPresent unsigned long ulPin void SysCtIPLLVerificationSet tBoolean bEnable unsigned long SysCtIPWMClockGet void void SysCtIPWMClockSet unsigned long ulConfig void SysCtlReset void void SysCtlResetCauseClear unsigned long ulCauses unsigned long SysCtlResetCauseGet void void SysCtlSleep void unsigned long SysCtISRAMSizeGet void void SysCtlIUSBPLLDisable void void SysCtlIUSBPLLEnable void 19 2 1 Detailed Description The SysCtl API is broken up into eight groups of functions those that provide device information those that deal with device clocking those that provide peripheral control those that deal with the SysCtl interrupt those that deal with the LDO those that deal with sleep modes those that deal with reset reasons those that deal with the brown out reset and those that deal with clock verification timers Information about the device is provid
237. e void GPIOIntTypeSet unsigned long ulPort unsigned char ucPins unsigned long ullIntType Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s ullntType specifies the type of interrupt trigger mechanism Description This function sets up the various interrupt trigger mechanisms for the specified pin s on the selected GPIO port The parameter ullntType is an enumerated data type that can be one of the following values GPIO_FALLING_EDGE GPIO_RISING_EDGE GPIO_ BOTH EDGES GPIO_LOW_LEVEL GPIO_HIGH_ LEVEL where the different values describe the interrupt detection mechanism edge or level and the particular triggering event falling rising or both edges for edge detect low or high for level detect The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note In order to avoid any spurious interrupts the user must ensure that the GPIO inputs remain stable for the duration of this function Returns None 9 2 2 5 GPlOPadConfigGet Gets the pad configuration for a pin Prototype void GPIOPadConfigGet unsigned long ulPort unsigned char ucPin unsigned long pulStrength unsigned long xpulPinType Parameters ulPort is the base address of the GPIO port ucPin is the p
238. e void QETVelocityDisable unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This will disable operation of the velocity capture in the quadrature encoder module Returns None 17 2 2 16 QEIVelocityEnable Enables the velocity capture Prototype void QETVelocityEnable unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This will enable operation of the velocity capture in the quadrature encoder module It must be configured before it is enabled Velocity capture will not occur if the quadrature encoder is not enabled See also QEIVelocityConfigure and QEIEnable Returns None January 11 2011 245 Quadrature Encoder QE 17 2 2 17 QEIVelocityGet 17 3 246 Gets the current encoder speed Prototype unsigned long QETVelocityGet unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This returns the current speed of the encoder The value returned is the number of pulses detected in the specified time period this number can be multiplied by the number of time periods per second and divided by the number of pulses per revolution to obtain the number of revolutions per second Returns Returns the number of pulses captured in the given time period Programming Example The following example shows how to
239. e void UARTParityModeSet unsigned long ulBase unsigned long ulParity Parameters ulBase is the base address of the UART port ulParity specifies the type of parity to use Description Sets the type of parity to use for transmitting and expect when receiving The ulPar ity parameter must be one of UART_CONFIG_PAR_NONE UART_CONFIG_PAR_EVEN UART_CONFIG_PAR_ODD UART_CONFIG_PAR_ONE or UART_CONFIG_PAR_ZERO The last two allow direct control of the parity bit it is always either one or zero based on the mode Returns None 22 2 2 34 UARTRxErrorClear Clears all reported receiver errors Prototype void UARTRxErrorClear unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function is used to clear all receiver error conditions reported via UARTRxErrorGet If using the overrun framing error parity error or break interrupts this function must be called after clearing the interrupt to ensure that later errors of the same type trigger another interrupt Returns None 324 January 11 2011 UART 22 2 2 35 UARTRxErrorGet Gets current receiver errors Prototype unsigned long UARTRxErrorGet unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function returns the current state of each of the 4 receiver error sources The returned errors are equivalent to the four error bits returned via the pr
240. e a channel parameter that includes the logical OR of one of the values UDMA_PRI_SELECT or UDMA_ALT_SELECT to choose the primary or alternate control structure For Basic and Auto transfer modes only the primary control structure is needed The alternate control structure is only needed for complex transfer modes of Ping pong or Scatter gather Refer to the device data sheet for detailed information about transfer modes Special considerations for using scatter gather operations In order to use the scatter gather modes of the uDMA controller you must prepare a task list in memory that describes the scatter gather operations There is a helper macro UDMATaskStructEn try provided to help create the initialization values for the task list structure Please see the docu mentation for this macro which includes a code snippet showing how it is to be used Once the task list is prepared the appropriate UDMA channel must be configured for a scatter gather operation The best way to do this is to use the function UDMAChannelScatterGatherSet Alternatively the functions UDMAChannelControlSet followed by uUDMAChannelTransferSet can also be used Note The scatter gather task list must be resident in SRAM The uDMA controller cannot read from flash memory About uDMA Channel Function Parameters Many of the uDMA API functions require a channel number as a parameter There are two different uses of the channel number In some cases it i
241. e address of the ADC module ulSequenceNum is the sample sequence number Description The specified sample sequence interrupt is cleared so that it no longer asserts This must be done in the interrupt handler to keep it from being called again immediately upon exit Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None ADClIntDisable Disables a sample sequence interrupt Prototype void ADCIntDisable unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description This function disables the requested sample sequence interrupt Returns None ADClIntEnable Enables a sample sequence interrupt January 11 2011 4 2 2 12 4 2 2 13 Analog to Digital Converter ADC Prototype void ADCIntEnable unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module
242. e aia ea see ee Aa fa fare esau E Sta Wek a We SO ee 103 g1 UMPOOUDION fb see be bea eae tie ek eR RDA wy eR Ls Ree 103 82 PUP UNIONS o coroni ia ha ENE a Se hae ee be eS HG Ged See ai aie 103 8 3 Programming Example lt 20 2 6 we ee ee ee a ee Ge ol eae ee 111 9 OPIO oone eee edad Suet e caters Ss Set eT De ee te tee eee Gee Sek Se ws wh wt Se a eee 113 O14 UNMOOUDHON s aw eeee bebe eee RRR PA ee eee Re ae amp Gere 113 9a APIFUNCGIONS o ioei bk ee Hs eee de ae aw a Se ee ee alae A 114 9 3 Programming Example lt sea aeaa meretes Aaa a aA hb bite de ee eee RE Rs 132 10 Hibernation Module 2 2 2 aaa aana aa 135 TOS MUOAUGION sis co aiei Ra car de d a a eR RRR RA we Reo BR ead Bee ee 135 102 ARUP URCUONS iiio ee Re a Ra ERR PREG ee eee ae did Anew ees 135 10 3 Programming Example lt lt gt s kee wR RR EE eee RR RE a Re 148 11 Inter Integrated Circuit I2C 2 153 ELE USOUCUS 2 one eee RATA Se RARE REE Eee Eee eB ee oe eee 153 112 APRONGHBNE og 524 ra i ae EE ee Pe we RE ee ee ee 154 11 3 Programming Example kG eR OR ER EEE EGG ee ERY Ree Ee 168 January 11 2011 3 Table of Contents 12 12 1 12 2 12 3 13 13 1 13 2 13 3 14 14 4 14 2 14 3 15 19 15 2 15 3 16 16 1 16 2 16 3 17 17 1 ti 17 3 18 18 1 18 2 18 3 19 19 1 19 2 19 3 20 20 1 20 2 20 3 21 21 1 21 2 21 3 22 22 1 222 22 3 23 23 1 23 2 23 3 InterIC Sound 125 0 ke
243. e aligned according to the size The u Flags parameter is the logical OR of all of the attributes of the region It is a combination of choices for region size execute permission read write permissions disabled sub regions and a flag to determine if the region is enabled The size flag determines the size of a region and must be one of the following MPU_RGN_SIZE_32B MPU_RGN_SIZE_64B MPU_RGN_SIZE_128B MPU_RGN_SIZE_256B MPU_RGN_SIZE_512B MPU_RGN_SIZE_1K MPU_RGN_SIZE_2K MPU_RGN_SIZE_4K MPU_RGN_SIZE_8K MPU_RGN_SIZE_16K MPU_RGN_SIZE_32K MPU_RGN_SIZE_64K MPU_RGN_SIZE_128K MPU_RGN_SIZE_256K January 11 2011 Memory Protection Unit MPU MPU_RGN_SIZE_512K MPU_RGN_SIZE_1M MPU_RGN_SIZE_2M MPU_RGN_SIZE_4M MPU_RGN_SIZE_8M MPU_RGN_SIZE_16M MPU_RGN_SIZE_32M MPU_RGN_SIZE_64M MPU_RGN_SIZE_128M MPU_RGN_SIZE_256M MPU_RGN_SIZE_512M MPU_RGN_SIZE_1G MPU_RGN_SIZE_2G MPU_RGN_SIZE_4G The execute permission flag must be one of the following MPU_RGN_PERM_EXEC enables the region for execution of code MPU_RGN_PERM_NOEXEC disables the region for execution of code The read write access permissions are applied separately for the privileged and user modes The read write access flags must be one of the following MPU_RGN_PERM_PRV_NO_USR_NO no access in privileged or user mode MPU_RGN_PERM_PRV_RW_USR_NO privileged read write user no access MPU_RGN_PERM_PRV_RW_USR_RO privileged read write user read only MPU_RGN_PERM_PRV_RW_USR_RW pri
244. e endpoint s FIFO The blsLast Packet parameter is set to a true value if this is the last in a series of data packets on endpoint zero The bisLastPacket parameter is not used for endpoints other than endpoint zero This call can be used if processing is required between reading the data and acknowledging that the data has been read Note This function should only be called in device mode Returns None 24 3 2 8 USBDevEndpointStall Stalls the specified endpoint in device mode Prototype void USBDevEndpointStall unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint specifies the endpoint to stall ulFlags specifies whether to stall the IN or OUT endpoint Description This function will cause to endpoint number passed in to go into a stall condition If the u Flags parameter is USB_EP_DEV_IN then the stall will be issued on the IN portion of this endpoint If the ulFlags parameter is USB_EP_DEV_OUT then the stall will be issued on the OUT portion of this endpoint Note This function should only be called in device mode 362 January 11 2011 USB Controller Returns None 24 3 2 9 USBDevEndpointStallClear Clears the stall condition on the specified endpoint in device mode Prototype void USBDevEndpointStallClear unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags
245. e identifier filtering based on the extended identifier If the extended identifier filtering is used then ID filtering must also be enabled January 11 2011 5 2 3 29 5 2 4 5 2 4 1 5 2 4 2 5 2 4 3 Controller Area Network CAN MSG_OBJ_USE_ID_FILTER Definition define MSG_OBJ_USE_ID_FILTER Description This indicates that a message object will use or is using filtering based on the objects message identifier Enumeration Documentation tCANIntStsReg Description This data type is used to identify the interrupt status register This is used when calling the CANIntStatus function Enumerators CAN_INT_STS_CAUSE Read the CAN interrupt status information CAN_INT_STS_OBJECT Read a message object s interrupt status tCANStsReg Description This data type is used to identify which of several status registers to read when calling the CANStatusGet function Enumerators CAN_STS_CONTROL Read the full CAN controller status CAN_STS_TXREQUEST Read the full 32 bit mask of message objects with a transmit re quest set CAN_STS_NEWDAT Read the full 32 bit mask of message objects with new data available CAN_STS_MSGVAL Read the full 32 bit mask of message objects that are enabled tMsgObjType Description This definition is used to determine the type of message object that will be set up via a call to the CANMessageSet API Enumerators MSG_OBJ_TYPE_TX Transmit message object MSG_OBJ_
246. e is no more data in the FIFO or the maximum count is reached as specified in the parameter u Count The actual count of items will be returned Returns The number of items read from the FIFO EPINonBlockingReadStart Starts a non blocking read transaction Prototype void EPINonBlockingReadStart unsigned long ulBase unsigned long ulChannel unsigned long ulCount Parameters ulBase is the EPI module base address January 11 2011 99 External Peripheral Interface EP 7 2 2 23 7 2 2 24 100 ulChannel is the read channel 0 or 1 ulCount is the number of items to read 1 4095 Description This function starts a non blocking read that was previously configured with the function EPINonBlockingReadConfigure Once this function is called the EPI module will begin read ing data from the external device into the read FIFO The EPI will stop reading when the FIFO fills up and resume reading when the application drains the FIFO until the total specified count of data items has been read Once a read transaction is completed and the FIFO drained another transaction can be started from the next address by calling this function again Returns None EPINonBlockingReadStop Stops a non blocking read transaction Prototype void EPINonBlockingReadStop unsigned long ulBase unsigned long ulChannel Parameters ulBase is the EPI module base address ulChannel is the read channel 0 or 1 D
247. e not used in devices without OTG functionality January 11 2011 9 2 2 30 9 2 2 31 GPIO The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into a USB pin it only configures a USB pin for proper operation Returns None GPIOPinWrite Writes a value to the specified pin s Prototype void GPIOPinWrite unsigned long ulPort unsigned char ucPins unsigned char ucVal Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s ucVal is the value to write to the pin s Description Writes the corresponding bit values to the output pin s specified by ucPins Writing to a pin configured as an input pin has no effect The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Returns None GP1 OPortIntRegister Registers an interrupt handler for a GPIO port Prototype void GPIOPortIntRegister unsigned long ulPort void pfnIntHandler void Parameters ulPort is the base address of the GPIO port pfnintHandler is a pointer to the GPIO port interrupt handling function January 11 2011 131
248. e on chip pull ups The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into a timer pin it only configures a timer pin for proper operation Returns None 9 2 2 27 GPIOPinTypeUART Configures pin s for use by the UART peripheral Prototype void GPIOPinTypeUART unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The UART pins must be properly configured for the UART peripheral to function correctly This function provides a typical configuration for those pin s other configurations may work as well depending upon the board setup for example using the on chip pull ups The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into a UART pin it only configures a UART pin for proper operation January 11 2011 129 GPIO 9 2 2 28 9 2 2 29 130 Returns None GPIOPinTypeUSBAnalog Configures pin s for use by the USB peripheral Prototype void GPIOPinTypeUSBAnalog unsigned long ulPo
249. e reinitialized by calling the EthernetlnitExpClk function again After the controller has been reinitialized the controller should be reconfigured using the appropriate Ethernet API calls Returns None EthernetintClear Clears Ethernet interrupt sources Prototype void EthernetIntClear unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the base address of the controller ullntFlags is a bit mask of the interrupt sources to be cleared Description The specified Ethernet interrupt sources are cleared so that they no longer assert This must be done in the interrupt handler to keep it from being called again immediately upon exit The ullntFlags parameter has the same definition as the ullntFlags parameter to Ethernet IntEnable January 11 2011 73 Ethernet Controller 6 2 2 7 6 2 2 8 74 Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None EthernetintDisable Disables individual Et
250. e same time In count up down mode it will count up from zero to the preset value count back down to zero and then repeat the process This will produce center aligned PWM signals that is the middle of the high low period of the PWM signals produced by the generator will occur at the same time When the PWM generator parameters period and pulse width are modified their affect on the output PWM signals can be delayed In synchronous mode the parameter updates are not applied until a synchronization event occurs This allows multiple parameters to be modified and take affect simultaneously instead of one at a time Additionally parameters to multiple PWM generators in synchronous mode can be updated simultaneously allowing them to be treated as if they were a unified generator In non synchronous mode the parameter updates are not delayed until a synchronization event In either mode the parameter updates only occur when the counter is at zero to help prevent oddly formed PWM signals during the update that is a PWM pulse that is too short or too long The PWM generator can either pause or continue running when the processor is stopped via the debugger If configured to pause it will continue to count until it reaches zero at which point it will pause until the processor is restarted If configured to continue running it will keep counting as if nothing had happened The ulConfig parameter contains the desired configuration It is the
251. e secondary peripheral assignment for a set of UDMA chan nels By selecting the secondary peripheral assignment for a channel the default peripheral assignment is no longer available for that channel The parameter ulSecPeriphs can be the logical OR of any of the following macros If one of the macros below is in the list passed to this function then the secondary peripheral marked as _SEC_ will be selected UDMA_DEF_USBEP1RX_SEC_UART2RX UDMA_DEF_USBEP1TX_SEC_UART2TX UDMA_DEF_USBEP2RX_SEC_TMR3A UDMA_DEF_USBEP2TX_SEC_TMR3B UDMA_DEF_USBEP3RX_SEC_TMR2A UDMA_DEF_USBEP3TX_SEC_TMR2B UDMA_DEF_ETHORX_SEC_TMR2A UDMA_DEF_ETHOTX_SEC_TMR2B UDMA_DEF_UARTORX_SEC_UART1RX UDMA_DEF_UARTOTX_SEC_UART1TX UDMA_DEF_SSIORX_SEC_SSI1RX UDMA_DEF_SSIOTX_SEC_SSI1TX UDMA_DEF_RESERVED_SEC_UART2RX UDMA_DEF_RESERVED_SEC_UART2TX UDMA_DEF_ADC00O_SEC_TMR2A UDMA_DEF_ADCO1_SEC_TMR2B UDMA_DEF_ADC02_SEC_RESERVED UDMA_DEF_ADC03_SEC_RESERVED UDMA_DEF_TMROA_SEC_TMR1A UDMA_DEF_TMROB_SEC_TMR1B UDMA_DEF_TMR1A_SEC_EPIORX UDMA_DEF_TMR1B_SEC_EPIOTX UDMA_DEF_UART1RX_SEC_RESERVED UDMA_DEF_UART1TX_SEC_RESERVED UDMA_DEF_SSI1RX_SEC_ADC10 UDMA_DEF_SSI1TX_SEC_ADC11 UDMA_DEF_RESERVED_SEC_ADC12 UDMA_DEF_RESERVED_SEC_ADC13 UDMA_DEF_I2SORX_SEC_RESERVED UDMA_DEF_I2S0TX_SEC_RESERVED Returns None January 11 2011 343 uDMA Controller 23 2 3 13 UDMAChannelSizeGet Gets the current transfer size for
252. eSIR Enables SIR IrDA mode on the specified UART Prototype void UARTEnableSIR unsigned long ulBase tBoolean bLowPower Parameters ulBase is the base address of the UART port bLowPower indicates if SIR Low Power Mode is to be used Description Enables the SIREN control bit for IrDA mode on the UART If the bLowPower flag is set then SIRLP bit will also be set January 11 2011 315 UART Note SIR IrDA operation is not supported on Sandstorm class devices Returns None 22 2 2 16 UARTFIFODisable Disables the transmit and receive FIFOs Prototype void UARTFIFODisable unsigned long ulBase Parameters ulBase is the base address of the UART port Description This functions disables the transmit and receive FIFOs in the UART Returns None 22 2 2 17 UARTFIFOEnable Enables the transmit and receive FIFOs Prototype void UARTFIFOEnable unsigned long ulBase Parameters ulBase is the base address of the UART port Description This functions enables the transmit and receive FIFOs in the UART Returns None 22 2 2 18 UARTFIFOLevelGet Gets the FIFO level at which interrupts are generated Prototype void UARTFIFOLevelGet unsigned long ulBase unsigned long xpulTxLevel unsigned long xpulRxLevel 316 January 11 2011 UART Parameters ulBase is the base address of the UART port pulTxLevel is a pointer to storage for the transmit FIFO
253. ear unsigned long ulBase unsigned long ulIntClr Parameters ulBase is the base address of the CAN controller ullntCir is a value indicating which interrupt source to clear January 11 2011 55 Controller Area Network CAN 5 2 5 9 5 2 5 10 56 Description This function can be used to clear a specific interrupt source The ul ntCir parameter should be one of the following values CAN_INT_INTID_STATUS Clears a status interrupt m 1 32 Clears the specified message object interrupt It is not necessary to use this function to clear an interrupt This should only be used if the application wants to clear an interrupt source without taking the normal interrupt action Normally the status interrupt is cleared by reading the controller status using CANStatusGet A specific message object interrupt is normally cleared by reading the message object using CANMessageGet Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None
254. east once for this channel prior to calling this function The u ChannelStructindex parameter should be the logical OR of the channel number with one of UDMA_PRI_SELECT or UDMA_ALT_SELECT to choose whether the primary or alternate data structure is used The u Mode parameter should be one of the following values UDMA_MODE_STOP siops the uDMA transfer The controller sets the mode to this value at the end of a transfer January 11 2011 uDMA Controller UDMA_MODE BASIC to perform a basic transfer based on request UDMA_MODE_AUTO to perform a transfer that will always complete once started even if request is removed UDMA_MODE_PINGPONG io set up a transfer that switches between the primary and alternate control structures for the channel This allows use of ping pong buffering for uDMA transfers UDMA_MODE_MEM_SCATTER_GATHER to set up a memory scatter gather transfer UDMA_MODE_PER_SCATTER_GATHER to set up a peripheral scatter gather transfer The pvSrcAddr and pvDstAdadr parameters are pointers to the first location of the data to be transferred These addresses should be aligned according to the item size The compiler will take care of this if the pointers are pointing to storage of the appropriate data type The ulTransferSize parameter is the number of data items not the number of bytes The two scatter gather modes memory and peripheral are actually different depending on whether the primary or alternate control
255. ecifies the SSI module base address Description This function will clear the handler to be called when a SSI interrupt occurs This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for important information about registering interrupt handlers Returns None 18 3 Programming Example The following example shows how to use the SSI API to configure the SSI module as a master device and how to do a simple send of data char xpcChars SSI Master send data long lIdx Configure the SSI fi SSIConfigSetExpClk SSI_BASE SysCtlClockGet SSI_FRF_MOTO_MODEO SSI_MODE_MASTER 2000000 8 Enable the SSI module ff SSIEnable SSI_BASE 256 January 11 2011 January 11 2011 Send some data eh lIdx 0 while pcChars 1Idx if SSIDataPut SSI_BASE pcChars 1Idx lIdx Synchronous Serial Interface SS 257 Synchronous Serial Interface SSI 258 January 11 2011 System Control 19 System Control IEW E e EELEE TAEST A T AAA E dha amuse nmap hide PET A T AE ten de A AASE TTET 259 APIPUMCIONS soioseoi k iko nerea Eer aa AE 260 Programming Example eearri a A EE E ARA 283 19 1 Introduction System control determines the overall operation of the device It controls the clocking of the device the set of peripherals that are enabled configuration of the device and its resets
256. ect must have interrupts enabled see CANMessageSet CAN_INT_ERROR will generate an interrupt if the controller enters the bus off condition or if the error counters reach a limit CAN_INT_STATUS will generate an interrupt under quite a few status conditions and may provide more interrupts than the application needs to handle When an interrupt occurs use CANIntStatus to determine the cause Returns None 5 2 5 11 CANIntRegister Registers an interrupt handler for the CAN controller Prototype void CANIntRegister unsigned long ulBase void pfnHandler void Parameters ulBase is the base address of the CAN controller pfnHandler is a pointer to the function to be called when the enabled CAN interrupts occur Description January 11 2011 This function registers the interrupt handler in the interrupt vector table and enables CAN interrupts on the interrupt controller specific CAN interrupt sources must be enabled using CANIntEnable The interrupt handler being registered must clear the source of the interrupt using CANIntClear If the application is using a static interrupt vector table stored in flash then it is not necessary to register the interrupt handler this way Instead IntEnable should be used to enable CAN interrupts on the interrupt controller 57 Controller Area Network CAN See also IntRegister for important information about registering interrupt handlers Returns
257. ection is permanently applied to the device which is a non reversible operation An interrupt can also be generated when an erase or programming operation has completed Depending upon the member of the Stellaris family used the amount of available flash is 8 KB 16 KB 32 KB 64 KB 96 KB 128 KB or 256 KB This driver is contained in driverlib flash c with driverlib flash h containing the API definitions for use by applications API Functions Functions m long FlashErase unsigned long ulAddress m void FlashIntClear unsigned long ullntFlags m void FlashintDisable unsigned long ullntFlags January 11 2011 103 Flash 8 2 1 8 2 2 8 2 2 1 104 void FlashIntEnable unsigned long ullntFlags void FlashIntRegister void xpfnHandler void unsigned long FlashIntStatus tBoolean bMasked void FlashIntUnregister void long FlashProgram unsigned long pulData unsigned long ulAddress unsigned long ul Count tFlashProtection FlashProtectGet unsigned long ulAddress long FlashProtectSave void long FlashProtectSet unsigned long ulAddress tFlashProtection eProtect unsigned long FlashUsecGet void void FlashUsecSet unsigned long ulClocks long FlashUserGet unsigned long xpulUser0 unsigned long xpulUser1 long FlashUserSave void long FlashUserSet unsigned long ulUser0 unsigned long ulUser1 Detailed Description The flash API is broken into three groups of functions those that deal with programmi
258. ed See also IntRegister for important information about registering interrupt handlers Returns None January 11 2011 141 Hibernation Module 10 2 2 12 HibernatelsActive Checks to see if the Hibernation module is already powered up Prototype unsigned int HibernatelIsActive void Description This function queries the control register to determine if the module is already active This function can be called at a power on reset to help determine if the reset is due to a wake from hibernation or a cold start If the Hibernation module is already active then it does not need to be re enabled and its status can be queried immediately The software application should also use the HibernatelntStatus function to read the raw interrupt status to determine the cause of the wake The HibernateDataGet function can be used to restore state These combinations of functions can be used by the software to determine if the processor is waking from hibernation and the appropriate action to take as a result Returns Returns true if the module is already active and false if not 10 2 2 13 HibernateLowBatGet Gets the currently configured low battery detection behavior Prototype unsigned long HibernateLowBatGet void Description Returns a value representing the currently configured low battery detection behavior The return value will be one of the following HIBERNATE_LOW_BAT_DETECT detect a low battery conditi
259. ed by SysCtISRAMSizeGet SysCtlFlashSizeGet SysCtlPeripheralPresent and SysCtlPinPresent Clocking of the device is configured with SysCtlClockSet and SysCtIPWMClockSei Information about device clocking is provided by SysCtlClockGet and SysCtlIPWMClockGet Peripheral enabling and reset are controlled with SysCtlPeripheralReset SysCtlPeripheralEn able SysCtlPeripheralDisable SysCtlPeripheralSleepEnable SysCtlPeripheralSleepDisable SysCtlPeripheralDeepSleepEnable SysCtlPeripheralDeepSleepDisable and SysCtlPeripheral ClockGating The system control interrupt is managed with SysCtllntRegister SysCtllntUnregister SysCtlln tEnable SysCtllntDisable SysCtlIntClear SysCtlIntStatus The LDO is controlled with SysCtIlLDOSet and SysCtILDOConfigSet Its status is provided by SysCtlLDOGet The device is put into sleep modes with SysCtlSleep and SysCtIDeepSleep The reset reason is managed with SysCtlResetCauseGet and SysCtIResetCauseClear A soft ware reset is performed with SysCtlReset January 11 2011 261 System Control 19 2 2 19 2 2 1 19 2 2 2 19 2 2 3 262 The brown out reset is configured with SysCtlIBrownOutConfigSet The clock verification timers are managed with SysCtllOSCVerificationSet SysCtIMOSCVerifica tionSet SysCtIPLLVerificationSet and SysCtIClkVerificationClear Function Documentation SysCtlIADCSpeedGet Gets the sample r
260. ed long ulIntFlags Parameters ulBase is the base address of the UART port ullntFlags is the bit mask of the interrupt sources to be disabled Description Disables the indicated UART interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor The ullntFlags parameter has the same definition as the ullntFlags parameter to UARTIntEn able Returns None 22 2 2 24 UARTIntEnable Enables individual UART interrupt sources Prototype void UARTIntEnable unsigned long ulBase unsigned long ulIntFlags January 11 2011 319 UART Parameters ulBase is the base address of the UART port ullntFlags is the bit mask of the interrupt sources to be enabled Description Enables the indicated UART interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor The ul ntFlags parameter is the logical OR of any of the following m UART_INT_OE Overrun Error interrupt m UART_INT_BE Break Error interrupt UART_INT_PE Parity Error interrupt m UART_INT_FE Framing Error interrupt m UART_INT_RT Receive Timeout interrupt m UART_INT_TX Transmit interrupt m UART_INT_RX Receive interrupt UART_INT_DSR DSR interrupt UART_INT_DCD DCD interrupt m UART_INT_CTS CTS interrupt UART_INT_RI RI interrupt Returns None 22 2 2
261. ed long ulObjID tCANMsgObject pMsgObject tBoolean bClrPendingInt void CANMessageSet unsigned long ulBase unsigned long ulObjID tCANMsgObject pMsg Object tMsgObjType eMsgType tBoolean CANRetryGet unsigned long ulBase m void CANReirySet unsigned long ulBase tBoolean bAutoRetry unsigned long CANSitatusGet unsigned long ulBase tCANStsReg eStatusReg 5 2 1 Detailed Description The CAN APIs provide all of the functions needed by the application to implement an interrupt driven CAN stack These functions may be used to control any of the available CAN ports on a Stellaris microcontroller and can be used with one port without causing conflicts with the other port The CAN module is disabled by default so the the CANInit function must be called before any other CAN functions are called This call initializes the message objects to a safe state prior to enabling the controller on the CAN bus Also the bit timing values must be programmed prior to enabling the CAN controller The CANSetBitTiming function should be called with the appropriate bit timing values for the CAN bus Once these two functions have been called a CAN controller can be enabled using the CANEnable and later disabled using CANDisable if needed Calling CANDisable does not reinitialize a CAN controller so it can be used to temporarily remove a CAN controller from the bus The CAN controller is highly configurable and contains 32 message objects that c
262. ed long ulStep unsigned long ulConfig long ADCSequenceUnderflow unsigned long ulBase unsigned long ulSequenceNum void ADCSequenceUnderflowClear unsigned long ulBase unsigned long ulSequenceNum void ADCSoftwareOversampleConfigure unsigned long ulBase unsigned long ulSequen ceNum unsigned long ulFactor void ADCSoftwareOversampleDataGet unsigned long ulBase unsigned long ulSequen ceNum unsigned long pulBuffer unsigned long ulCount void ADCSofitwareOversampleStepConfigure unsigned long ulBase unsigned long ulSe quenceNun unsigned long ulStep unsigned long ulConfig January 11 2011 4 2 1 4 2 2 4 2 2 1 Analog to Digital Converter ADC Detailed Description The analog to digital converter API is broken into three groups of functions those that deal with the sample sequences those that deal with the processor trigger and those that deal with interrupt handling The sample sequences are configured with ADCSequenceConfigure and ADCSequenceStep Configure They are enabled and disabled with ADCSequenceEnable and ADCSequenceDis able The captured data is obtained with ADCSequenceDataGet Sample sequence FIFO over flow and underflow is managed with ADCSequenceOverflow ADCSequenceOverflowClear AD CSequenceUnderflow and ADCSequenceUnderflowClear Hardware oversampling of the ADC is controlled with ADCHardwareOversampleConfigure Soft ware oversampling of the ADC is controlled with A
263. ed to reflect to the processor can be returned Returns Returns the current interrupt status enumerated as a bit field of QEILINTERROR QEI_INTDIR QEI_INTTIMER and QEI_INTINDEX QElIntUnregister Unregisters an interrupt handler for the quadrature encoder interrupt Prototype void QETIntUnregister unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This function will clear the handler to be called when a quadrature encoder interrupt occurs This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for important information about registering interrupt handlers Returns None 17 2 2 12 QEIPositionGet Gets the current encoder position Prototype unsigned long QEIPositionGet unsigned long ulBase January 11 2011 243 Quadrature Encoder QE Parameters ulBase is the base address of the quadrature encoder module Description This returns the current position of the encoder Depending upon the configuration of the encoder and the incident of an index pulse this value may or may not contain the expected data that is if in reset on index mode if an index pulse has not been encountered the position counter will not be aligned with the index pulse yet Returns The current position of the encoder 17 2 2 13 QEIPositionSet Sets the current encoder p
264. eds to change Example for PWMO pin configuration using PinTypePWM fi Configure the pin for use as a PWM pin PinTypePWM PWMO Example for PWMO pin configuration using GPIOPinTypePWM ifdef LM3S2110 Configure the pin for use as a PWM pin GPIOPinTypePWM GPIO_PORTF_BASE GPIO_PIN_0O fendif ifdef LM3S2620 Configure the pin for use as a PWM pin GPIOPinTypeTimer GPIO_PORTG_BASE GPIO_PIN_O fendif January 11 2011 213 Peripheral Pin Mapping 214 January 11 2011 Pulse Width Modulator PWM 16 Pulse Width Modulator PWM IEC E TEETETTIIN 215 APIPUMCIONS chccccc ida diveneranieineheal welt eeseiaenddauclSeuleadadin sie euer wesadaaee eeesewees 215 Programming ERIN DIE ccc sonnreaeceiapisen ed camcagemeeertGagenecEsepesarsouquanerseebedeqaeeumatdar 236 16 1 Introduction Each instance of a Stellaris PWM module provides three instances of a PWM generator block and an output control block Each generator block has two PWM output signals which can be operated independently or as a pair of signals with dead band delays inserted Each generator block also has an interrupt output and a trigger output The control block determines the polarity of the PWM signals and which signals are passed through to the pins Some of the features of the Stellaris PWM module are m Three generator blocks each containing e One 16 bit down or up down counter e Two comparators e PWM generator
265. egrated Circuit 12C 11 1 2 11 2 154 errors then the data has been sent or is ready to be read using l2CMasterDataGet For the burst send and receive cases the polling method also involves calling the 12CMasterControl function for each byte transmitted or received using either the I2C_MASTER_CMD_BURST_SEND_CONT or I2C_MASTER_CMD_BURST_RECEIVE_ CONT commands and for the last byte sent or received using either the I2C_MASTER_CMD_BURST_SEND FINISH or I2C_MASTER_CMD_BURST_RECEIVE FINISH commands If any error is detected during the burst transfer the I2CMasterControl function should be called using the appropriate stop command I2C_MASTER_CMD_BURST_SEND_ERROR_STOP or I2C_MASTER_CMD_BURST_RECEIVE_ERROR_STOP For the interrupt driven transaction the user must register an interrupt handler for the 12C devices and enable the I2C master interrupt the interrupt will occur when the master is no longer busy Slave Operations When using this API to drive the I2C slave module the user must first initialize the 12C slave module with a call to 12CSlavelnit This will enable the 12C slave module and initialize the slave s own ad dress After the initialization is complete the user may poll the slave status using 12CSlaveStatus to determine if a master requested a send or receive operation Depending on the type of operation requested the user can call 12CSlaveDataPut or 2CSlaveDataGet to complete the transac tion Alterna
266. egrated Circuit I2C Description The specified 12C Slave interrupt sources are cleared so that they no longer assert This must be done in the interrupt handler to keep it from being called again immediately upon exit The ullntFlags parameter has the same definition as the ullntFlags parameter to I2CSlavelntEnableEx Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None 11 2 2 24 2CSlavelntDisable Disables the 12C Slave interrupt Prototype void I2CSlaveIntDisable unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description Disables the 12C Slave interrupt source Returns None 11 2 2 25 2CSlavelntDisableEx Disables individual 12C Slave interrupt sources Prototype void I2CSlaveIntDisableEx unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the base address of the I2C Slave module ullntFlags is the bit mask of the interrupt sources to be d
267. el2C unsigned long ulName Parameters ulName is one of the valid names for the 12C pins Description This function takes one of the valid names for an 12C pin and configures the pin for its 12C functionality depending on the part that is defined The valid names for the pins are as follows IZCOSCL IZCOSDA I2C1SCL or 12C1SDA See also GPIOPinTypel2C in order to configure multiple 12C pins at once Returns None PinTypePWM Configures the specified PWM pin to function as a PWM pin Prototype void PinTypePWM unsigned long ulName Parameters ulName is one of the valid names for the PWM pins Description This function takes one of the valid names for a PWM pin and configures the pin for its PWM functionality depending on the part that is defined The valid names for the pins are as follows PWMO PWM1 PWM2 PWM3 PWM4 PWM5 or FAULT See also GPIOPinTypePWM in order to configure multiple PWM pins at once Returns None January 11 2011 15 2 2 7 15 2 2 8 15 2 2 9 Peripheral Pin Mapping PinTypeQEI Configures the specified QEI pin to function as a QEI pin Prototype void PinTypeQEI unsigned long ulName Parameters ulName is one of the valid names for the QEI pins Description This function takes one of the valid names for a QEI pin and configures the pin for its QEI functionality depending on the part that is defined The valid names for the pins are as follows
268. elect the default or secondary channel mapping use the functions UDMAChannelSe lectDefault or UDMAChannelSelectSecondary Each channel can be configured individually to use the default or secondary mapping This provides a lot of flexibility for channel mapping For example the default for channel 0 is USBEP1RX However this channel also has a secondary mapping to UART2Rx If an application requires use of UDMA with UART2 and does not use USB then this channel could be remapped to UART2RX with the following function call uDMAChannelSelectSecondary UDMA_DEF_USBEP1RX_SEC_UART2RxX For channels that have been configured to use the secondary mapping there is a set of macros to use for specifying the channel Here is the list of channels when secondary mapping is used As before this is the full list the actual channels available depend on which specific Stellaris part is used UDMA_SEC_CHANNEL_UART2RX_0 for UART2 receive using UDMA channel 0 UDMA_SEC_CHANNEL_UART2TX_1 for UART2 transmit using UDMA channel 1 UDMA_SEC_CHANNEL_TMR3A for Timer 3A UDMA_SEC_CHANNEL_TMR3B for Timer 3B UDMA_SEC_CHANNEL_TMR2A_4 for Timer 2A using UDMA channel 4 UDMA_SEC_CHANNEL_TMR2B_5 for Timer 2B using UDMA channel 5 UDMA_SEC_CHANNEL_TMR2A_6 for Timer 2A using UDMA channel 6 UDMA_SEC_CHANNEL_TMR2B _7 for Timer 2B using UDMA channel 7 UDMA_SEC_CHANNEL_UART1RX for UART1 receive UDMA_SEC_CHANNEL_UART1TX for UART1 transmit UDMA_SEC_CH
269. epSleepEnable unsigned long ulPeripheral 273 System Control Parameters ulPeripheral is the peripheral to enable in deep sleep mode Description This function allows a peripheral to continue operating when the processor goes into deep sleep mode Since the clocking configuration of the device may change not all peripherals can safely continue operating while the processor is in sleep mode Those that must run at a particular frequency such as a UART will not work as expected if the clock changes It is the responsibility of the caller to make sensible choices Deep sleep mode clocking of peripherals must be enabled via SysCtlPeripheralClockGating if disabled the peripheral deep sleep mode configuration is maintained but has no effect when deep sleep mode is entered The ulPeripheral parameter must be only one of the following values SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CANO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2CO SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_PWM SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI1 SYSCTL_PERI
270. er of bits per word that are transferred on the data line m 12S CONFIG_EMPTY_ZERO or I2S_CONFIG_EMPTY_REPEAT to select whether the module transmits zeroes or repeats the last sample when the FIFO is empty Returns None 12 2 2 25 l2STxRxDisable Disables the 12S transmit and receive modules Prototype void I2STxRxDisable unsigned long ulBase Parameters ulBase is the 2S module base address Description This function simultaneously disables the transmit and receive modules When the module is disabled no data or clocks will be generated on the I2S signals Returns None 12 2 2 26 I2STxRxEnable Enables the I2S transmit and receive modules for operation Prototype void I2STxRxEnable unsigned long ulBase Parameters ulBase is the 2S module base address January 11 2011 183 Inter IC Sound 12S 12 3 184 Description This function simultaneously enables the transmit and receive modules for operation providing a synchronized SCLK and LRCLK The module should be enabled after configuration When the module is disabled no data or clocks will be generated on the I2S signals Returns None Programming Example The following example sets up the 12S transmit module to transmit data using an interrupt handler This example assumes that the interrupt handler was allocated statically in the vector table Enable the I2S peripheral SysCtlPeripheralEnable SYSCTL_PERIPH_I2S0
271. ere on the next clock after the SysTick is enabled Returns None 20 2 2 9 SysTickValueGet Gets the current value of the SysTick counter Prototype unsigned long SysTickValueGet void 288 January 11 2011 System Tick SysTick Description This function returns the current value of the SysTick counter this will be a value between the period 1 and zero inclusive Returns Returns the current value of the SysTick counter 20 3 Programming Example The following example shows how to use the SysTick API to configure the SysTick counter and read its value unsigned long ulValue Configure and enable the SysTick counter SysTickPeriodSet 1000 SysTickEnable Lt Delay for some time Read the current SysTick value ulValue SysTickValueGet January 11 2011 289 System Tick SysTick 290 January 11 2011 21 21 1 21 2 Timer Timer OUT anea a a a ba dnne eid bebe beree demons meas 291 APUPUS aiia E es tease came a ei ecient oes 291 Programming RENN DIS ccc sonnpenaeaein pis enedscemeegemeears OeGeanecke Coogee seugusnereeabedeaieeneaeaas 304 Introduction The timer API provides a set of functions for dealing with the timer module Functions are pro vided to configure and control the timer along with functions to modify timer counter values and to manage interrupt handling for the timer The timer module provides two 16 bit timer counter
272. eriph eralEnable the peripheral will automatically resume operation when the processor leaves deep sleep mode maintaining its entire state from before deep sleep mode was entered Deep sleep mode clocking of peripherals must be enabled via SysCtlPeripheralClockGating if disabled the peripheral deep sleep mode configuration is maintained but has no effect when deep sleep mode is entered The ulPeripheral parameter must be only one of the following values SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CANO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2CO SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_PWM SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_TEMP SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO or SYSCTL_PERIPH_WDOG1 Returns None 19 2 2 26 SysCtlPeripheralDeepSleepEnable Enables a peripheral in deep sleep mode Prototype January 11 2011 void SysCt1lPeripheralDe
273. errupt vector as any other USB interrupt the application must perform an extra check to determine what was the actual source of the interrupt It is important to note that this DMA interrupt does not mean that the USB transfer is complete but that the data has been transferred to the USB controller s FIFO There will also be an interrupt indicating that the USB transfer is complete However both events need to be handled in the same interrupt routine This because if other code in the system holds off the USB interrupt routine both the uDMA complete and transfer complete can occur before the USB interrupt handler is called The USB has no status bit indicating that the interrupt was due to a DMA complete which means that the application must remember if a DMA transaction was in progress The example below shows the g_ulFlags global variable being used to remember that a DMA transfer was pending Example Interrupt handling with UDMA if g_ulFlags amp EP1_DMA_IN_PEND amp amp DMAChannelModeGet DMA_CHANNEL_USBEP1TX DMA _MODE_STOP Handle the DMA complete case Get the interrupt status if ulStatus USBIntStatusEndpoint USBO_BASE if ulStatus amp USB_INTEP_DEV_IN_1 Handler the transfer complete case To use the USB device controller with an OUT endpoint the application must use a receive UDMA channel When calling USBDevEndpointConfigSet for an endpoint that uses UDMA the app
274. escription This flag is used to allow a CAN controller to generate status interrupts CAN_STATUS_BUS_OFF Definition define CAN_STATUS_BUS_OFF Description CAN controller has entered a Bus Off state CAN_STATUS_EPASS Definition define CAN_STATUS_EPASS Description CAN controller error level has reached error passive level January 11 2011 5 2 3 6 5 2 3 7 5 2 3 8 5 2 3 9 5 2 3 10 5 2 3 11 CAN_STATUS_EWARN Definition define CAN_STATUS_EWARN Description CAN controller error level has reached warning level CAN_STATUS_LEC_ACK Definition define CAN_STATUS_LEC_ACK Description An acknowledge error has occurred CAN_STATUS_LEC_BITO Definition define CAN_STATUS_LEC_BITO Description The bus remained a bit level of 0 for longer than is allowed CAN_STATUS_LEC_BIT1 Definition define CAN _STATUS_LEC_BIT1 Description The bus remained a bit level of 1 for longer than is allowed CAN_STATUS_LEC_CRC Definition define CAN_STATUS_LEC_CRC Description A CRC error has occurred CAN_STATUS_LEC_FORM Definition define CAN _STATUS_LEC_FORM Description A formatting error has occurred January 11 2011 Controller Area Network CAN 47 Controller Area Network CAN 5 2 3 12 5 2 3 13 5 2 3 14 9 2 3 15 5 2 3 16 5 2 3 17 48 CAN_STATUS_LEC_MASK Definition define CAN_STATUS_LEC_ MASK Description Thi
275. escription This function cancels a non blocking read transaction that is already in progress Returns None EPIWriteFlFOCountGet Reads the number of empty slots in the write transaction FIFO Prototype unsigned long EPIWriteFIFOCountGet unsigned long ulBase Parameters ulBase is the EPI module base address Description This function returns the number of slots available in the transaction FIFO It can be used in a polling method to avoid attempting a write that would stall Returns The number of empty slots in the transaction FIFO January 11 2011 External Peripheral Interface EPI 7 3 Programming Example TODO need to add programming example January 11 2011 101 External Peripheral Interface EP 102 January 11 2011 8 8 1 8 2 Flash Flash al rere ME Te 3 eR E E taba EEES T EE S S E E E EE OEA aw bones T EA E ES A EET 103 APURO HONS saae naaa de ada E EE EO 103 Programing Example e ecoin denrea Eia a a ak e aaea 111 Introduction The flash API provides a set of functions for dealing with the on chip flash Functions are provided to program and erase the flash configure the flash protection and handle the flash interrupt The flash is organized as a set of 1 kB blocks that can be individually erased Erasing a block causes the entire contents of the block to be reset to all ones These blocks are paired into a set of 2 kB blocks that can be individually protected The blocks
276. escription This function returns the number of clocks per micro second as presently known by the flash controller Returns Returns the number of processor clocks per micro second FlashUsecSet Sets the number of processor clocks per micro second Prototype void FlashUsecSet unsigned long ulClocks Parameters ulClocks is the number of processor clocks per micro second Description This function is used to tell the flash controller the number of processor clocks per micro second This value must be programmed correctly or the flash most likely will not program correctly it has no affect on reading flash Returns None January 11 2011 109 Flash 8 2 2 14 8 2 2 15 8 2 2 16 FlashUserGet Gets the user registers Prototype long FlashUserGet unsigned long pulUser0 unsigned long xpulUserl1 Parameters pulUser9 is a pointer to the location to store USER Register 0 pulUser7 is a pointer to the location to store USER Register 1 Description This function will read the contents of user registers 0 and 1 and store them in the specified locations Returns Returns 0 on success or 1 if a hardware error is encountered FlashUserSave Saves the user registers Prototype long FlashUserSave void Description This function will make the currently programmed user register settings permanent This is a non reversible operation a chip reset or power cycle will not change this sett
277. ese interrupts can be individually enabled or disabled and the sources must be cleared by the interrupt handler when they occur This driver is contained in driverlib sysctl c with driverlib sysct1 h containing the API definitions for use by applications API Functions Functions m unsigned long SysCtIADCSpeedGet void m void SysCtIADCSpeedSet unsigned long ulSpeed m void SysCtlIBrownOutConfigSet unsigned long ulConfig unsigned long ulDelay m void SysCtlClkVerificationClear void m unsigned long SysCtlClockGet void m void SysCtlClockSet unsigned long ulConfig m void SysCtIDeepSleep void m void SysCtlDelay unsigned long ulCount m unsigned long SysCtIFlashSizeGet void m void SysCtIGPIOAHBDisable unsigned long ulGPIOPeripheral m void SysCtIGPIOAHBEnable unsigned long ulGPIOPeripheral m unsigned long SysCtll2SMClkSet unsigned long ullnputClock unsigned long ulMClk m void SysCtllntClear unsigned long ullnts m void SysCtllntDisable unsigned long ullnts m void SysCtllntEnable unsigned long ullnts m void SysCtllntRegister void pfnHandler void m unsigned long SysCtllntStatus tBoolean bMasked m void SysCtllntUnregister void m void SysCtllIOSCVerificationSet Boolean bEnable m void SysCtlLDOConfigSet unsigned long ulConfig m unsigned long SysCtILDOGet void m void SysCtILDOSet unsigned long ulVoltage January 11 2011 System Control void SysCtIMOSCVerificationSet tBoolean bEnabl
278. eters ulBase specifies the SSI module base address pfnHandler is a pointer to the function to be called when the synchronous serial interface interrupt occurs Description This sets the handler to be called when an SSI interrupt occurs This will enable the global interrupt in the interrupt controller specific SSI interrupts must be enabled via SSllntEnable If necessary it is the interrupt handler s responsibility to clear the interrupt source via SSllnt Clear See also IntRegister for important information about registering interrupt handlers Returns None 18 2 2 15 SSlintStatus Gets the current interrupt status Prototype unsigned long SSIIntStatus unsigned long ulBase tBoolean bMasked January 11 2011 255 Synchronous Serial Interface SSI Parameters ulBase specifies the SSI module base address bMasked is false if the raw interrupt status is required or true if the masked interrupt status is required Description This function returns the interrupt status for the SSI module Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned Returns The current interrupt status enumerated as a bit field of SSI_TXFF SSI_RXFF SSI_RXTO and SSI_RXOR 18 2 2 16 SSllntUnregister Unregisters an interrupt handler for the synchronous serial interface Prototype void SSIIntUnregister unsigned long ulBase Parameters ulBase sp
279. evious call to UARTCharGet or UARTCharGetNonBlocking with the exception that the overrun error is set immediately the overrun occurs rather than when a character is next read Returns Returns a logical OR combination of the receiver error flags UART_RXERROR_FRAMING UART_RXERROR_PARITY UART_RXERROR_BREAK and UART_RXERROR_OVERRUN 22 2 2 36 UARTSmartCardDisable Disables ISO 7816 smart card mode on the specified UART Prototype void UARTSmartCardDisable unsigned long ulBase Parameters ulBase is the base address of the UART port Description Clears the SMART ISO 7816 smart card bits in the UART control register Note The availability of ISO 7816 smart card mode varies with the Stellaris part and UART in use Please consult the datasheet for the part you are using to determine whether this support is available Returns None 22 2 2 37 UARTSmartCardEnable Enables ISO 7816 smart card mode on the specified UART Prototype void UARTSmartCardEnable unsigned long ulBase January 11 2011 325 UART Parameters ulBase is the base address of the UART port Description Enables the SMART control bit for ISO 7816 smart card mode on the UART This call also sets 8 bit word length and even parity as required by ISO 7816 Note The availability of ISO 7816 smart card mode varies with the Stellaris part and UART in use Please consult the datasheet for the part you are using to determine whether this su
280. extended PWM fault handling affected outputs will be driven low on a fault condition Returns None 16 2 2 27 PWMOutputFaultLevel Specifies the level of PWM outputs suppressed in response to a fault condition Prototype void PWMOutputFaultLevel unsigned long ulBase unsigned long ulPWMOutBits tBoolean bDriveHigh Parameters ulBase is the base address of the PWM module 232 January 11 2011 Pulse Width Modulator PWM ulPWMOutBits are the PWM outputs to be modified Must be the logical OR of any of PWM_OUT_0 BIT PWM_OUT_1_BIT PWM_OUT_2_ BIT PWM_OUT_3 BIT PWM_OUT_4 BIT PWM_OUT_5_ BIT PWM_OUT_6_BIT or PWM_OUT_7_BIT bDriveHigh determines if the signal is driven high or low during an active fault condition Description This function determines whether a PWM output pin that is suppressed in response to a fault condition will be driven high or low The affected outputs are selected using the parameter ulPWMOutBits The parameter bDriveHigh determines the output level for the pins identified by ulPWMOutBits f bDriveHigh is true then the selected outputs will be driven high when a fault is detected If it is false the pins will be driven low In a fault condition pins which have not been configured to be suppressed via a call to PW MOuitputFault are unaffected by this function Note This function is available only on devices which support extended PWM fault handling Returns None 16 2 2 28
281. f the DMA transaction and likely USB_EP_AUTO_SET to allow the data to be January 11 2011 351 USB Controller 352 transmitted automatically once a packet is ready USB_EP_DMA_MODE_0 will generate an inter rupt whenever there is more space available in the FIFO This allows the application code to perform operations between each packet USB_EP_DMA_MODE_1 will only interrupt when the DMA trans fer complete or there is some type of error condition This can be used for larger transmissions that require no interaction between packets USB_EP_AUTO_SET should normally be specified when using UDMA to prevent the need for application code to start the actual transfer of data Example Endpoint configuration for a device IN endpoint Endpoint 1 is a device mode BULK IN endpoint using DMA USBDevEndpointConfigSet USBO_BASE USB_EP_1 64 USB_EP_MODE_BULK USB_EP_DEV_IN USB_EP_DMA_MODE_0 USB_EP_AUTO_SET The application must provide the configuration of the actual UDMA controller First to clear out any previous settings the application should call DMAChannelAttributeClear Then the application should call DMAChannelAttributeSet for the UDMA channel that corresponds to the endpoint and specify the DMA_CONFIG_USEBURST flag Note All uDMA transfers used by the USB controller must enable burst mode The application needs to indicate the size of each DMA transactions combined with the source and destination increme
282. f the comparator to configure ulConfig is the configuration of the comparator Description This function configures a comparator The u Config parameter is the result of a logical OR operation between the COMP_TRIG_xxx COMP_INT_xxx COMP_ASRCP_xxx and COMP_OUTPUT_xxx values The COMP_TRIG_xxx term can take on the following values COMP_TRIG_NONE to have no trigger to the ADC COMP_TRIG_HIGH to trigger the ADC when the comparator output is high COMP_TRIG_LOW to trigger the ADC when the comparator output is low COMP_TRIG_FALL to trigger the ADC when the comparator output goes low COMP_TRIG_RISE to trigger the ADC when the comparator output goes high COMP_TRIG_BOTH to trigger the ADC when the comparator output goes low or high The COMP_INT_xxx term can take on the following values COMP_INT_HIGH to generate an interrupt when the comparator output is high COMP_INT_LOW to generate an interrupt when the comparator output is low COMP_INT_FALL to generate an interrupt when the comparator output goes low COMP_INT_RISE to generate an interrupt when the comparator output goes high COMP_INT_BOTH to generate an interrupt when the comparator output goes low or high The COMP_ASRCP_xxx term can take on the following values COMP_ASRCP PIN to use the dedicated Comp pin as the reference voltage COMP_ASRCP_PINO to use the Comp0 pin as the reference voltage this the same as COMP_ASRCP_PIN for the comparato
283. functional address for the controller to use for this endpoint ulFlags determines if this is an IN or an OUT endpoint Description This function will set the functional address for a device that is using this endpoint for commu nication This u Addr parameter is the address of the target device that this endpoint will be used to communicate with The u Flags parameter indicates if the IN or OUT endpoint should be set Note This function should only be called in host mode Returns None 24 3 2 28 USBHostEndpointConfig Sets the base configuration for a host endpoint Prototype void USBHostEndpointConfig unsigned long ulBase unsigned long ulEndpoint unsigned long ulMaxPayload unsigned long ulNAKPollInterval unsigned long ulTargetEndpoint unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulMaxPayload is the maximum payload for this endpoint ulNAKPollinterval is the either the NAK timeout limit or the polling interval depending on the type of endpoint ulTargetEndpoint is the endpoint that the host endpoint is targeting ulFlags are used to configure other endpoint settings January 11 2011 373 USB Controller Description This function will set the basic configuration for the transmit or receive portion of an endpoint in host mode The ulFlags parameter determines some of the configuration while the other
284. gets the number of items that are available to read in the read FIFO The read FIFO is filled by a non blocking read transaction which is configured by the functions EPINon BlockingReadConfigure and EPINonBlockingReadStart Returns The number of items available to read in the read FIFO EPINonBlockingReadConfigure Configures a non blocking read transaction Prototype void EPINonBlockingReadConfigure unsigned long ulBase unsigned long ulChannel u u unsigned long ulDataSize unsigned long ulAddress Parameters ulBase is the EPI module base address ulChannel is the read channel 0 or 1 ulDataSize is the size of the data items to read ulAddress is the starting address to read Description This function is used to configure a non blocking read channel for a transaction Two chan nels are available which can be used in a ping pong method for continuous reading It is not necessary to use both channels to perform a non blocking read The parameter u DataSize is one of EPLNBCONFIG_SIZE_8 EPI NBCONFIG_SIZE_16 or EPI_NBCONFIG_SIZE_32 for 8 bit 16 bit or 32 bit sized data transfers The parameter ul Address is the starting address for the read relative to the external device The start of the device is address 0 Once configured the non blocking read is started by calling EPINonBlockingReadStart If the addresses to be read from the device are in a sequence it is not necessary to call this fu
285. ght sample alternate with each write to the FIFO left sample first If the transmit mode is 125 MODE_COMPACT_STEREO_16 or 12S MODE_COMPACT_STEREO_8 then the ulData parameter contains both the left and right samples If the transmit mode is I2S_ MODE_SINGLE_MONO then the u Data parameter contains the single channel sample For the compact modes both the left and right samples are written at the same time If 16 bit compact mode is used then the least significant 16 bits contain the left sample and the most significant 16 bits contain the right sample If 8 bit compact mode is used then the lower 8 bits contain the left sample and the next 8 bits contain the right sample with the upper 16 bits unused If there is no room in the transmit FIFO then this function will wait in a polling loop until the data can be written Returns None January 11 2011 179 Inter IC Sound 12S 12 2 2 18 l2STxDataPutNonBlocking Writes data samples to the 12S transmit FIFO without blocking Prototype long I2STxDataPutNonBlocking unsigned long ulBase unsigned long ulData Parameters ulBase is the 2S module base address ulData is the single or dual channel 12S data Description This function writes a single channel sample or combined left right samples to the 12S transmit FIFO The format of the sample is determined by the configuration that was used with the function I2STxConfigSet If the transmit mode is 12S MODE_D
286. gister This function can be used to get the current value of the trim register prior to making an adjustment by using the HibernateRTCTrimSet function Returns None 10 2 2 25 HibernateRTCTrimSet Sets the value of the RTC predivider trim register Prototype void HibernateRTCTrimSet unsigned long ulTrim Parameters ulTrim is the new value for the pre divider trim register 146 January 11 2011 Hibernation Module Description Sets the value of the pre divider trim register The input time source is divided by the pre divider to achieve a one second clock rate Once every 64 seconds the value of the pre divider trim register is applied to the predivider to allow fine tuning of the RTC rate in order to make corrections to the rate The software application can make adjustments to the predivider trim register to account for variations in the accuracy of the input time source The nominal value is Ox7FFF and it can be adjusted up or down in order to fine tune the RTC rate Returns None 10 2 2 26 HibernateWakeGet Gets the currently configured wake conditions for the Hibernation module Prototype unsigned long HibernateWakeGet void Description Returns the flags representing the wake configuration for the Hibernation module The return value will be a combination of the following flags a HIBERNATE_WAKE PIN wake when the external wake pin is asserted a HIBERNATE_WAKE_RTC wake when one of the RTC matches
287. gnal has been enabled the watchdog timer asserts its reset signal to the system If the interrupt is cleared before the 32 bit counter reaches its second timeout the 32 bit counter is loaded with the value in the load register and counting resumes from that value If the load register is written with a new value while the watchdog timer counter is counting then the counter is loaded with the new value and continues counting This driver is contained in driverlib watchdog c with driverlib watchdog h containing the API definitions for use by applications API Functions Functions void WatchdogEnable unsigned long ulBase void Watchdog ntClear unsigned long ulBase void WatchdogIntEnable unsigned long ulBase void WatchdogIntRegister unsigned long ulBase void xpfnHandler void unsigned long WatchdogIntStatus unsigned long ulBase tBoolean bMasked void WatchdogIntUnregister unsigned long ulBase void WatchdogLock unsigned long ulBase tBoolean WatchdogLockState unsigned long ulBase unsigned long WatchdogReloadGet unsigned long ulBase void WatchdogReloadSet unsigned long ulBase unsigned long ulLoadVal void WatchdogResetDisable unsigned long ulBase January 11 2011 393 Watchdog Timer 25 2 1 25 2 2 25 2 2 1 25 2 2 2 394 m void WatchdogResetEnable unsigned long ulBase m tBoolean WatchdogRunning unsigned long ulBase m void WatchdogStallDisable unsigned long ulBase a void WatchdogStallEnable
288. gned long SysCt1lPWMClockGet void Description This function returns the current PWM clock configuration Returns Returns the current PWM clock configuration will be one of SYSCTL_PWMDIV_1 SYSCTL_PWMDIV_2 SYSCTL_PWMDIV_4 SYSCTL_PWMDIV_8 SYSCTL_PWMDIV_16 SYSCTL_PWMDIV_32 or SYSCTL_PWMDIV_64 19 2 2 36 SysCtIPWMClockSet Sets the PWM clock configuration Prototype void SysCt1lPWMClockSet unsigned long ulConfig Parameters ulConfig is the configuration for the PWM clock it must be one of SYSCTL_PWMDIV_1 SYSCTL_PWMDIV_2 SYSCTL_PWMDIV_4 SYSCTL_PWMDIV_8 SYSCTL_PWMDIV_16 SYSCTL_PWMDIV_32 or SYSCTL_PWMDIV_64 Description This function sets the rate of the clock provided to the PWM module as a ratio of the processor clock This clock is used by the PWM module to generate PWM signals its rate forms the basis for all PWM signals Note The clocking of the PWM is dependent upon the system clock rate as configured by SysCil ClockSet Returns None 19 2 2 37 SysCtlReset Resets the device Prototype void SysCt1lReset void 280 January 11 2011 System Control Description This function will perform a software reset of the entire device The processor and all periph erals will be reset and all device registers will return to their default values with the exception of the reset cause register which will maintain its current value but have the software reset bit set as well Returns
289. gned long ulGen unsigned long ulIntTrig Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to have interrupts and triggers disabled Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 ullntTrig specifies the interrupts and triggers to be disabled Description Masks the specified interrupt s and trigger s by clearing the specified bits of the in terrupt trigger enable register for the specified PWM generator The ullntTrig parameter is the logical OR of PWM_INT_CNT_ZERO PWM_INT_CNT_LOAD PWM_INT_CNT_AU PWN_INT_CNT_AD PWM_INT_CNT_BU PWN_INT_CNT_BD PWM_TR_CNT_ZERO PWM_TR_CNT_LOAD PWM_TR_CNT_AU PWM_TR_CNT_AD PWM_TR_CNT_BU or PWM_TR_CNT_BD Returns None 16 2 2 19 PWMGenIntTrigEnable Enables interrupts and triggers for the specified PWM generator block Prototype void PWMGenIntTrigEnable unsigned long ulBase unsigned long ulGen unsigned long ulIntTrig Parameters ulBase is the base address of the PWM module 228 January 11 2011 Pulse Width Modulator PWM ulGen is the PWM generator to have interrupts and triggers enabled Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 ullntTrig specifies the interrupts and triggers to be enabled Description Unmasks the specified interrupt s and trigger s by setting the specified bits of the in terrupt trigger enable register for the specified PWM generator The ulintTrig parameter
290. gned on a 1024 byte boundary The uDMA controller supports multiple channels Each channel has a set of attribute flags to control certain UDMA features and channel behavior The attribute flags are set with the function uDMAChannelAttributeEnable and cleared with uUDMAChannelAttributeDisable The setting of the channel attribute flags can be queried by using the function UDMAChannelAttributeGet Next the control parameters of the DMA transfer must be set These parameters control the size and address increment of the data items to be transferred The function UDMAChannelControlSet is used to set up these control parameters All of the functions mentioned so far are used only once or infrequently to set up the UDMA chan nel and transfer In order to set the transfer addresses transfer size and transfer mode use the function uDMAChannelTransferSet This function must be called for each new transfer Once everything is set up the channel is enabled by calling UDMAChannelEnable which must be done before each new transfer The uDMA controller will automatically disable the channel at the com pletion of a transfer A channel can be manually disabled by using uUDMAChannelDisable There are additional functions that can be used to query the status of a channel either from an interrupt handler or in polling fashion The function uUDMAChannelSizeGet is used to find the amount of data remaining to transfer on a channel This will be zero
291. gure a receive object this CAN FIFO to receive message objects with message ID 0x400 0x407 sMsgObjectRx ulMsgID 0x400 sMsgObjectRx ulMsgIDMask 0x7f8 sMsgObjectRx ulFlags MSG_OBJ_USE_ID_FILTER MSG_OBJ_FIFO 1 The first three message objects have the MSG_OBJ_FIFO set to indicate that they are part of a FIFO CANMessageSet CANO_BASE 1 amp sMsgObjectRx MSG_OBJ_TYPE_RX CANMessageSet CANO_BASE 2 amp sMsgObjectRx MSG_OBJ_TYPE_RX CANMessageSet CANO_BASE 3 amp sMsgObjectRx MSG_OBJ_TYPE_RX Last message object does not have the MSG_OBJ_FIFO set to indicate that this is the last message sMsgObjectRx ulFlags MSG_OBJ_USE_ID_FILTER CANMessageSet CANO_BASE 4 amp sMsgObjectRx MSG_OBJ_TYPE_RX January 11 2011 67 Controller Area Network CAN 68 January 11 2011 6 6 1 6 2 Ethernet Controller Ethernet Controller MRT HON vice nasicetetdatane atau piaiilaebadan a aa a dds ena eanaeseh 69 Ue A 60 cee eee Ee eee a Ne Oe ne eee ee ae are Sere oO ene Roe ACen ne Me eee eR ET AA 69 Pregramnimng Exame lt csccucaateneeeeoauareceeecdigpideadanecceseusdeipeeeeetnseeheasnredieanaserennee 82 Introduction The Stellaris Ethernet controller consists of a fully integrated media access controller MAC and a network physical PHY interface device The Ethernet controller conforms to IEEE 802 3 specifi cations and fully supports 10BASE T and 100BASE TX
292. hGet unsigned long ulBase unsigned long ulPWMOut m void PWMPulseWidthSet unsigned long ulBase unsigned long ulPWMOut unsigned long ulWidth void PWMSyncTimeBase unsigned long ulBase unsigned long ulGenBits void PWMSyncUpdate unsigned long ulBase unsigned long ulGenBits Detailed Description These are a group of functions for performing high level operations on PWM modules Although Stellaris only has one PWM module these functions are defined to support using multiple instances of PWM modules The following functions provide the user with a way to configure the PWM for the most common operations such as setting the period generating left and center aligned pulses modifying the January 11 2011 Pulse Width Modulator PWM pulse width and controlling interrupts triggers and output characteristics However the PWM module is very versatile and it can be configured in a number of different ways many of which are beyond the scope of this API In order to fully exploit the many features of the PWM module users are advised to use register access macros When discussing the various components of a PWM module this API uses the following labeling convention m The generator blocks are called Gen0 Gen1 Gen2 and Gen3 The two PWM output signals associated with each generator block are called OutA and OutB m The output signals are called PWMO PWM1 PWM2 PWM3 PWM4 PWM5 PWM6 and PWM PWMO and PWM1 are associate
293. he GPIO module provides control for up to eight independent GPIO pins the actual number present depend upon the GPIO port and part number Each pin has the following capabilities Can be configured as an input or an output On reset they default to being an input m In input mode can generate interrupts on high level low level rising edge falling edge or both edges m In output mode can be configured for 2 mA 4 mA or 8 mA drive strength The 8 mA drive strength configuration has optional slew rate control to limit the rise and fall times of the signal On reset they default to 2 mA drive strength Optional weak pull up or pull down resistors On reset they default to a weak pull up on Sandstorm class devices and default to disabled on all other devices Optional open drain operation On reset they default to standard push pull operation m Can be configured to be a GPIO or a peripheral pin On reset they default to being GPIOs Note that not all pins on all parts have peripheral functions in which case the pin is only useful as a GPIO that is when configured for peripheral function the pin will not do anything useful Most of the GPIO functions can operate on more than one GPIO pin within a single module at a time The ucPins parameter to these functions is used to specify the pins that are affected the GPIO pins whose corresponding bits in this parameter that are set will be affected where pin 0 is in bit O pin 1
294. he HibernateEnableExpClk API A macro has been provided in hibernate h to map the old API to the new API allowing existing applications to link and run with the new API It is recommended that new applications utilize the new API in favor of the old one Function Documentation HibernateClockSelect Selects the clock input for the Hibernation module Prototype void HibernateClockSelect unsigned long ulClockInput Parameters ulClockinput specifies the clock input Description Configures the clock input for the Hibernation module The configuration option chosen de pends entirely on hardware design The clock input for the module will either be a 32 768 kHz oscillator or a 4 194304 MHz crystal The ulClockFlags parameter must be one of the following HIBERNATE_CLOCK_SEL_RAW use the raw signal from a 32 768 kHz oscillator HIBERNATE_CLOCK_SEL_DIV128 use the crystal input divided by 128 Returns None HibernateDataGet Reads a set of data from the non volatile memory of the Hibernation module Prototype void HibernateDataGet unsigned long pulData unsigned long ulCount Parameters pulData points to a location where the data that is read from the Hibernation module will be stored ulCount is the count of 32 bit words to read January 11 2011 137 Hibernation Module 10 2 2 3 10 2 2 4 138 Description Retrieves a set of data from the Hibernation module non volatile memory that was p
295. he SSI interface Description This function places the supplied data into the transmit FIFO of the specified SSI module Note The upper 32 N bits of the u Data are discarded by the hardware where N is the data width as configured by SSIConfigSetExpClk For example if the interface is configured for 8 bit data width the upper 24 bits of u Data are discarded Returns None SSIDataPutNonBlocking Puts a data element into the SSI transmit FIFO Prototype long SSIDataPutNonBlocking unsigned long ulBase unsigned long ulData Parameters ulBase specifies the SSI module base address ulData is the data to be transmitted over the SSI interface Description This function places the supplied data into the transmit FIFO of the specified SSI module If there is no space in the FIFO then this function returns a zero This function replaces the original SSIDataNonBlockingPut API and performs the same ac tions A macro is provided in ssi h to map the original API to this API January 11 2011 251 Synchronous Serial Interface SSI 18 2 2 7 18 2 2 8 252 Note The upper 32 N bits of the u Data are discarded by the hardware where N is the data width as configured by SSIConfigSetExpClk For example if the interface is configured for 8 bit data width the upper 24 bits of u Data are discarded Returns Returns the number of elements written to the SSI transmit FIFO SSIDisable Disables the
296. hernet interrupt sources Prototype void EthernetIntDisable unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the base address of the controller ullntFlags is the bit mask of the interrupt sources to be disabled Description Disables the indicated Ethernet interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor The ullntFlags parameter has the same definition as the ul lntFlags parameter to Ethernet IntEnable Returns None EthernetintEnable Enables individual Ethernet interrupt sources Prototype void EthernetIntEnable unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the base address of the controller ullntFlags is the bit mask of the interrupt sources to be enabled Description Enables the indicated Ethernet interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor The ullntFlags parameter is the logical OR of any of the following January 11 2011 Ethernet Controller ETH_INT_PHY An interrupt from the PHY has occurred The integrated PHY supports a number of interrupt conditions The PHY register PHY_MR17 must be read to determine which PHY interrupt has occurred This register can be read using the EthernetPHY Read API function ETH_INT_MDIO
297. his call will return O on success or 1 to indicate that the FIFO is in use and cannot be written January 11 2011 365 USB Controller 24 3 2 15 USBEndpointDataSend Starts the transfer of data from an endpoint s FIFO Prototype long USBEndpointDataSend unsigned long ulBase unsigned long ulEndpoint unsigned long ulTransType Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulTransType is set to indicate what type of data is being sent Description This function will start the transfer of data from the FIFO for a given endpoint This is necessary if the USB_EP_AUTO_ SET bit was not enabled for the endpoint Setting the u TransType parameter will allow the appropriate signaling on the USB bus for the type of transaction being requested The u TransType parameter should be one of the following USB_TRANS_OUT for OUT transaction on any endpoint in host mode m USB_TRANS_IN for IN transaction on any endpoint in device mode USB_TRANS_IN_LAST for the last IN transactions on endpoint zero in a sequence of IN transactions USB_TRANS_SETUP for setup transactions on endpoint zero m USB_TRANS_STATUS for status results on endpoint zero Returns This call will return O on success or 1 if a transmission is already in progress 24 3 2 16 USBEndpointDataToggleClear Sets the Data toggle on an endpoint to zero Prototype void USBEndpointDataToggleClear
298. ialize the GPIO pin configuration Set pins 2 4 and 5 as input SW controlled ah January 11 2011 GPIO GPIOPinTypeGPIOInput GPIO_PORTA_BASE GPIO_PIN_2 GPIO_PIN_4 GPIO_PIN_5 f Set pins 0 and 3 as output SW controlled GPIOPinTypeGPIOOutput GPIO_PORTA_BASE GPIO_PIN_O GPIO_PIN_3 Make pins 2 and 4 rising edge triggered interrupts Lf GPIOIntTypeSet GPIO_PORTA_BASE GPIO_PIN_2 GPIO_PIN_4 GPIO_RISING_EDGE Make pin 5 high level triggered interrupts GPIOIntTypeSet GPIO_PORTA_BASE GPIO_PIN_5 GPIO_HIGH_LEVEL Read some pins iVal GPIOPinRead GPIO_PORTA_BASE GPIO_PIN_O GPIO_PIN_2 GPIO_PIN_3 GPIO_PIN_4 GPIO_PIN_5 Lf Write some pins Even though pins 2 4 and 5 are specified those pins are unaffected by this write since they are configured as inputs At the end of this write pin 0 will be a 0 and pin 3 will be a 1 GPIOPinWrite GPIO_PORTA_BASE GPIO_PIN_O GPIO_PIN_2 GPIO_PIN_3 GPIO_PIN_4 GPIO_PIN_5 OxF8 Enable the pin interrupts GPIOPinIntEnable GPIO_PORTA_BASE GPIO_PIN_2 GPIO_PIN_4 GPIO_PIN_5 January 11 2011 133 GPIO 134 January 11 2011 Hibernation Module 10 Hibernation Module diets N ole sae eee ee et ee ree ee rer Carer eter irene renee ee ee Len eee Teeter res cee ee reer ee eer 135 AP PONCHO 2hceccc ida wiveneranieiwethealewet i eesriaesdd auci Se ulea
299. ications API Functions Functions void SysTickDisable void void SysTickEnable void void SysTickIntDisable void void SysTickIntEnable void void SysTicklntRegister void xpfnHandler void void SysTickIntUnregister void unsigned long SysTickPeriodGet void void SysTickPeriodSet unsigned long ulPeriod unsigned long SysTickValueGet void Detailed Description The SysTick API is fairly simple like SysTick itself There are functions for configuring and en abling SysTick SysTickEnable SysTickDisable SysTickPeriodSet SysTickPeriodGet and SysTickValueGet and functions for dealing with an interrupt handler for SysTick SysTickIntReg ister SysTickIntUnregister SysTickIntEnable and SysTickIntDisable Function Documentation SysTickDisable Disables the SysTick counter January 11 2011 285 System Tick SysTick 20 2 2 2 20 2 2 3 286 Prototype void SysTickDisable void Description This will stop the SysTick counter If an interrupt handler has been registered it will no longer be called until SysTick is restarted Returns None SysTickEnable Enables the SysTick counter Prototype void SysTickEnable void Description This will start the SysTick counter If an interrupt handler has been registered it will be called when the SysTick counter rolls over Note Calling this function will cause the SysTick counter to re commence counting from its
300. ified PWM generator block The period of the generator block is defined as the number of PWM clock ticks between pulses on the generator block zero signal If the update of the counter for the specified PWM generator has yet to be completed the value returned may not be the active period The value returned is the programmed period measured in PWM clock ticks Returns Returns the programmed period of the specified generator block in PWM clock ticks 16 2 2 22 PWMGenPeriodSet Set the period of a PWM generator Prototype void PWMGenPeriodSet unsigned long ulBase unsigned long ulGen unsigned long ulPeriod Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to be modified Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_ 2 or PWM_GEN_3 ulPeriod specifies the period of PWM generator output measured in clock ticks Description This function sets the period of the specified PWM generator block where the period of the generator block is defined as the number of PWM clock ticks between pulses on the generator block zero signal Note Any subsequent calls made to this function before an update occurs will cause the previous values to be overwritten Returns None 16 2 2 23 PWMintDisable Disables generator and fault interrupts fora PWM module Prototype void PWMIntDisable unsigned long ulBase unsigned long ulGenFault 230 January 11 2011 Pulse Width Modul
301. igned long ulBase void I2STxRxEnable unsigned long ulBase Detailed Description The I2S peripheral contains a transmit and receive module which are generally the same in terms of configuration Use I2SRxConfigSet or I2STxConfigSet to configure the receive or transmit module format and mode Once configured the transmit or receive module must be enabled us ing l2STxEnable or I2SRxEnable The module can be later disabled with I2STxDisable or I2SRxDisable If you want to use interrupts or DMA to service the 12S FIFO then the FIFO trigger level must be set using I2SRxFIFOLimitSet or IASTxFIFOLimitSet Use the function 12STxDataPut to write data to the 12S transmit FIFO This function will block until there is space in the FIFO To avoid blocking use the function 12STxDataPutNonBlocking instead Likewise the functions I2SRxDataGet and 12SRxDataGetNonBlocking are used to read data from the receive FIFO There are several functions that can be used to query the status of the 12S peripheral The functions I2SRxFIFOLevelGet and I2STxFlFOLevelGet can be used to read the number of samples in the receive or transmit FIFO There is a master clock that is used to derive the serial bit clock SCLK and the left right word clock LRCLK timings The master clock can be generated by the microcontroller s internal PLL or from an external pin The master clock source is configured with the function 2SMasterClockSelect Th
302. igned long ulGPIOPeripheral Parameters ulGP OPeripheral is the GPIO peripheral to disable Description This function disables the specified GPIO peripheral for access from the Advanced Host Bus AHB Once disabled the GPIO peripheral is accessed from the legacy Advanced Peripheral Bus AHB The ulGPlOPeripheral argument must be only one of the following values SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOG or SYSCTL_PERIPH_GPIOH Returns None 19 2 2 11 SysCtIGPIOAHBEnable Enables a GPIO peripheral for access from the AHB Prototype void SysCt1GPIOAHBEnable unsigned long ulGPIOPeripheral Parameters ulGP OPeripheral is the GPIO peripheral to enable Description 266 This function is used to enable the specified GPIO peripheral to be accessed from the Ad vanced Host Bus AHB instead of the legacy Advanced Peripheral Bus APB When a GPIO January 11 2011 System Control peripheral is enabled for AHB access the _AHB_BASE form of the base address should be used for GPIO functions For example instead of using GPIO_PORTA_BASE as the base address for GPIO functions use GPIO_PORTA_AHB_BASE instead The ulGP lOPeripheral argument must be only one of the following values SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOF
303. ill be used to determine the clock rate of the external interface The u Divider value is used to derive the EPI clock rate from the system clock based upon the following formula EPIClock Divider 0 SysClk SysClk Divider 2 1 2 For example a divider value of 1 results in an EPI clock rate of half the system clock value of 2 or 3 yield one quarter of the system clock and a value of 4 results in one sixth of the system clock rate In cases where a dual chip select mode is in use and different clock rates are required for each chip select the u Divider parameter must contain two dividers The lower 16 bits define the divider to be used with CSOn and the upper 16 bits define the divider for CS1n Returns None EPIFIFOConfig Configures the read FIFO Prototype void EPIFIFOConfig unsigned long ulBase unsigned long ulConfig January 11 2011 External Peripheral Interface EP Parameters ulBase is the EPI module base address ulConfig is the FIFO configuration Description This function configures the FIFO trigger levels and error generation The parameter u Config is the logical OR of the following EPIl_FIFO_CONFIG_WTFULLERR enables an error interrupt when a write is attempted and the write FIFO is full EPI _FIFO_CONFIG_RSTALLERR enables an error interrupt when a read is stalled due to an interleaved write or other reason EPIl_FIFO_CONFIG_TX_EMPTY EPI_FIFO_CONFIG_TX_1_4
304. ily of ARM Cortex M3 based microcontrollers While they are not drivers in the pure operating system sense that is they do not have a common interface and do not connect into a global device driver infrastructure they do provide a mechanism that makes it easy to use the device s peripherals The capabilities and organization of the drivers are governed by the following design goals They are written entirely in C except where absolutely not possible m They demonstrate how to use the peripheral in its common mode of operation m They are easy to understand m They are reasonably efficient in terms of memory and processor usage m They are as self contained as possible m Where possible computations that can be performed at compile time are done there instead of at run time m They can be built with more than one tool chain Some consequences of these design goals are m The drivers are not necessarily as efficient as they could be from a code size and or execution speed point of view While the most efficient piece of code for operating a peripheral would be written in assembly and custom tailored to the specific requirements of the application further size optimizations of the drivers would make them more difficult to understand The drivers do not support the full capabilities of the hardware Some of the peripherals provide complex capabilities which cannot be utilized by the drivers in this library though the existing
305. imer If the bStall parameter is true then the timer will stop counting if the processor enters debug mode otherwise the timer will keep running while in debug mode Returns None TimerControlTrigger Enables or disables the trigger output Prototype void TimerControlTrigger unsigned long ulBase unsigned long ulTimer tBoolean bEnable Parameters ulBase is the base address of the timer module ulTimer specifies the timer to adjust must be one of TIMER_A TIMER_B or TIMER_BOTH bEnable specifies the desired trigger state Description This function controls the trigger output for the specified timer If the bEnable parameter is true then the timer s output trigger is enabled otherwise it is disabled Returns None TimerControlWaitOn Trigger Controls the wait on trigger handling Prototype void TimerControlWaitOnTrigger unsigned long ulBase unsigned long ulTimer tBoolean bWait January 11 2011 295 Timer 21 2 2 7 21 2 2 8 296 Parameters ulBase is the base address of the timer module ulTimer specifies the timer s to be adjusted must be one of TIMER_A TIMER_B or TIMER_BOTH bWait specifies if the timer should wait for a trigger input Description This function controls whether or not a timer waits for a trigger input to start counting When enabled the previous timer in the trigger chain must count to its timeout in order for this timer to start counting Refer to
306. in bit 1 and so on For example if ucPins is 0x09 then pins 0 and 3 will be affected by the function This is most useful for the GPIOPinRead and GPIOPinWrite functions a read will return only the value of the requested pins with the other pin values masked out and a write will affect the requested pins simultaneously that is the state of multiple GPIO pins can be changed at the same time This data masking for the GPIO pin state occurs in the hardware a single read or write is issued to the hardware which interprets some of the address bits as an indication of the GPIO pins to operate upon and therefore the ones to not affect See the part data sheet for details of the GPIO data register address based bit masking For functions that have a ucPin singular parameter only a single pin is affected by the function In this case this value specifies the pin number that is 0 through 7 This driver is contained in driverlib gpio c with driverlib gpio h containing the API definitions for use by applications January 11 2011 113 GPIO 9 2 9 2 1 114 API Functions Functions unsigned long GPIODirModeGet unsigned long ulPort unsigned char ucPin void GPIODirModeSet unsigned long ulPort unsigned char ucPins unsigned long ulPinlO unsigned long GP OIntTypeGet unsigned long ulPort unsigned char ucPin void GPIOIntTypeSet unsigned long ulPort unsigned char ucPins unsigned long ullntType void GPIOPadConfigGet
307. in number pulStrength is a pointer to storage for the output drive strength January 11 2011 117 GPIO 9 2 2 6 118 pulPinType is a pointer to storage for the output drive type Description This function gets the pad configuration for a specified pin on the selected GPIO port The values returned in pulStrength and pulPinType correspond to the values used in GPIOPad ConfigSet This function also works for pin s configured as input pin s however the only meaningful data returned is whether the pin is terminated with a pull up or down resistor Returns None GPIOPadConfigSet Sets the pad configuration for the specified pin s Prototype void GPIOPadConfigSet unsigned long ulPort unsigned char ucPins unsigned long ulStrength unsigned long ulPinType Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s ulStrength specifies the output drive strength ulPinType specifies the pin type Description This function sets the drive strength and type for the specified pin s on the selected GPIO port For pin s configured as input ports the pad is configured as requested but the only real effect on the input is the configuration of the pull up or pull down termination The parameter u Strength can be one of the following values GPIO_STRENGTH_2MA GPIO_STRENGTH_4MA GPIO_STRENGTH_8MA GPIO_STRENGTH_8MA_SC where GPIO_STRENGTH_xMA
308. in size USBFIFOConfig USBO_BASE USB_EP_2 1088 USB_FIFO_SZ_512 USB_EP_DEV_IN Function Documentation USBDevAddrGet Returns the current device address in device mode Prototype unsigned long USBDevAddrGet unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function will return the current device address This address was set by a call to USBDe vAddrSet Note This function should only be called in device mode January 11 2011 24 3 2 2 24 3 2 3 USB Controller Returns The current device address USBDevAdadrSet Sets the address in device mode Prototype void USBDevAddrSet unsigned long ulBase unsigned long ulAddress Parameters ulBase specifies the USB module base address ulAddress is the address to use for a device Description This function will set the device address on the USB bus This address was likely received via a SET ADDRESS command from the host controller Note This function should only be called in device mode Returns None USBDevConnect Connects the USB controller to the bus in device mode Prototype void USBDevConnect unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function will cause the soft connect feature of the USB controller to be enabled Call USBDisconnect to remove the USB device from the bus Note This function should onl
309. in the Hibernation module After calling this function the RTC features of the Hibernation module will not be available Returns None 10 2 2 17 HibernateRTCEnable Enables the RTC feature of the Hibernation module Prototype void HibernateRTCEnable void Description Enables the RTC in the Hibernation module The RTC can be used to wake the processor from hibernation at a certain time or to generate interrupts at certain times This function must be called before using any of the RTC features of the Hibernation module Returns None 10 2 2 18 HibernateRTCGet Gets the value of the real time clock RTC counter Prototype unsigned long HibernateRTCGet void Description Gets the value of the RTC and returns it to the caller Returns Returns the value of the RTC 10 2 2 19 HibernateRTCMatchOGet Gets the value of the RTC match 0 register Prototype unsigned long HibernateRTCMatch0Get void Description Gets the value of the match 0 register for the RTC 144 January 11 2011 Hibernation Module Returns Returns the value of the match register 10 2 2 20 HibernateRTCMatchOSet Sets the value of the RTC match 0 register Prototype void HibernateRTCMatch0OSet unsigned long ulMatch Parameters ulMatch is the value for the match register Description Sets the match 0 register for the RTC The Hibernation module can be configured to wake from hibernation and or generate
310. ing This function will not return until the protection has been saved Returns Returns 0 on success or 1 if a hardware error is encountered FlashUserSet Sets the user registers Prototype long FlashUserSet unsigned long ulUser0O unsigned long ulUserl1 Parameters ulUser0 is the value to store in USER Register 0 ulUser7 is the value to store in USER Register 1 Description This function will set the contents of the user registers 0 and 1 to the specified values January 11 2011 Flash Returns Returns 0 on success or 1 if a hardware error is encountered 8 3 Programming Example The following example shows how to use the flash API to erase a block of the flash and program a few words January 11 2011 unsigned long pulData 2 Set the uSec value to 20 indicating that the processor is running at 20 MHz FlashUsecSet 20 Ld Erase a block of the flash FlashErase 0x800 Program some data into the newly erased block of the flash eA pulData 0 0x12345678 pulData 1 0x56789abc FlashProgram pulData 0x800 sizeof pulData 111 Flash 112 January 11 2011 9 1 GPIO GPIO OUI anea aa a a hha dnn seed bebe here deudel sak eewds 113 PP PMC HONS 6 tanec eee a E tin tease came besa bein nee een a teor ees 114 Protea Example ccc cannpenaeaein pis enedscemeagemeegrs OeGeaneeke Coogee seugusncreeebedseieesmandes 132 Introduction T
311. ing the CANStatusGet function There is a controller status reg ister that provides general status information such as error or warning conditions There are also several status registers that provide information about all of the message objects at once using a 32 bit bit map of the status with one bit representing each message object These status registers can be used to determine m Which message objects have unprocessed received data m Which message objects have pending transmission requests m Which message objects are allocated for use Data Structure Documentation tCANBitClkParms Definition typedef struct January 11 2011 Controller Area Network CAN unsigned int uSyncPropPhaselSeg unsigned int uPhase2Seg unsigned int uSJW unsigned int uQuantumPrescaler tCANBitClkParms Members uSyncPropPhase1Seg This value holds the sum of the Synchronization Propagation and Phase Buffer 1 segments measured in time quanta The valid values for this setting range from 2 to 16 uPhase2Seg This value holds the Phase Buffer 2 segment in time quanta The valid values for this setting range from 1 to 8 uSJW This value holds the Resynchronization Jump Width in time quanta The valid values for this setting range from 1 to 4 uQuantumPrescaler This value holds the CAN_CLK divider used to determine time quanta The valid values for this setting range from 1 to 1023 Description This structure is used for encapsulating the v
312. interrupt is asserted to the processor The interrupt source will be automatically disabled via IntDisable if necessary See also IntRegister for important information about registering interrupt handlers Returns None January 11 2011 Interrupt Controller NVIC 13 3 Programming Example The following example shows how to use the Interrupt Controller API to register an interrupt handler and enable the interrupt The interrupt handler function extern void IntHandler void Register the interrupt handler function for interrupt 5 IntRegister 5 IntHandler Ld Enable interrupt 5 IntEnable 5 Enable interrupt 5 IntMasterEnable January 11 2011 195 Interrupt Controller NVIC 196 January 11 2011 Memory Protection Unit MPU 14 Memory Protection Unit MPU Mi ea N s e E EEEIEE TIT T AAA T aun Ema pets hdd tote AN T AE tle cy hae AES TTET 197 RP PONCHO sorosseoi kikno nerea Ear a EAEE 197 Pregrammmg Example eearri a A EE E A a 204 14 1 Introduction The Memory Protection Unit MPU API provides functions to configure the MPU The MPU is tightly coupled to the Cortex M3 processor core and provides a means to establish access permissions on regions of memory Up to eight memory regions can be defined Each region has a base address and a size The size is specified as a power of 2 between 32 bytes and 4 GB inclusive The region s base address
313. interrupt sources IN Endpoints OUT End points and general status changes specified by USB_INT_HOST_IN USB_INT_HOST_OUT USB_INT_DEV_IN USB_INT_DEV_OUT and USB_STATUS If USB_INT_ALL is specified then all interrupts will be enabled Note A call must be made to enable the interrupt in the main interrupt controller to receive interrupts The USBIntRegister API performs this controller level interrupt enable However if static interrupt handlers are used then then a call to IntEnable must be made in order to allow any USB interrupts to occur WARNING This API cannot be used on endpoint numbers greater than endpoint 3 so USBIn tEnableControl or USBIntEnableEndpoint should be used instead Returns None 24 3 2 50 USBIntEnableControl Enable control interrupts on a given USB controller Prototype void USBIntEnableControl unsigned long ulBase unsigned long ulFlags Parameters ulBase specifies the USB module base address ulFlags specifies which control interrupts to enable Description This function will enable the control interrupts for the USB controller specified by the u Base parameter The ulFlags parameter specifies which control interrupts to enable The flags passed in the u Flags parameters should be the definitions that start with USB_INTCTRL_ and not any other USB_INT flags Returns None 24 3 2 51 USBIntEnableEndpoint Enable endpoint interrupts on a given USB controller Proto
314. ion will allow the configuration of options such as Promiscuous Mode Multicast Reception Transmit Data Length Padding and so on The EthernetConfigGet function can be used to query the current configuration of the Ethernet MAC The MAC address used for incoming packet filtering must also be programmed using the Eth ernetMACAddrSet function The current value can be queried using the EthernetMACAddrGet function When configuration has been completed the Ethernet controller can be enabled using the Ether netEnable function When getting ready to terminate operations on the Ethernet controller the EthernetDisable function may be called After the Ethernet controller has been enabled Ethernet frames can be transmitted and received using the EthernetPacketPut and EthernetPacketGet functions Care must be taken when using these functions as they are blocking functions and will not return until data is available for RX or buffer space is available for TX The EthernetSpaceAvail and EthernetPacketAvail functions can be called to determine if there is room for a TX packet or if there is an RX packet available prior to calling these blocking functions Alternatively the EthernetPacketGetNonBlocking and EthernetPacketPutNonBlocking functions will return immediately if a packet cannot be processed Otherwise the packet will be processed normally When developing a mapping layer for a TCP IP stack you may wish to use the in
315. is function will configure both the transmit and receive module If the internal PLL is used then the master clock rate must be set using SysClkI2SClockSet Interrupts for the transmit and receive modules are configured together since there is one interrupt for both Interrupts are enabled or disabled using I2SIntEnable and I2SIntDisable The interrupt status can be read using I2SIntStatus from within the interrupt handler or non interrupt code When in the interrupt handler the pending interrupts must be cleared using I2SIntClear January 11 2011 12 2 2 12 2 2 1 12 2 2 2 Inter IC Sound 12S If interrupt vectors are statically determined at run time see IntRegister then the peripheral interrupts must be enabled on the master interrupt controller using IntEnable If the interrupts are registered at run time then the function I2SIntRegister can be used to install the interrupt handler This function will also enable interrupts on the main controller Function Documentation I2SIntClear Clears pending 12S interrupt sources Prototype void T2SIntClear unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the 2S module base address ullntFlags is a bit mask of the interrupt sources to be cleared Description This function clears the specified pending 12S interrupts This must be done in the inter rupt handler to keep the handler from being called again immediately upon exit
316. isabled Description Disables the indicated I2C Slave interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor January 11 2011 165 Inter Integrated Circuit 12C The ullntFlags parameter has the same definition as the ullntFlags parameter to I2CSlavelntEnableEx Returns None 11 2 2 26 2CSlavelntEnable Enables the I2C Slave interrupt Prototype void I2CSlaveIntEnable unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description Enables the I2C Slave interrupt source Returns None 11 2 2 27 2CSlavelntEnableEx Enables individual I2C Slave interrupt sources Prototype void T2CSlaveIntEnableEx unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the base address of the I2C Slave module ullntFlags is the bit mask of the interrupt sources to be enabled Description Enables the indicated I2C Slave interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor The ullntFlags parameter is the logical OR of any of the following m 12C_SLAVE_INT_STOP Stop condition detected interrupt m 12C_SLAVE_INT_START Start condition detected interrupt m 12C_SLAVE_INT_DATA Data interrupt Returns None January 11 2011 Inter Integrated Circuit
317. it that is set identifies an active masked or raw inter rupt and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Bits 31 8 should be ignored GPIOPinRead Reads the values present of the specified pin s Prototype long GPIOPinRead unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The values at the specified pin s are read as specified by ucPins Values are returned for both input and output pin s and the value for pin s that are not specified by ucPins are set to 0 The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on January 11 2011 121 GPIO 9 2 2 13 9 2 2 14 122 Returns Returns a bit packed byte providing the state of the specified pin where bit O of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Any bit that is not specified by ucPins is returned as a 0 Bits 31 8 should be ignored GPIOPinTypeADC Configures pin s for use as analog to digital converter inputs Prototype void GPIOPinTypeADC unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representatio
318. ize of the data frame is also configurable and can be set to be between 4 and 16 bits inclusive The SSI module performs serial to paralle data conversion on data received from a peripheral device and parallel to serial conversion on data transmitted to a peripheral device The TX and RX paths are buffered with internal FIFOs allowing up to eight 16 bit values to be stored independently The SSI module can be configured as either a master or a slave device As a slave device the SSI module can also be configured to disable its output which allows a master device to be coupled with multiple slave devices The SSI module also includes a programmable bit rate clock divider and prescaler to generate the output serial clock derived from the SSI module s input clock Bit rates are generated based on the input clock and the maximum bit rate supported by the connected peripheral For parts that include a DMA controller the SSI module also provides a DMA interface to facilitate data transfer via DMA This driver is contained in driverlib ssi c with driverlib ssi h containing the API defi nitions for use by applications 18 2 API Functions Functions m tBoolean SSIBusy unsigned long ulBase m void SSIConfigSetExpClk unsigned long ulBase unsigned long ulSSIClk unsigned long ul Protocol unsigned long ulMode unsigned long ulBitRate unsigned long ulDataWidth void SSIDataGet unsigned long ulBase unsigned long pulData long SSIDa
319. k ding De adeeb hea datas 393 APOPO MOUS 6 tanec te ec oak owns aieca ee td scent ca eae eda benden ase e enue beainet anaes 393 Programming ERIN DIE ccc sornremaeceiapisened camtagemeegertbagenecEsepesarsouquanerheabedeereenmacles 401 Introduction The Watchdog Timer API provides a set of functions for using the Stellaris watchdog timer mod ules Functions are provided to deal with the watchdog timer interrupts and to handle status and configuration of the watchdog timer The watchdog timer module s function is to prevent system hangs The watchdog timer module consists of a 32 bit down counter a programmable load register interrupt generation logic and a locking register Once the watchdog timer has been configured the lock register can be written to prevent the timer configuration from being inadvertently altered The watchdog timer can be configured to generate an interrupt to the processor upon its first time out and to generate a reset signal upon its second timeout The watchdog timer module generates the first timeout signal when the 32 bit counter reaches the zero state after being enabled en abling the counter also enables the watchdog timer interrupt After the first timeout event the 32 bit counter is reloaded with the value of the watchdog timer load register and the timer resumes count ing down from that value If the timer counts down to its zero state again before the first timeout interrupt is cleared and the reset si
320. king of the device Prototype void SysCt1lClockSet unsigned long ulConfig Parameters ulConfig is the required configuration of the device clocking Description 264 This function configures the clocking of the device The input crystal frequency oscillator to be used use of the PLL and the system clock divider are all configured with this function The ulConfig parameter is the logical OR of several different values many of which are grouped into sets where only one can be chosen The system clock divider is chosen with one of the following values SYSCTL_SYSDIV_1 SYSCTL_SYSDIV_2 SYSCTL_SYSDIV 3 _ SYSCTL_SYSDIV_64 Only SYSCTL_SYSDIV_1 through SYSCTL_SYSDIV_16 are valid on Sandstorm class devices The use of the PLL is chosen with either SYSCTL_USE_PLL or SYSCTL_USE_OSC The external crystal frequency is chosen with one of the following val ues SYSCTL_XTAL_1MHZ SYSCTL_XTAL_1_84MHZ SYSCTL_XTAL_2MHZ SYSCTL_XTAL_2_45MHZ SYSCTL_XTAL_3_57MHZ SYSCTL_XTAL_3_68MHZ SYSCTL_XTAL_4MHZ SYSCTL_XTAL_4_09MHZ SYSCTL_XTAL_4_91MHZ SYSCTL_XTAL_5MHZ SYSCTL_XTAL_5_12MHZ SYSCTL_XTAL_6MHZ SYSCTL_XTAL_6_14MHZ SYSCTL_XTAL_7_37MHZ SYSCTL_XTAL_8MHZ SYSCTL_XTAL_8_19MHZ SYSCTL_XTAL_10MHZ SYSCTL_XTAL_12MHZ SYSCTL_XTAL_12_2MHZ SYSCTL_XTAL_13_5MHZ SYSCTL_XTAL_14_3MHZ SYSCTL_XTAL_16MHZ or SYSCTL_XTAL_16_3MHZ Values below SYSCTL_XTAL_3_57MHZ are not valid when the PLL is in operation On Sandstorm and Fury class devi
321. l s ee ee oe eR ee a ewe ee 10 2 4 Combining The Models 2 0 0 11 3 Analog Comparator 2 0 ee 13 Ql WOO CHON 2c aa ie ROR a eee ESSER Ree Ee CRE TR SERS RES SSS DER ERS 13 ee AP RURCUGHE 6 40294 ee ee REG AWAKE ee OR eR EE Eee a EY 13 a Programming Example lt sasara hoe ee eee eas BER EEE Cee PO Se ee 19 4 Analog to Digital Converter ADC 2 ee e 21 Al AWOGUCWON o a cee eee eRe ee SS OE SRP e we eA SSG REe CS ewe ee Gee oe ERS 21 42 APIVFPUNGIONS oo wp ek a ee ae oe OO De ee eh ee Oe EE 22 4 3 Programming Example 2 2 5 i 006 25528 SRD Red eee ee ee ee es 40 5 Controller Area Network CAN 2 00 ee n 41 Dak INFOJUCNON e a aa aa a erei a a a Ba OE ee eee Ae RRR EH E a a ee d See 41 wa APIFONCIONS oi 2 ee eee a a a ee RE Oe eek BO aa O E E a 41 5 3 CAN Message Objects n oaoa 63 5 4 Programming Examples s sss esea reee a ee Oe hare SR ee ee 65 6 Ethernet Controller a coreana a a ee a ee 69 CT UOOUBHON a ete oe Re d e we ee eR RRR dow ae Ree a 69 G2 oAPUFUNGIONS 2 5 4 6022 200088 8a Be ew Ta Boe eee be EES She Bd alata i 69 6 3 Frogramming Example lt ses er ee ee MO De ee Rae a he he 82 7 External Peripheral Interface EPI 2 6 ee 85 A WOROCUTION 2k Rk eee R a d a Ee oO PB ae Ae eR Cele oid 85 Te PLP UNGNONS cioe eee eran ea eA ER ee Shee ee bbb a bea es 85 7 2 Programming Example lt s ssw era fe ee ee eee Ca ae eke ee ew MALE EB ee 101 8 Peder y bre reine Ge Bop a
322. l structure for this chan nel UDMA_ATTR_HIGH_PRIORITY is used to set this channel to high priority UDMA_ATTR_REQMASK is used to mask the hardware request signal from the periph eral for this channel Returns None 23 2 3 2 uDMAChannelAttributeEnable Enables attributes of a UDMA channel Prototype void uDMAChannelAttributeEnable unsigned long ulChannelNum unsigned long ulAttr Parameters ulChannelNum is the channel to configure ulAtir is a combination of attributes for the channel Description The ulAttr parameter is the logical OR of any of the following UDMA_ATTR_USEBURST is used to restrict transfers to use only a burst mode UDMA_ATTR_ALTSELECT is used to select the alternate control structure for this chan nel it is very unlikely that this flag should be used UDMA_ATTR_HIGH_PRIORITY is used to set this channel to high priority UDMA_ATTR_REQMASK is used to mask the hardware request signal from the periph eral for this channel Returns None 23 2 3 3 uDMAChannelAttributeGet Gets the enabled attributes of a UDMA channel Prototype unsigned long uDMAChannelAttributeGet unsigned long ulChannelNum Parameters ulChannelNum is the channel to configure January 11 2011 337 uDMA Controller Description This function returns a combination of flags representing the attributes of the UDMA channel Returns Returns the logical OR of the attributes of the
323. lBase tBoolean bStart Parameters ulBase specifies the USB module base address bStart specifies if the USB controller is entering or leaving the resume signaling state Description When in device mode this function will bring the USB controller out of the suspend state This call should first be made with the bStart parameter set to true to start resume signaling The device application should then delay at least 10ms but not more than 15ms before calling this function with the bStart parameter set to false When in host mode this function will signal devices to leave the suspend state This call should first be made with the bStart parameter set to true to start resume signaling The host application should then delay at least 20ms before calling this function with the bStart parameter set to false This will cause the controller to complete the resume signaling on the USB bus Returns None 24 3 2 44 USBHostSpeedGet Returns the current speed of the USB device connected Prototype unsigned long USBHostSpeedGet unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function will return the current speed of the USB bus Note This function should only be called in host mode Returns Returns either USB_LOW_SPEED USB_FULL_SPEED or USB _UNDEF_SPEED 382 January 11 2011 USB Controller 24 3 2 45 USBHostSuspend Puts the USB bus in a suspended state Prototype
324. lEndpoint unsigned long USBFIFOAddrGet unsigned long ulBase unsigned long ulEndpoint void USBFIFOConfigGet unsigned long ulBase unsigned long ulEndpoint unsigned long pulFIFOAddress unsigned long pulFIFOSize unsigned long ulFlags void USBFIFOConfigSet unsigned long ulBase unsigned long ulEndpoint unsigned long ul FIFOAddress unsigned long ulFIFOSize unsigned long ulFlags void USBFIFOFlush unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags unsigned long USBFrameNumberGet unsigned long ulBase unsigned long USBHostAddrGet unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags void USBHostAddrSet unsigned long ulBase unsigned long ulEndpoint unsigned long ulAddr unsigned long ulFlags void USBHostEndpointConfig unsigned long ulBase unsigned long ulEndpoint unsigned long ulMaxPayload unsigned long ulNAKPolllnterval unsigned long ulTargetEndpoint un signed long ulFlags void USBHostEndpointDataAck unsigned long ulBase unsigned long ulEndpoint void USBHositEndpointData Toggle unsigned long ulBase unsigned long ulEndpoint tBoolean bDataToggle unsigned long ulFlags void USBHositEndpointStatusClear unsigned long ulBase unsigned long ulEndpoint un signed long ulFlags January 11 2011 24 3 1 USB Controller m unsigned long USBHostHubAddrGet unsigned long ulBase unsigned long ulEndpoint un signed long ulFlags void USBHostHubAddrSet unsigned long ulBase u
325. le It must be configured before it is enabled See also QEIConfigure Returns None QEIErrorGet Gets the encoder error indicator Prototype tBoolean QETErrorGet unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This returns the error indicator for the quadrature encoder It is an error for both of the signals of the quadrature input to change at the same time January 11 2011 17 2 2 6 17 2 2 7 Quadrature Encoder QE Returns Returns true if an error has occurred and false otherwise QElIntClear Clears quadrature encoder interrupt sources Prototype void QEIIntClear unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the base address of the quadrature encoder module ullntFlags is a bit mask of the interrupt sources to be cleared Can be any of the QEI_INTERROR QEL INTDIR QEL INTTIMER or QEI_INTINDEX values Description The specified quadrature encoder interrupt sources are cleared so that they no longer assert This must be done in the interrupt handler to keep it from being called again immediately upon exit Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last ac
326. le sequences The underflow condition must be cleared in order to detect a subsequent underflow condition it otherwise causes no harm Returns None ADCSoftwareOversampleConfigure Configures the software oversampling factor of the ADC Prototype void ADCSoftwareOversampleConfigure unsigned long ulBase unsigned long ulSequenceNum unsigned long ulFactor Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number ulFactor is the number of samples to be averaged Description This function configures the software oversampling for the ADC which can be used to provide better resolution on the sampled data Oversampling is accomplished by averaging multiple samples from the same analog input Three different oversampling rates are supported 2x 4x and 8x Oversampling is only supported on the sample sequencers that are more than one sample in depth that is the fourth sample sequencer is not supported Oversampling by 2x for exam ple divides the depth of the sample sequencer by two so 2x oversampling on the first sample sequencer can only provide four samples per trigger This also means that 8x oversampling is only available on the first sample sequencer Returns None ADCSoftwareOversampleDataGet Gets the captured data for a sample sequence using software oversampling January 11 2011 4 2 2 31 Analog to Digital Converter ADC Prototype void ADCSoftwareO
327. ler does not need to be registered However it does need to be enabled IntEnable FAULT_MPU When setting up the regions region 2 was initially disabled for some reason At some point it needs to be enabled it MPURegionEnable 2 Now the MPU will be enabled It will be configured so that a default map is available in privileged mode if no regions are defined The MPU will not be enabled for the hard fault and NMI handlers which means a default map will be used whenever these handlers are active effectively giving the fault handlers access to all of memory without any protection MPUEnable MPU_CONFIG_PRIV_DEFAULT At this point the MPU is configured and enabled and if any code causes an access violation the memory management fault will occur The following example shows how to save and restore region configurations The following arrays provide space for saving the address and attributes for 4 region configurations unsigned long ulRegionAddr 4 unsigned long ulRegionAttr 4 January 11 2011 205 Memory Protection Unit MPU At some point in the system code we want to save the state of 4 regions EE Q73 s for uIdx 0 ulIdx lt 4 ulIdx MPURegionGet uIdx amp ulRegionAddr ulIdx amp ulRegionAttr uldx At some other point the previously saved regions should be restored for uIdx 0 ulId
328. ler for the EPI module Prototype void EPIIntUnregister unsigned long ulBase Parameters ulBase is the EPI module base address Description This function will disable and clear the handler to be called when the EPI interrupt occurs See also IntRegister for important information about registering interrupt handlers Returns None 7 2 2 15 EPlIModeSet Sets the usage mode of the EPI module Prototype void EPIModeSet unsigned long ulBase unsigned long ulMode Parameters ulBase is the EPI module base address ulMode is the usage mode of the EPI module Description This functions sets the operating mode of the EPI module The parameter u Mode must be one of the following EPIl_MODE_GENERAL use for general purpose mode operation EPI_MODE_SDRAM use with SDRAM device EPI_MODE_HB8 use with host bus 8 bit interface EPI_MODE_HB 16 use with host bus 16 bit interface EPI_MODE_DISABLE disable the EPI module Selection of any of the above modes will enable the EPI module except for EPI_MODE_DISABLE which should be used to disable the module Returns None 96 January 11 2011 7 2 2 16 7 2 2 17 External Peripheral Interface EPI EPINonBlockingReadAvail Get the count of items available in the read FIFO Prototype unsigned long EPINonBlockingReadAvail unsigned long ulBase Parameters ulBase is the EPI module base address Description This function
329. lication must set extra flags in the u Flags parameter The USB_EP_DMA_MODE_0 and USB_EP_DMA_MODE_1 control the mode of the transaction USB_EP_AUTO_CLEAR allows the data to be received automatically without needing to manually acknowledge that the data has been January 11 2011 353 USB Controller 354 read USB_EP_DMA_MODE_0 will not generate an interrupt when each packet is sent over USB and will only interrupt when the DMA transfer is complete USB_EP_DMA_MODE_1 will interrupt when the DMA transfer complete or a short packet is received This is useful for BULK endpoints that may not have prior knowledge of how much data is being received USB_EP_AUTO_ CLEAR should normally be specified when using uDMA to prevent the need for application code to ac knowledge that the data has been read from the FIFO The example below configures endpoint 1 as a Device mode Bulk OUT endpoint using DMA mode 1 with a max packet size of 64 bytes Example Configure endpoint 1 receive channel Endpoint 1 is a device mode BULK OUT endpoint using DMA USBDevEndpointConfigSet USBO_BASE USB_EP_1 64 USB_EP_DEV_OUT USB_EP_MODE_BULK USB_EP_DMA_MODE_1 USB_EP_AUTO_CLEAR Next the configuration of the actual UDMA controller is needed Like the transmit case the first a call to DMAChannelAttributeClear is made to clear any previous settings This is followed by a call to DMAChannelAttributeSet with the DMA_CONFIG_USEBURST value Note
330. liminate the reduction of the sample sequence depth By increasing the ADC trigger rate by 4x for example and averaging four trig gers worth of data 4x oversampling is achieved without any loss of sample sequence capability In this case an increase in the number of ADC triggers and presumably ADC interrupts is the consequence Since this requires adjustments outside of the ADC driver itself this is not directly supported by the driver though nothing in the driver prevents it The software oversampling APIs should not be used in this case This driver is contained in driverlib adc c with driverlib adc h containing the API defi nitions for use by applications January 11 2011 21 Analog to Digital Converter ADC 4 2 22 API Functions Functions void ADCComparatorConfigure unsigned long ulBase unsigned long ulComp unsigned long ulConfig void ADCComparator ntClear unsigned long ulBase unsigned long ulStatus void ADCComparator ntDisable unsigned long ulBase unsigned long ulSequenceNum void ADCComparator IntEnable unsigned long ulBase unsigned long ulSequenceNum unsigned long ADCComparatorIntStatus unsigned long ulBase void ADCComparatorRegionSet unsigned long ulBase unsigned long ulComp unsigned long ulLowRef unsigned long ulHighRef void ADCComparatorReset unsigned long ulBase unsigned long ulComp tBoolean bTrigger tBoolean blinterrupt void ADCHardwareOversampleConfigure unsigned long ulBase u
331. lled once to enable the controller uDMAControlBaseSet is called once to set the channel control table a uDMAChannelAttributeEnable is called once or infrequently to configure the behavior of the channel m uDMAChannelControlSet is used to set up characteristics of the data transfer It only needs to be called once if the nature of the data transfer does not change m uDMAChannelTransferSet is used to set the buffer pointers and size for a transfer It is called before each new transfer m uDMAChannelEnable enables a channel to perform data transfers m uDMAChannelRequesi is used to initiate a software based transfer This is normally not used for peripheral based transfers In order to use the UDMA controller you must first enable it by calling uUDMAEnable You can later disable it if no longer needed by calling UDMADisable Once the uDMA controller is enabled you must tell it where to find the channel control structures in system memory This is done by using the function UDMAControlBaseSet and passing a pointer to the base of the channel control structure The control structure must be allocated by the application One way to do this is to declare an array of data type char or unsigned char In order to support all channels and transfer modes the control table array should be 1024 bytes but it can be fewer depending on transfer modes used and number of channels actually used Note The control table must be ali
332. long ulGroup void PWMGenFaultTriggerSet unsigned long ulBase unsigned long ulGen unsigned long ulGroup unsigned long ulFaultTriggers void PWMGenIntClear unsigned long ulBase unsigned long ulGen unsigned long ullnts m void PWMGenintRegister unsigned long ulBase unsigned long ulGen void pfnIntHandler void unsigned long PWMGenlntStatus unsigned long ulBase unsigned long ulGen tBoolean bMasked void PWMGenIntTrigDisable unsigned long ulBase unsigned long ulGen unsigned long ullnt Trig void PWMGenlntTrigEnable unsigned long ulBase unsigned long ulGen unsigned long ullnt Trig void PWMGenIntUnregister unsigned long ulBase unsigned long ulGen unsigned long PWMGerPeriodGet unsigned long ulBase unsigned long ulGen void PWMGenPeriodSet unsigned long ulBase unsigned long ulGen unsigned long ulPeriod void PWMintDisable unsigned long ulBase unsigned long ulGenFault void PWMintEnable unsigned long ulBase unsigned long ulGenFault unsigned long PWMIntStatus unsigned long ulBase tBoolean bMasked void PWMOutputFault unsigned long ulBase unsigned long ulPWMOutBits tBoolean bFault Suppress void PWMOuitputFaultLevel unsigned long ulBase unsigned long ulPWMOutBits tBoolean bDriveHigh void PWMOuiputinvert unsigned long ulBase unsigned long ulPWMOutBits tBoolean bln vert void PWMOuiputState unsigned long ulBase unsigned long ulPWMOutBits tBoolean bEn able unsigned long PWMPulseWidt
333. lution if required In either mode the input signals can be swapped before being processed this allows wiring mistakes on the circuit board to be corrected without modifying the board The index pulse can be used to reset the position counter this causes the position counter to maintain the absolute encoder position Otherwise the position counter maintains the relative position and is never reset The velocity capture has a timer to measure equal periods of time The number of encoder pulses over each time period is accumulated as a measure of the encoder velocity The running total for the current time period and the final count for the previous time period are available to be read The final count for the previous time period is usually used as the velocity measure The QEI module will generate interrupts when the index pulse is detected when the velocity timer expires when the encoder direction changes and when a phase signal error is detected These interrupt sources can be individually masked so that only the events of interest cause a processor interrupt This driver is contained in driverlib qei c with driverlib gei h containing the API defi nitions for use by applications January 11 2011 237 Quadrature Encoder QE 17 2 17 2 1 17 2 2 17 2 2 1 238 API Functions Functions void QElIConfigure unsigned long ulBase unsigned long ulConfig unsigned long ulMaxPosi tion long QEI DirectionGet unsigned l
334. ly the mono sample is still treated as a sample pair so a single mono sample counts as 2 Since the FIFO always deals with sample pairs normally the level will be an even number from 0 to 16 If dual stereo mode is used and only the left sample has been read without reading the matching right sample then the FIFO level will be an odd value If the FIFO level is odd it indicates a left right sample mismatch Returns Returns the number of samples in the transmit FIFO which will normally be an even number 12 2 2 14 l2SRxFIFOLimitGet Gets the current setting of the FIFO service request level Prototype unsigned long I2SRxFIFOLimitGet unsigned long ulBase Parameters ulBase is the I2S module base address Description This function is used to get the value of the receive FIFO service request level This value is set using the I2SRxFIFOLimitSet function Returns Returns the current value of the FIFO service request limit January 11 2011 177 Inter IC Sound 12S 12 2 2 15 I2SRxFIFOLimitSet Sets the FIFO level at which a service request is generated Prototype void I2SRxFIFOLimitSet unsigned long ulBase unsigned long ulLevel Parameters ulBase is the I2S module base address ulLevel is the FIFO service request limit Description This function is used to set the receive FIFO fullness level at which a service request will occur The service request is used to generate an interrupt or a DMA tran
335. m void PinTypeUSBDigital unsigned long ulName Detailed Description The peripheral pin mapping functions require that the part being used be specified by a define of the PART_LM3Sxxx form The xxx portion is replaced with the part number of the part being used for example if using the LM3S6965 microcontroller the define will be PART_LM3S6965 This must be defined before pin_map h is included by the source code Function Documentation PeripheralEnable Enables the peripheral port used by the given pin Prototype void PeripheralEnable unsigned long ulName Parameters ulName is one of the valid names for a pin Description This function takes one of the valid names for a pin function and enables the peripheral port for that pin depending on the part that is defined Any valid pin name can be used See also SysCtlPeripheralEnable in order to enable a single port when multiple pins are on the same port Returns None PinTypeADC Configures the specified ADC pin to function as an ADC pin Prototype void PinTypeADC unsigned long ulName Parameters ulName is one of the valid names for the ADC pins Description This function takes on of the valid names for an ADC pin and configures the pin for its ADC functionality depending on the part that is defined January 11 2011 Peripheral Pin Mapping The valid names for the pins are as follows ADCO ADC1 ADC2 ADC3 ADC4 ADC5 ADC6 or ADC7
336. mit FIFO is designed to support a single packet at a time After the packet has been written into the FIFO the transmit request bit must be set to enable the transmission of the packet Only after the packet has been transmitted can a new packet be written into the FIFO This function will simply check to see if a packet is in progress If so there is no space available in the transmit FIFO Returns Returns true if a space is available in the transmit FIFO and false otherwise Programming Example The following example shows how to use the this API to initialize the Ethernet controller to transmit and receive packets unsigned char pucMACAddress 6 unsigned char pucMyRxPacket unsigned char pucMyTxPacket unsigned long ulMyTxPacketLength Initialize the Ethernet controller for operation January 11 2011 January 11 2011 Ethernet InitExpClk ETH_BASE SysCt1lClockGet Configure the Ethernet controller for normal operation Enable TX Duplex Mode Enable TX Padding EthernetConfigSet ETH_BASE ETH_CFG_TX_DPLXEN ETH_CFG_TX_PADEN Program the MAC Address 01 23 45 67 89 AB pucMACAddress 0 0x01 pucMACAddress 1 0x23 pucMACAddress 2 0x45 pucMACAddress 3 0x67 pucMACAddress 4 0x89 pucMACAddress 5 OxAB EthernetMACAddrSet ETH_BASE pucMACAddress Enable the Ethernet controller EthernetEnable ETH_BASE is Send a p
337. must be aligned to the size of the region Each region also has access permissions Code execution can be allowed or disallowed for a region A region can be set for read only access read write access or no access for both privileged and user modes This can be used to set up an environment where only kernel or system code can access certain hardware registers or sections of code The MPU creates 8 sub regions within each region Any sub region or combination of sub regions can be disabled allowing creation of holes or complex overlaying regions with different permis sions The sub regions can also be used to create an unaligned beginning or ending of a region by disabling one or more of the leading or trailing sub regions Once the regions are defined and the MPU is enabled any access violation of a region will cause a memory management fault and the fault handler will be activated This driver is contained in driverlib mpu c with driverlib mpu h containing the API defi nitions for use by applications 14 2 API Functions Functions void MPUDisable void void MPUEnable unsigned long ulMPUConfig void MPUIntRegister void xpfnHandler void void MPUIntUnregister void unsigned long MPURegionCountGet void void MPURegionDisable unsigned long ulRegion void MPURegionEnable unsigned long ulRegion void MPURegionGet unsigned long ulRegion unsigned long xpulAddr unsigned long pulFlags void MPURegionSet unsigne
338. must also be enabled as before when using the analogue in each individual driver IntEnable is called by the driver and does not need to be call by the application Run time configuration of interrupts will add a small latency to the interrupt response time since the stacking operation a write to SRAM and the interrupt handler January 11 2011 187 Interrupt Controller NVIC 13 2 13 2 1 188 table fetch a read from SRAM must be performed sequentially Run time configuration of interrupt handlers requires that the interrupt handler table be placed on a 1 kB boundary in SRAM typically this would be at the beginning of SRAM Failure to do so will result in an incorrect vector address being fetched in response to an interrupt The vector table is in a section called vtable and should be placed appropriately with a linker script This driver is contained in driverlib interrupt c with driverlib interrupt h contain ing the API definitions for use by applications API Functions Functions void IntDisable unsigned long ullnterrupt void IntEnable unsigned long ullnterrupt tBoolean IntMasterDisable void tBoolean IntMasterEnable void void IntPendClear unsigned long ullnterrupt void IntPendSet unsigned long ullnterrupt long IntPriorityGet unsigned long ullnterrupt unsigned long IntPriorityGroupingGet void void IntPriorityGroupingSet unsigned long ulBits unsigned long IntPriorityMaskGet void void
339. must also be set up before DMA can be used with the SSI Returns None 18 2 2 10 SSIEnable Enables the synchronous serial interface Prototype void SSIEnable unsigned long ulBase Parameters ulBase specifies the SSI module base address Description This function enables operation of the synchronous serial interface The synchronous serial interface must be configured before it is enabled Returns None 18 2 2 11 SSllntClear Clears SSI interrupt sources January 11 2011 253 Synchronous Serial Interface SSI Prototype void SSIIntClear unsigned long ulBase unsigned long ullIntFlags Parameters ulBase specifies the SSI module base address ullntFlags is a bit mask of the interrupt sources to be cleared Description The specified SSI interrupt sources are cleared so that they no longer assert This function must be called in the interrupt handler to keep the interrupts from being recognized again immediately upon exit The ullntFlags parameter can consist of either or both the SSLRXTO and SSL_RXOR values Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure t
340. must be an even number from 0 to 16 The maximum value is 16 which will cause a service request when there is any room in the FIFO The minimum value is 0 which disables the service request Returns None 12 2 2 24 l2STxRxConfigSet Configures the I2S transmit and receive modules Prototype void I2STxRxConfigSet unsigned long ulBase unsigned long ulConfig Parameters ulBase is the I2S module base address ulConfig is the logical OR of the configuration options 182 January 11 2011 Inter IC Sound 12S Description This function is used to configure the options for the I2S transmit and receive channels with identical parameters The parameter u Config is the logical OR of the following options m 12S CONFIG_FORMAT_I2S for standard 12S format 128 CONFIG_FORMAT_LEFT_JUST for left justified format or 12S CONFIG_FORMAT_RIGHT_JUST for right justified format I2S CONFIG_SCLK_INVERT to invert the polarity of the serial bit clock m 12S CONFIG_MODE_DUAL for dual channel stereo 12S CONFIG_MODE_COMPACT_16 for 16 bit compact stereo mode 128 _CONFIG_MODE_COMPACT _8 for 8 bit compact stereo mode or 128 CONFIG_MODE_MONDO for single channel mono format m 12S CONFIG_CLK_MASTER or I2S_CONFIG_CLK_SLAVE to select whether the 12S transmitter is the clock master or slave m 12S CONFIG_SAMPLE_SIZE_32 24 20 16 or 8 to select the number of bits per sample m 12S CONFIG_WIRE_SIZE_32 24 20 16 or _8 to select the numb
341. n is used to disable UART DMA features that were enabled by UARTDMAEnable The specified UART DMA features are disabled The u DMAFlags parameter is the logical OR of any of the following values m UART_DMA_RxX disable DMA for receive m UART_DMA_TX disable DMA for transmit m UART_DMA_ERR_RXSTOP do not disable DMA receive on UART error Returns None 22 2 2 13 UARTDMAEnable 314 Enable UART DMA operation Prototype void UARTDMAEnable unsigned long ulBase unsigned long ulDMAFlags Parameters ulBase is the base address of the UART port January 11 2011 UART ulDMAFlags is a bit mask of the DMA features to enable Description The specified UART DMA features are enabled The UART can be configured to use DMA for transmit or receive and to disable receive if an error occurs The uIDMAFlags parameter is the logical OR of any of the following values m UART_DMA_RxX enable DMA for receive m UART_DMA_TX enable DMA for transmit m UART_DMA_ERR_RXSTOP disable DMA receive on UART error Note The uDMA controller must also be set up before DMA can be used with the UART Returns None 22 2 2 14 UARTEnable Enables transmitting and receiving Prototype void UARTEnable unsigned long ulBase Parameters ulBase is the base address of the UART port Description Sets the UARTEN TXE and RXE bits and enables the transmit and receive FIFOs Returns None 22 2 2 15 UARTEnabl
342. n of the pin s Description The analog to digital converter input pins must be properly configured to function correctly on DustDevil class devices This function provides the proper configuration for those pin s The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into an ADC input it only configures an ADC input pin for proper operation Returns None GPIOPinTypeCAN Configures pin s for use as a CAN device Prototype void GPIOPinTypeCAN unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The CAN pins must be properly configured for the CAN peripherals to function correctly This function provides a typical configuration for those pin s other configurations may work as well depending upon the board setup for example using the on chip pull ups January 11 2011 9 2 2 15 9 2 2 16 GPIO The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into a CAN pin it only configures a CAN pin for pr
343. n places the processor into sleep mode it will not return until the processor returns to run mode The peripherals that are enabled via SysCtlPeripheralSleepEnable continue to operate and can wake up the processor if automatic clock gating is enabled with SysCtlPe ripheralClockGating otherwise all peripherals continue to operate Returns None 19 2 2 41 SysCtISRAMSizeGet Gets the size of the SRAM Prototype unsigned long SysCt1SRAMSizeGet void Description This function determines the size of the SRAM on the Stellaris device Returns The total number of bytes of SRAM 19 2 2 42 SysCtlUSBPLLDisable Powers down the USB PLL Prototype void SysCtlUSBPLLDisable void Description This function will disable the USB controller s PLL which is used by it s physical layer The USB registers are still accessible but the physical layer will no longer function Returns None 19 2 2 43 SysCtlUSBPLLEnable Powers up the USB PLL 282 January 11 2011 Prototype void System Control SysCt LUSBPLLEnable void Description This function will enable the USB controllers PLL which is used by it s physical layer This call is necessary before connecting to any external devices Returns 19 3 None Programming Example The following example shows how to use the SysCtl API to configure the device for normal opera tion January 11 2011 Configure the device to run
344. n this variable The other is DISABLE_NAK_LIMIT which indicates that there should be no limit on the number of NAKs The USB_EP_DMA_MODE_ flags enables the type of DMA used to access the endpoint s data FIFOs The choice of the DMA mode depends on how the DMA controller is configured and how it is being used See the Using USB with the uDMA Controller section for more information on DMA configuration When configuring the OUT portion of an endpoint the USB_EP_AUTO_SET bit is specified to cause the transmission of data on the USB bus to start as soon as the number of bytes specified by u MaxPayload have been written into the OUT FIFO for this endpoint When configuring the IN portion of an endpoint the USB_EP_AUTO_REQUEST bit can be specified to trigger the request for more data once the FIFO has been drained enough to fit ulMaxPayload bytes The USB_EP_AUTO_CLEAR bit can be used to clear the data packet ready flag automatically once the data has been read from the FIFO If this is not used this flag must be manually cleared via a call to USBDevEndpointStatusClear or USBHostEnd pointStatusClear Note This function should only be called in host mode Returns None 24 3 2 29 USBHostEndpointDataAck Acknowledge that data was read from the given endpoint s FIFO in host mode 374 January 11 2011 USB Controller Prototype void USBHostEndpointDataAck unsigned long ulBase unsigned long ulEndpoint
345. nction multiple times Until it is changed the EPI module will remember the last address that was used for a non blocking read per channel Returns None January 11 2011 97 External Peripheral Interface EPI 7 2 2 18 7 2 2 19 7 2 2 20 98 EPINonBlockingReadCount Get the count remaining for a non blocking transaction Prototype unsigned long EPINonBlockingReadCount unsigned long ulBase unsigned long ulChannel Parameters ulBase is the EPI module base address ulChannel is the read channel 0 or 1 Description This function gets the remaining count of items for a non blocking read transaction Returns The number of items remaining in the non blocking read transaction EPINonBlockingReadGet16 Read available data from the read FIFO as 16 bit data items Prototype unsigned long EPINonBlockingReadGet16 unsigned long ulBase unsigned long ulCount unsigned short pusBuf Parameters ulBase is the EPI module base address ulCount is the maximum count of items to read pusBuf is the caller supplied buffer where the read data should be stored Description This function reads 16 bit data items from the read FIFO and stores the values in a caller supplied buffer The function will read and store data from the FIFO until there is no more data in the FIFO or the maximum count is reached as specified in the parameter u Count The actual count of items will be returned Returns The number
346. nction reads the current value of the specified timer Returns Returns the current value of the timer Programming Example The following example shows how to use the timer API to configure the timer as a 16 bit one shot timer and a 16 bit edge capture counter Configure TimerA as a 16 bit one shot timer and TimerB as a 16 bit edge capture counter January 11 2011 Timer TimerConfigure TIMERO_BASE TIMER_CFG_16_BIT_PAIR TIMER_CFG_A_ONE_SHOT TIMER_CFG_B_CAP_COUNT Configure the counter TimerB to count both edges TimerControlEvent TIMERO_BASE TIMER_B TIMER_EVENT_BOTH_EDGES Enable the timers TimerEnable TIMERO_BASE TIMER_BOTH January 11 2011 305 Timer 306 January 11 2011 22 22 1 22 2 UART UART a rere ME Te 2238 E E taba EEES E S S E E E EE OEA ee bones T E E A ET 307 APURO HONS saae naaa cede Ged oR So aa al gd cep be GPa weighs tenho dD Gia abs 307 Programing Example nce ctaucicaoiiin othaecedudetacedsus eens i a ae he e Ea ese eeeee 327 Introduction The Universal Asynchronous Receiver Transmitter UART API provides a set of functions for using the Stellaris UART modules Functions are provided to configure and control the UART modules to send and receive data and to manage interrupts for the UART modules The Stellaris UART performs the functions of parallel to serial and serial to parallel conversions It is very similar in functi
347. ndler is a pointer to the function to be called when the comparator interrupt occurs Description This sets the handler to be called when the comparator interrupt occurs and enables the in terrupt in the interrupt controller It is the interrupt handler s responsibility to clear the interrupt source via ComparatorIntClear See also IntRegister for important information about registering interrupt handlers Returns None January 11 2011 3 2 2 6 3 2 2 7 3 2 2 8 Analog Comparator ComparatorIntStatus Gets the current interrupt status Prototype tBoolean ComparatoriIntStatus unsigned long ulBase unsigned long ulComp tBoolean bMasked Parameters ulBase is the base address of the comparator module ulComp is the index of the comparator bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required Description This returns the interrupt status for the comparator Either the raw or the masked interrupt status can be returned Returns true if the interrupt is asserted and false if it is not asserted ComparatorIntUnregister Unregisters an interrupt handler for a comparator interrupt Prototype void ComparatoriIntUnregister unsigned long ulBase unsigned long ulComp Parameters ulBase is the base address of the comparator module ulComp is the index of the comparator Description This function clears the handler to be
348. ne of the configured wake conditions occurs such as RTC match or external WAKE pin When the power is restored the processor will go through a normal power on reset The processor can retrieve saved state information with the HibernateDataGet function Prior to calling the function to request hibernation mode the conditions for waking must have already been set by using the Hiber nateWakeSet function Note that this function may return because some time may elapse before the power is actually removed or it may not be removed at all For this reason the processor will continue to execute instructions for some time and the caller should be prepared for this function to return There are various reasons why the power may not be removed For example if the HibernateLow BatSet function was used to configure an abort if low battery is detected then the power will not be removed if the battery voltage is too low There may be other reasons related to the external circuit design that a request for hibernation may not actually occur For all these reasons the caller must be prepared for this function to return The simplest way to handle it is to just enter an infinite loop and wait for the power to be removed Returns None 10 2 2 16 HibernateRTCDisable Disables the RTC feature of the Hibernation module January 11 2011 143 Hibernation Module Prototype void HibernateRTCDisable void Description Disables the RTC
349. ned long ulBase unsigned long ulTimer void xpfnHandler void unsigned long TimerlIntStatus unsigned long ulBase tBoolean bMasked void TimerlntUnregister unsigned long ulBase unsigned long ulTimer unsigned long TimerLoadGet unsigned long ulBase unsigned long ulTimer void TimerLoadSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue unsigned long TimerMatchGet unsigned long ulBase unsigned long ulTimer void TimerMatchSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue unsigned long TimerPrescaleGet unsigned long ulBase unsigned long ulTimer unsigned long TimerPrescaleMatchGet unsigned long ulBase unsigned long ulTimer void TimerPrescaleMatchSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue void TimerPrescaleSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue void TimerRTCDisable unsigned long ulBase void TimerRTCEnable unsigned long ulBase unsigned long TimerValueGet unsigned long ulBase unsigned long ulTimer Detailed Description The timer API is broken into three groups of functions those that deal with timer configuration and control those that deal with timer contents and those that deal with interrupt handling Timer configuration is handled by TimerConfigure which performs the high level setup of the timer module that is it is used to set up 32 or 16 bit modes and to select between PWM capture and timer operatio
350. nfigure the interface when used in Host bus 8 operation as cho sen with the function EPIModeSet The parameter u Config is the logical OR of any of the following one of EPI_HB8_ MODE_ADMUX EPI_HB8_ MODE_ADDEMUX EPI_HB8 MODE_SRAM or EPl_HB8_MODE_FIFO to select the HB8 mode EPI_HB8_USE_TXEMPTY enable TXEMPTY signal with FIFO EPI_HB8 USE _RXFULL enable RXFULL signal with FIFO EPI_HB8_WRHIGH use active high write strobe otherwise it is active low EPI_HB8_RDHIGH use active high read strobe otherwise it is active low one of EPI_HB8 WRWAIT_0 EPI_HB8 WRWAIT_1 EPIHB8 WRWAIT_2 or EPIl_HB8 WRWAIT_3 to select the number of write wait states default is 0 wait states one of EPI_HB8 _RDWAIT_0 EPIHB8_RDWAIT_1 EPI_HB8_RDWAIT_2 or EPI_HB8 RDWAIT_3 to select the number of read wait states default is O wait states EPI_HB8 WORD_ACCESS use Word Access mode to route bytes to the correct byte lanes allowing data to be stored in bits 31 8 If absent all data transfers use bits 7 0 EPI_HB8 CSBAUD_DUAL use different baud rates when accessing devices on each CSn CSOn uses the baud rate specified by the lower 16 bits of the divider passed to EP DividerSet and CS1n uses the divider passed in the upper 16 bits If this option is January 11 2011 External Peripheral Interface EP absent both chip selects use the baud rate resulting from the divider in the lower 16 bits of the parameter passed to EP DividerSet one of EPI_HB8_CSC
351. ng the flash those that deal with flash protection and those that deal with interrupt handling Flash programming is managed with FlashErase FlashProgram FlashUsecGet and FlashUsecSet Flash protection is managed with FlashProtectGet FlashProtectSet and FlashProtectSave Interrupt handling is managed with FlashIntRegister FlashIntUnregister FlashIntEnable FlashIntDisable FlashIntGetStatus and FlashIntClear Function Documentation FlashErase Erases a block of flash Prototype long FlashErase unsigned long ulAddress Parameters ulAddress is the start address of the flash block to be erased Description This function will erase a 1 kB block of the on chip flash After erasing the block will be filled with OxFF bytes Read only and execute only blocks cannot be erased This function will not return until the block has been erased Returns Returns 0 on success or 1 if an invalid block address was specified or the block is write protected January 11 2011 8 2 2 2 8 2 2 3 8 2 2 4 Flash FlashIntClear Clears flash controller interrupt sources Prototype void FlashIntClear unsigned long ulIntFlags Parameters ullntFlags is the bit mask of the interrupt sources to be cleared Can be any of the FLASH_INT_PROGRAM or FLASH_INT_AMISC values Description The specified flash controller interrupt sources are cleared so that they no longer assert This mus
352. ng ulBase unsigned long ullntFlags void I2SIntEnable unsigned long ulBase unsigned long ullntFlags void I2SIntRegister unsigned long ulBase void pfnHandler void unsigned long 2SIntStatus unsigned long ulBase tBoolean bMasked void I2SIntUnregister unsigned long ulBase void 2SMasterClockSelect unsigned long ulBase unsigned long ulMClock January 11 2011 169 Inter IC Sound 12S 12 2 1 170 m void I2SRxConfigSet unsigned long ulBase unsigned long ulConfig void I2SRxDataGet unsigned long ulBase unsigned long xpulData long 12SRxDataGetNonBlocking unsigned long ulBase unsigned long pulData void I2SRxDisable unsigned long ulBase void I2SRxEnable unsigned long ulBase unsigned long I2SRxFIFOLevelGet unsigned long ulBase unsigned long I2SRxFIFOLimitGet unsigned long ulBase void I2SRxFIFOLimitSet unsigned long ulBase unsigned long ulLevel void I2STxConfigSet unsigned long ulBase unsigned long ulConfig void I2STxDataPut unsigned long ulBase unsigned long ulData long l2STxDataPutNonBlocking unsigned long ulBase unsigned long ulData void I2STxDisable unsigned long ulBase void I2STxEnable unsigned long ulBase unsigned long 2STxFIFOLevelGet unsigned long ulBase unsigned long I2STxFIFOLimitGet unsigned long ulBase void I2STxFIFOLimitSet unsigned long ulBase unsigned long ulLevel void I2STxRxConfigSet unsigned long ulBase unsigned long ulConfig void I2STxRxDisable uns
353. ngReadCount unsigned long ulBase unsigned long ulChannel unsigned long EPINonBlockingReadGet16 unsigned long ulBase unsigned long ulCount un signed short pusBuf m unsigned long EPINonBlockingReadGet32 unsigned long ulBase unsigned long ulCount un signed long pulBuf m unsigned long EPINonBlockingReadGet8 unsigned long ulBase unsigned long ulCount un signed char pucBuf void EPINonBlockingReadStart unsigned long ulBase unsigned long ulChannel unsigned long ulCount void EPINonBlockingReadStop unsigned long ulBase unsigned long ulChannel unsigned long EP WriteFlFOCountGet unsigned long ulBase Detailed Description The function EPIModeSet is used to select the interface mode The clock divider is set with the EPIDividerSet function which will determine the speed of the external bus The external device is mapped into the processor memory or peripheral space using the EPIAddressMapSet function Once the mode is selected the interface is configured with one of the configuration functions If SDRAM mode was chosen the the function EPIConfigSDRAMSet is used to configure the SDRAM interface If anon moded interface was selected then the function EPIConfigNoModeSet should be used After the mode has been selected and configured then the device can be accessed by read ing and writing to the memory or peripheral address space that was programmed with EPIAd dressMapSet There are more sophisticated wa
354. ns Timer control is performed by TimerEnable TimerDisable TimerCon trolLevel TimerControlTrigger TimerControlEvent TimerControlStall TimerRTCEnable and TimerRTCDisable Timer content is managed with TimerLoadSet TimerLoadGet TimerPrescaleSet TimerPrescaleGet TimerMatchSet TimerMatchGet TimerPrescaleMatchSet Timer PrescaleMatchGet and TimerValueGet The interrupt handler for the Timer interrupt is managed with TimerlntRegister and TimerlntUnreg ister The individual interrupt sources within the timer module are managed with Timer ntEnable Timer ntDisable TimerIntStatus and TimerlntClear The TimerQuiesce API from previous versions of the peripheral driver library has been depre cated SysCilPeripheralReset should be used instead to return the timer to its reset state January 11 2011 Timer 21 2 2 Function Documentation 21 2 2 1 TimerConfigure Configures the timer s Prototype void TimerConfigure unsigned long ulBase unsigned long ulConfig Parameters ulBase is the base address of the timer module ulConfig is the configuration for the timer Description This function configures the operating mode of the timer s The timer module is disabled before being configured and is left in the disabled state The configuration is specified in ulConfig as one of the following values TIMER_CFG_32_BIT_OS 32 bit one shot timer TIMER_CFG_32_BIT_OS_
355. nsigned long ul Config m void ComparatorintClear unsigned long ulBase unsigned long ulComp void ComparatorintDisable unsigned long ulBase unsigned long ulComp void ComparatorintEnable unsigned long ulBase unsigned long ulComp m void ComparatorintRegister unsigned long ulBase unsigned long ulComp void pfnHandler void tBoolean ComparatorIntStatus unsigned long ulBase unsigned long ulComp tBoolean bMasked m void ComparatorintUnregister unsigned long ulBase unsigned long ulComp m void ComparatorRefSet unsigned long ulBase unsigned long ulRef m tBoolean ComparatorValueGet unsigned long ulBase unsigned long ulComp Detailed Description The comparator API is fairly simple like the comparators themselves There are functions for configuring a comparator and reading its output ComparatorConfigure ComparatorRefSet and ComparatorValueGet and functions for dealing with an interrupt handler for the comparator Com paratorIntRegister ComparatorIntUnregister ComparatorIntEnable ComparatorIntDisable ComparatorIntStatus and ComparatorIntClear January 11 2011 13 Analog Comparator 3 2 2 3 2 2 1 14 Function Documentation ComparatorConfigure Configures a comparator Prototype void ComparatorConfigure unsigned long ulBase unsigned long ulComp unsigned long ulConfig Parameters ulBase is the base address of the comparator module ulComp is the index o
356. nsigned long ulBase unsigned long ulObjID tCANMsgObject pMsgObject tBoolean bClrPendingInt Parameters ulBase is the base address of the CAN controller ulObjID is the object number to read 1 32 pMsgObject points to a structure containing message object fields bCirPendingInt indicates whether an associated interrupt should be cleared January 11 2011 59 Controller Area Network CAN 5 2 5 16 60 Description This function is used to read the contents of one of the 32 message objects in the CAN con troller and return it to the caller The data returned is stored in the fields of the caller supplied structure pointed to by pMsgObject The data consists of all of the parts of a CAN message plus some control and status information Normally this is used to read a message object that has received and stored a CAN message with a certain identifier However this could also be used to read the contents of a message object in order to load the fields of the structure in case only part of the structure needs to be changed from a previous setting When using CANMessageGet all of the same fields of the structure are populated in the same way as when the CANMessageSet function is used with the following exceptions pMsgObject gt ulFlags MSG_OBJ_NEW_DATA indicates if this is new data since the last time it was read MSG_OBJ_DATA_LOST indicates that at least one message was received on this mes sage object and not
357. nsigned long ulEndpoint unsigned long ulAddr unsigned long ulFlags void USBHostMode unsigned long ulBase void USBHostPwrConfig unsigned long ulBase unsigned long ulFlags void USBHostPwrDisable unsigned long ulBase void USBHostPwrEnable unsigned long ulBase void USBHostPwrFaultDisable unsigned long ulBase void USBHostPwrFaultEnable unsigned long ulBase void USBHostRequestIN unsigned long ulBase unsigned long ulEndpoint void USBHostRequestStatus unsigned long ulBase void USBHostReset unsigned long ulBase tBoolean bStart void USBHostResume unsigned long ulBase tBoolean bStart unsigned long USBHostSpeedGet unsigned long ulBase void USBHostSuspend unsigned long ulBase void USBIntDisable unsigned long ulBase unsigned long ulFlags void USBIntDisableControl unsigned long ulBase unsigned long ulFlags void USBiIntDisableEndpoint unsigned long ulBase unsigned long ulFlags void USBIntEnable unsigned long ulBase unsigned long ulFlags void USBIntEnableControl unsigned long ulBase unsigned long ulFlags void USBIntEnableEndpoint unsigned long ulBase unsigned long ulFlags void USBintRegister unsigned long ulBase void xpfnHandler void unsigned long USBIntStatus unsigned long ulBase unsigned long USBIntStatusControl unsigned long ulBase unsigned long USBIntStatusEndpoint unsigned long ulBase void USBintUnregister unsigned long ulBase unsigned long USBModeGet unsigned long ulBase void US
358. nsigned long ulFactor void ADCIntClear unsigned long ulBase unsigned long ulSequenceNum void ADCIntDisable unsigned long ulBase unsigned long ulSequenceNum void ADCIntEnable unsigned long ulBase unsigned long ulSequenceNum void ADClintRegister unsigned long ulBase unsigned long ulSequenceNum void pfnHandler void unsigned long ADCIntStatus unsigned long ulBase unsigned long ulSequenceNum tBoolean bMasked void ADCIntUnregister unsigned long ulBase unsigned long ulSequenceNum unsigned long ADCPhaseDelayGet unsigned long ulBase void ADCPhaseDelaySet unsigned long ulBase unsigned long ulPhase void ADCProcessorTrigger unsigned long ulBase unsigned long ulSequenceNum unsigned long ADCReferenceGet unsigned long ulBase void ADCReferenceSet unsigned long ulBase unsigned long ulRef void ADCSequenceConfigure unsigned long ulBase unsigned long ulSequenceNum un signed long ulTrigger unsigned long ulPriority long ADCSequenceDataGet unsigned long ulBase unsigned long ulSequenceNum un signed long pulBuffer void ADCSequenceDisable unsigned long ulBase unsigned long ulSequenceNum void ADCSequenceEnable unsigned long ulBase unsigned long ulSequenceNum long ADCSequenceOverflow unsigned long ulBase unsigned long ulSequenceNum void ADCSequenceOverflowClear unsigned long ulBase unsigned long ulSequenceNum void ADCSequenceStepConfigure unsigned long ulBase unsigned long ulSequenceNum unsign
359. nterface EPI from the FIFO and into a buffer provided by the application These functions are EPINonBlock ingReadGet32 EPINonBlockingReadGet16 EPINonBlockingReadGet8 to read the data from the FIFO as 32 bit 16 bit or 8 bit data items The read FIFO and write transaction FIFO can be configured with the function EPIFIFOConfig This function is used to set the FIFO trigger levels and to enable error interrupts to be generated when a read or write is stalled Interrupts are enabled or disabled with the functions EPIIntEnable and EPlIntDisable The inter rupt status can be read by calling EPlintStatus If there is an error interrupt pending the cause of the error can be determined with the function EPlIntErrorStatus The error can then be cleared with EPlIIntErrorClear If dynamic interrupt registration is being used by the application then an EPI interrupt handler can be registered by calling EPlIntRegister This will load the interrupt handler s address into the vector table The handler can be removed with EPIIntUnregister Function Documentation EPlAddressMapSet Configures the address map for the external interface Prototype void EPIAddressMapSet unsigned long ulBase unsigned long ulMap Parameters ulBase is the EPI module base address ulMap is the address mapping configuration Description This function is used to configure the address mapping for the external interface Thi
360. nterrupt this means that the application needs to check to see what was the actual source of the interrupt It is possible that the USB interrupt does not indicate that the USB transfer was complete The interrupt could also have been caused by a short packet error or even a transmit complete This requires that the application check both receive cases to determine if this is related to receiving data on the endpoint Because the USB has no status bit indicating that the interrupt was due to a DMA complete the application must remember if a DMA transaction was in progress Example Interrupt handling with UDMA eh Get the current interrupt status ulStatus USBIntStatusEndpoint USBO_BASE if ulStatus amp USB_INTEP_DEV_OUT_1 Handle a short packet else if g_ulFlags amp EP1_DMA_OUT_PEND amp amp DMAChannelModeGet DMA_CHANNEL_USBEP1RX DMA _MODE_STOP Handle the DMA complete case Restart receive DMA if desired 24 3 API Functions Functions m unsigned long USBDevAddrGet unsigned long ulBase m void USBDevAddrSet unsigned long ulBase unsigned long ulAddress m void USBDevConnect unsigned long ulBase January 11 2011 355 USB Controller void USBDevDisconnect unsigned long ulBase m void USBDevEndpointConfigGet unsigned long ulBase unsigned long ulEndpoint unsigned long xpulMaxPacketSize unsigned long pulFlags void USBDevEnd
361. nterrupt in question pfnHandler is a pointer to the function to be called Description This function is used to specify the handler function to be called when the given interrupt is asserted to the processor When the interrupt occurs if it is enabled via IntEnable the handler function will be called in interrupt context Since the handler function can preempt other code care must be taken to protect memory or peripherals that are accessed by the handler and other non handler code Note The use of this function directly or indirectly via a peripheral driver interrupt register function moves the interrupt vector table from flash to SRAM Therefore care must be taken when linking the application to ensure that the SRAM vector table is located at the beginning of SRAM otherwise NVIC will not look in the correct portion of memory for the vector table it requires the vector table be on a 1 kB memory alignment Normally the SRAM vector table is so placed via the use of linker scripts See the discussion of compile time versus run time interrupt handler registration in the introduction to this chapter Returns None 13 2 2 14 IntUnregister 194 Unregisters the function to be called when an interrupt occurs Prototype void IntUnregister unsigned long ulInterrupt Parameters ullnterrupt specifies the interrupt in question Description This function is used to indicate that no handler should be called when the given
362. ntrol table that holds the alternate control structures for each channel Returns January 11 2011 Returns a pointer to the base address of the second half of the channel control table 345 uDMA Controller 23 2 3 16 uDMAControlBaseGet Gets the base address for the channel control table Prototype void x uDMACont rolBaseGet void Description This function gets the base address of the channel control table This table resides in system memory and holds control information for each UDMA channel Returns Returns a pointer to the base address of the channel control table 23 2 3 17 uDMAControlBaseSet Sets the base address for the channel control table Prototype void uDMAControlBaseSet void pControlTable Parameters pControlTable is a pointer to the 1024 byte aligned base address of the UDMA channel control table Description This function sets the base address of the channel control table This table resides in system memory and holds control information for each UDMA channel The table must be aligned on a 1024 byte boundary The base address must be set before any of the channel functions can be used The size of the channel control table depends on the number of UDMA channels and which transfer modes are used Refer to the introductory text and the microcontroller datasheet for more information about the channel control table Returns None 23 2 3 18 UDMADisable Disables the uDMA controller f
363. nts and the arbitration level for the UDMA controller Example Configure endpoint 1 transmit channel Set up the DMA for USB transmit DMAChannelAttributeClear DMA_CHANNEL_USBEP1TX DMA_CONFIG_ALL Enable uDMA burst mode DMAChannelAttributeSet DMA_CHANNEL_USBEP1TX DMA_CONFIG_USEBURST Data size is 8 bits and the source has a one byte increment Destination has no increment as it is a FIFO DMAChannelControlSet DMA_CHANNEL_USBEP1TX DMA_DATA_SIZE_8 DMA_ADDR_INC_8 DMA_ADDR_INC_NONE DMA_ARB_ 64 0 The next step is to actually start the UDMA transfer once the data is ready to be sent There are the only two calls that the application needs to call to start a new transfer Normally all of the previous January 11 2011 USB Controller uDMA configuration can stay the same The first call DMAChannelTransferSet resets the source and destination addresses for the DMA transfer and specifies how much data will be sent The next call DMAChannelEnable actually allows the DMA controller to begin requesting data Example Start the transfer of data on endpoint 1 Configure the address and size of the data to transfer bf DMAChannelTransferSet DMA_CHANNEL_USBEP1TX DMA_MODE_BASIC pData USBF IFOAddr USBO_BASE USB_EP_1 64 ff Start the transfer DMAChannelEnable DMA_CHANNEL_USBEP1TX Because the uDMA interrupt occurs on the same int
364. nuary 11 2011 53 Controller Area Network CAN 5 2 5 4 5 2 5 5 5 2 5 6 54 CANDisable Disables the CAN controller Prototype void CANDisable unsigned long ulBase Parameters ulBase is the base address of the CAN controller to disable Description Disables the CAN controller for message processing When disabled the controller will no longer automatically process data on the CAN bus The controller can be restarted by calling CANEnable The state of the CAN controller and the message objects in the controller are left as they were before this call was made Returns None CANEnable Enables the CAN controller Prototype void CANEnable unsigned long ulBase Parameters ulBase is the base address of the CAN controller to enable Description Enables the CAN controller for message processing Once enabled the controller will auto matically transmit any pending frames and process any received frames The controller can be stopped by calling CANDisable Prior to calling CANEnable CANInit should have been called to initialize the controller and the CAN bus clock should be configured by calling CAN BitTimingSet Returns None CANErrCntrGet Reads the CAN controller error counter register Prototype tBoolean CANErrCntrGet unsigned long ulBase unsigned long pulRxCount unsigned long xpulTxCount January 11 2011 Controller Area Network CAN Parameters
365. number of samples copied to the buffer ADCSequenceDisable Disables a sample sequence January 11 2011 4 2 2 23 4 2 2 24 Analog to Digital Converter ADC Prototype void ADCSequenceDisable unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description Prevents the specified sample sequence from being captured when its trigger is detected A sample sequence should be disabled before it is configured Returns None ADCSequenceEnable Enables a sample sequence Prototype void ADCSequenceEnable unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description Allows the specified sample sequence to be captured when its trigger is detected A sample sequence must be configured before it is enabled Returns None ADCSequenceOverflow Determines if a sample sequence overflow occurred Prototype long ADCSequenceOverflow unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description This determines if a sample sequence overflow has occurred This will happen if the captured samples are not read from the FIFO before the next trigger occurs January 11 2011 3
366. o do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None 18 2 2 12 SSllntDisable Disables individual SSI interrupt sources Prototype void SSIIntDisable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase specifies the SSI module base address ullntFlags is a bit mask of the interrupt sources to be disabled Description Disables the indicated SSI interrupt sources The ul ntFlags parameter can be any of the SSI_TXFF SSI_RXFF SSI_RXTO or SSI_RXOR values Returns None 18 2 2 13 SSllntEnable Enables individual SSI interrupt sources 254 January 11 2011 Synchronous Serial Interface SS Prototype void SSIIntEnable unsigned long ulBase unsigned long ullIntFlags Parameters ulBase specifies the SSI module base address ullntFlags is a bit mask of the interrupt sources to be enabled Description Enables the indicated SSI interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor The ullntFlags parameter can be any of the SSI_TXFF SSIL_RXFF SSI_RXTO or SSI_RXOR values Returns None 18 2 2 14 SSllntRegister Registers an interrupt handler for the synchronous serial interface Prototype void SSIIntRegister unsigned long ulBase void x pfnHandler void Param
367. o ee a ae Re a hs A Re ek el a ed a 330 Programming EXainple o e e e sera Pe eee kk ee ae PE ea Pe Hae ee 349 January 11 2011 Table of Contents 24 USB Controller lt en eta eee ee ee ee ee ee eee eee chee 351 A MUICRON s oe fe a eae ee oe ee ee ee ee Sw we TR Ree eae MR me eee 351 24 2 Using USB with the UDMA Controller a aa aaa ee 351 On API FONCIONS o rr ieee ae ke Oo ee RE ae ee eo ee ER ee eee 355 24 4 Programming Example 2 0 2 255646 46 ee eee De ee ee ee ee ee 391 29 Watchdog TIMO 2 ee ee ee ERA ee ee ERE eae ee ee 393 oy NYoducion o esea e we ee oe ee ee oo a eee a RS a R 393 Coe API FONOS bb eke hh a ale ee eee ee EES Ae ARE ee ae we whee 393 25 3 Frogramming Example lt eea Gh we a ee be be cc we a a ae 401 25 Usineihio RON no ed coe ce oe ae ee ee ee ER ee a ee 403 20 1 MOGUEIOM a teat nice wr de are Sie ae ee we a eee ace Gear oper gy er ah dete Gare ane 403 26 2 DBS Calle 222404 4id a0 be eee MER oe Oe ee ae Be eee 403 26 0 Mapped HOM Gallg 2442424050504 Hee BEEBE DEEL eRe ee eee bb bw awe 404 20A Pinch USGI oh fee ee A a oe ee ee Se ge Pea dw ded dae wwe es 405 at 6 6 BtOr Handling eserse ee a al ae Re ee Re aaa 407 IMPORTANT NOTICE 2 2 ee ee eee ee Eee ee ee ee eee ee 408 January 11 2011 5 Table of Contents 6 January 11 2011 Introduction 1 Introduction The Texas Instruments Stellaris Peripheral Driver Library is a set of drivers for accessing the peripherals found on the Stellaris fam
368. occurs Returns Returns flags indicating the configured wake conditions 10 2 2 27 HibernateWakeSet Configures the wake conditions for the Hibernation module Prototype void HibernateWakeSet unsigned long ulWakeFlags Parameters ulWakeFlags specifies which conditions should be used for waking Description Enables the conditions under which the Hibernation module will wake The u WakeFlags pa rameter is the logical OR of any combination of the following a HIBERNATE_WAKE PIN wake when the external wake pin is asserted a HIBERNATE_WAKE_RTC wake when one of the RTC matches occurs Returns None January 11 2011 147 Hibernation Module 10 3 Programming Example The following example shows how to determine if the processor reset is due to a wake from hiber nation and to restore saved state unsigned long ulStatus unsigned long ulNVData 64 Need to enable the hibernation peripheral after wake reset before using it SysCtlPeripheralEnable SYSCTL_PERIPH_HIBERNATE ifs Determine if the Hibernation module is active if HibernateIsActive Read the status to determine cause of wake ulStatus HibernateIntStatus false Test the status bits to see the cause if ulStatus amp HIBERNATE_INT_PIN_WAKE Wakeup was due to WAKE pin assertion if ulStatus amp HIBERNATE_INT_RTC_MATCH_0 Wakeup was due to RTC matchO register
369. on HIBERNATE_LOW_BAT_ABORT detect a low battery condition and abort hibernation if low battery is detected Returns Returns a value indicating the configured low battery detection 10 2 2 14 HibernateLowBatSet Configures the low battery detection Prototype void HibernateLowBatSet unsigned long ulLowBatFlags Parameters ulLowBatFlags specifies behavior of low battery detection 142 January 11 2011 Hibernation Module Description Enables the low battery detection and whether hibernation is allowed if a low battery is de tected If low battery detection is enabled then a low battery condition will be indicated in the raw interrupt status register and can also trigger an interrupt Optionally hibernation can be aborted if a low battery is detected The u LowBatFlags parameter is one of the following values HIBERNATE_LOW_BAT_DETECT detect a low battery condition HIBERNATE_LOW_BAT_ABORT detect a low battery condition and abort hibernation if low battery is detected Returns None 10 2 2 15 HibernateRequest Requests hibernation mode Prototype void HibernateRequest void Description This function requests the Hibernation module to disable the external regulator thus removing power from the processor and all peripherals The Hibernation module will remain powered from the battery or auxiliary power supply The Hibernation module will re enable the external regulator when o
370. on should only be called in host mode Returns None January 11 2011 379 USB Controller 24 3 2 38 USBHostPwrFaultDisable Disables power fault detection Prototype void USBHostPwrFaultDisable unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function disables power fault detection in the USB controller Note This function should only be called in host mode Returns None 24 3 2 39 USBHostPwrFaultEnable Enables power fault detection Prototype void USBHostPwrFaultEnable unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function enables power fault detection in the USB controller If the USBPFLT pin is not in use this function should not be used Note This function should only be called in host mode Returns None 24 3 2 40 USBHostRequestIN Schedules a request for an IN transaction on an endpoint in host mode Prototype void USBHostRequestIN unsigned long ulBase unsigned long ulEndpoint Parameters ulBase specifies the USB module base address 380 January 11 2011 24 3 2 41 USB Controller ulEndpoint is the endpoint to access Description This function will schedule a request for an IN transaction When the USB device being com municated with responds the data the data can be retrieved by calling USBEndpointDataGet or via a DMA transfer Note
371. onality to a 16C550 UART but is not register compatible Some of the features of the Stellaris UART are m A 16x12 bit receive FIFO and a 16x8 bit transmit FIFO m Programmable baud rate generator m Automatic generation and stripping of start stop and parity bits m Line break generation and detection m Programmable serial interface e 5 6 7 or 8 data bits e even odd stick or no parity bit generation and detection e 1 or 2 stop bit generation e baud rate generation from DC to processor clock 16 m IrDA serial IR SIR encoder decoder DMA interface This driver is contained in driverlib uart c with driverlib uart h containing the API definitions for use by applications API Functions Functions m void UARTBreakCtl unsigned long ulBase tBoolean bBreakState m Boolean UARTBusy unsigned long ulBase m long UARTCharGet unsigned long ulBase m long UARTCharGetNonBlocking unsigned long ulBase m void UARTCharPut unsigned long ulBase unsigned char ucData m tBoolean UARTCharPutNonBlocking unsigned long ulBase unsigned char ucData tBoolean UARTCharsAvail unsigned long ulBase m void UARTConfigGetExpClk unsigned long ulBase unsigned long uIUARTClk unsigned long pulBaud unsigned long xpulConfig January 11 2011 307 UART 22 2 1 308 void UARTConfigSetExpClk unsigned long ulBase unsigned long ulUARTClk unsigned long ulBaud unsigned long ulConfig void UART Disable unsigned long ulBase
372. one device s interrupt IN endpoint and another device s bulk OUT endpoint at the same time This effectively gives the application one dedicated control endpoint for IN or OUT control transactions on endpoint 0 and three IN endpoints and three OUT endpoints The USB controller has a configurable FIFOs in devices that have a USB device controller as well as those that have a host controller The overall size of the FIFO RAM is 4096 bytes It is important to note that the first 64 bytes of this memory are dedicated to endpoint 0 for control transactions The remaining 4032 bytes are configurable however the application desires The FIFO configuration is usually set at the beginning of the application and not modified once the USB controller is in use The FIFO configuration uses the USBFIFOConfig API to set the starting address and the size of the FIFOs that are dedicated to each endpoint Example FIFO Configuration 0 64 endpoint 0 IN OUT 64 bytes 64 576 endpoint 1 IN 512 bytes 576 1088 endpoint 1 OUT 512 bytes 1088 1600 endpoint 2 IN 512 bytes FIFO for endpoint 1 IN starts at address 64 and is 512 bytes in size USBFIFOConfig USBO_BASE USB_EP_1 64 USB_FIFO_SZ_512 USB_EP_DEV_IN if FIFO for endpoint 1 OUT starts at address 576 and is 512 bytes in size USBF IFOConfig USBO_BASE USB_EP_1 576 USB_FIFO_SZ_512 USB_EP_DEV_OUT FIFO for endpoint 2 IN starts at address 1088 and is 512 bytes
373. ong ulBase void QEI Disable unsigned long ulBase void QElEnable unsigned long ulBase tBoolean QEIErrorGet unsigned long ulBase void QElIntClear unsigned long ulBase unsigned long ullntFlags void QElIntDisable unsigned long ulBase unsigned long ullntFlags void QElIntEnable unsigned long ulBase unsigned long ullntFlags void QEllntRegister unsigned long ulBase void xpfnHandler void unsigned long QElIntStatus unsigned long ulBase tBoolean bMasked void QElIntUnregister unsigned long ulBase unsigned long QEIPositionGet unsigned long ulBase void QEIPositionSet unsigned long ulBase unsigned long ulPosition void QEIVelocityConfigure unsigned long ulBase unsigned long ulPreDiv unsigned long ulPeriod void QEIVelocityDisable unsigned long ulBase void QEIVelocityEnable unsigned long ulBase unsigned long QE VelocityGet unsigned long ulBase Detailed Description The quadrature encoder API is broken into three groups of functions those that deal with position capture those that deal with velocity capture and those that deal with interrupt handling The position capture is managed with QElEnable QEIDisable QEIConfigure and QEIPosi tionSet The positional information is retrieved with QEIPositionGet QEIDirectionGet and QEIErrorGet The velocity capture is managed with QElVelocityEnable QEIVelocityDisable and QE Velocity Configure The computed encoder velocity is retrieved with Q
374. ong ulBitRate unsigned long ulDataWidth Parameters ulBase specifies the SSI module base address ulSSICIk is the rate of the clock supplied to the SSI module ulProtocol specifies the data transfer protocol ulMode specifies the mode of operation ulBitRate specifies the clock rate ulDataWidth specifies number of bits transferred per frame Description January 11 2011 This function configures the synchronous serial interface It sets the SSI protocol mode of operation bit rate and data width The ulProtocol parameter defines the data frame format The u Protoco parameter can be one of the following values SSI_FRF_MOTO_MODE_0 SSI_FRF_MOTO_MODE_1 SSI_FRF_MOTO_MODE_2 SSI_FRF_MOTO_MODE_3 SSI_FRF_TI or SSI_FRF_NMW The Motorola frame formats imply the following polarity and phase configurations Polarity Phase Mode 0 0 SSI_FRF_MOTO_MODE_0 0 1 SSI_FRF_MOTO_MODE_1 1 0 SSI_FRF_MOTO_MODE_2 1 1 SSI_FRF_MOTO_MODE_3 The u Mode parameter defines the operating mode of the SSI module The SSI module can operate as a master or slave if a slave the SSI can be configured to disable output on its serial output line The u Mode parameter can be one of the following values SSL MODE_MASTER SSI_MODE_SLAVE or SSI_MODE_SLAVE_OD The u BitRate parameter defines the bit rate for the SSI This bit rate must satisfy the following clock ratio criteria a FSSI gt 2 x bit rate m
375. oper operation Returns None GPIOPinTypeComparator Configures pin s for use as an analog comparator input Prototype void GPIOPinTypeComparator unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The analog comparator input pins must be properly configured for the analog comparator to function correctly This function provides the proper configuration for those pin s The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into an analog comparator input it only configures an analog comparator pin for proper operation Returns None GPIOPinTypeEPI Configures pin s for use by the external peripheral interface Prototype void GPIOPinTypeEPI unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s January 11 2011 123 GPIO 9 2 2 17 9 2 2 18 124 Description The external peripheral interface pins must be properly configured for the external peripheral interface to function correctly This function provides a typica configuration for those pin s other configurations may w
376. or 30 seconds from now HibernateRTCMatchO0Set HibernateRTCGet 30 Clear any pending status ulStatus HibernateIntStatus 0 HibernateIntClear ulStatus Save the program state information The state information will be stored in the ulNVData array It is not necessary to save the full 64 words of data only as much as is actually needed by the program HibernateDataSet ulNVData 64 Configure to wake on RTC match HibernateWakeSet HIBERNATE_WAKE_RTC Request hibernation The following call may return since it takes a finite amount of time for power to be removed HibernateRequest Need a loop here to wait for the power to be removed Power will be removed while executing in this loop January 11 2011 149 Hibernation Module for The following example shows how to use the Hibernation module RTC to generate an interrupt at a certain time Handler for hibernate interrupts eh void HibernateHandler void unsigned long ulStatus Get the interrupt status and clear any pending interrupts ulStatus HibernateIntStatus 1 HibernateIntClear ulStatus Process the RTC match 0 interrupt if ulStatus amp HIBERNATE_INT_RTC_MATCH_0 RTC match 0 interrupt actions go here Main function int main void System initialization code
377. or the flash version of the API without having ifdef s in the code rom_map h provides an automatic mapping feature for accessing the ROM Similar to the ROM_Function APIs provided by rom h a set of MAP_Function APIs are provided If the function is available in ROM MAP_Function will simply call ROM_Function otherwise it will call Function In order to use the mapped ROM calls the following steps must be performed m Follow the above steps for including and using driverlib rom h m Include driverlib rom_map h Continuing the above example call MAP_GPIODirModeSet in the source code As in the direct ROM call method the choice of calling ROM versus the flash version is made at compile time The only APIs that are provided via the ROM mapping feature are ones that are available in the ROM which is not every API available in the peripheral driver library The following is an example of calling a function in shared code where the device in question is defined in the project file include driverlib rom h include driverlib rom_map h include driverlib systick h void SetupSysTick void MAP_SysTickPeriodSet 0x1000 Map_SysTickEnable When built for a device that does not have a ROM this is equivalent to include driverlib systick h void SetupSysTick void SysTickPeriodSet 0x1000 SysTickEnable January 11 2011 Using the ROM When built for a device that has a ROM however this i
378. or use Prototype void uDMADisable void Description This function disables the UDMA controller Once disabled the UDMA controller will not operate until re enabled with uUDMAEnable Returns None 346 January 11 2011 uDMA Controller 23 2 3 19 UDMAEnable Enables the UDMA controller for use Prototype void uDMAEnable void Description This function enables the UDMA controller The UDMA controller must be enabled before it can be configured and used Returns None 23 2 3 20 UDMAErrorStatusClear Clears the uDMA error interrupt Prototype void uDMAErrorStatusClear void Description This function clears a pending uDMA error interrupt It should be called from within the UDMA error interrupt handler to clear the interrupt Returns None 23 2 3 21 uUDMAErrorStatusGet Gets the uDMA error status Prototype unsigned long uDMAErrorStatusGet void Description This function returns the uDMA error status It should be called from within the uDMA error interrupt handler to determine if a UDMA error occurred Returns Returns non zero if a uDMA error is pending 23 2 3 22 uDMAIntRegister Registers an interrupt handler for the uDMA controller January 11 2011 347 uDMA Controller Prototype void uDMAIntRegister unsigned long ulIntChannel void pfnHandler void Parameters ullntChannel identifies which uDMA interrupt is to be registered pfnHandler is a
379. ork as well depending upon the board setup for exampe using the on chip pull ups The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into an external peripheral interface pin it only configures an external peripheral interface pin for proper operation Returns None GPIOPinTypeEthernetLED Configures pin s for use by the Ethernet peripheral as LED signals Prototype void GPIOPinTypeEthernet LED unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The Ethernet peripheral provides two signals that can be used to drive an LED e g for link status activity This function provides a typical configuration for the pins The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into an Ethernet LED pin it only configures an Ethernet LED pin for proper operation Returns None GPIOPinTypeGP OInput Configures pin s for use as GPIO inputs Prototype void GPIOPinTypeGPIOInput unsigned long ulPort
380. osition Prototype void QETPositionSet unsigned long ulBase unsigned long ulPosition Parameters ulBase is the base address of the quadrature encoder module ulPosition is the new position for the encoder Description This sets the current position of the encoder the encoder position will then be measured relative to this value Returns None 17 2 2 14 QEIVelocityConfigure Configures the velocity capture Prototype void QEIVelocityConfigure unsigned long ulBase unsigned long ulPreDiv unsigned long ulPeriod Parameters ulBase is the base address of the quadrature encoder module ulPreDiv specifies the predivider applied to the input quadrature signal before it is counted can be one of QEI_VELDIV_1 QEI_VELDIV_2 QEI_VELDIV_4 QEI_VELDIV 8 QEI_VELDIV_16 QEI_VELDIV_32 QEI_VELDIV_64 or QEI_VELDIV_128 ulPeriod specifies the number of clock ticks over which to measure the velocity must be non zero 244 January 11 2011 Quadrature Encoder QE Description This will configure the operation of the velocity capture portion of the quadrature encoder The position increment signal is predivided as specified by u PreDiv before being accumulated by the velocity capture The divided signal is accumulated over u Period system clock before being saved and resetting the accumulator Returns None 17 2 2 15 QEIVelocityDisable Disables the velocity capture Prototyp
381. pe a ER eE Ee 246 Synchronous Serial Interface SSI aoaaa 247 MPO OUGION S o o coa a oa ce a a E EE eer E AEE E AO ce da oo ade ee 247 APIVPEONECUGIS aios ae ag ae ee dat be A E e a a a a aiaa 247 Programming Example gt s sasssa riterna be OSE SE a EEE REE S 256 Sysrem CONIO eaaa es aa aa ee ee ee ee ee a a ee a aa 259 IO OMCNON 2 524 bk he eh eae wR Rel We PA ee Se otek eee ER wv om Be Ale 259 PP PUIGRS hoe ou AA a ee eh ee a a dan 260 Programming Example sess ssa pee Re Sew EES HEHE ER ewww eda ke eh es 283 Syste DICK SYSTIR aa re r ele Se ee ee Ce ee ee eee eee we 285 WACO a ketenes ie te ete ee Goh G ee eR a eee ae ee ee Ee SOS BR 285 PP UPUTIONS ara t a ek Se ae BS ed a a at bo a ds Dh e ew eee 285 Programming Example gt esssssa ita eaea eea E eE a A 289 DRE a aa eee a a Baccano seca a a a eee ee ta Me Gd E AA Ge 291 POCONO o oo dk ai he a a Qe a eR ee a ee e i d i RR A a a Os 291 APIPONGIOOS ooi a a ee ee a a a a eR a 291 Frogramming Example 22 240806446 Pewee ee eG P84 EE aR eww ES EERE 304 DD ees see a ese Bh sa BS a ee ER ee eed amp Be die She aS 307 MOOO RON a 6 Gb inte ee ee ke ee ee a Pea a ee eek Bed KE SOS RRs 307 APIEONCIONS 6 558 sa eS Se ee ee bd a ore a E a a aa a R I AST 307 Frogamming Example gt s sessa rieren ee eS ESR ERAR 327 UDMA COn er dace 6 oo eS Sl aa ie ee A ee eS aS 329 WOON co i ong deck ack eon aa a a Wire o Stel a a ed te apts wae Gwe amp Gt Gh A Gane Mt le bec 329 POP PUIG h
382. pisew ed camcagemeeeribagenrecEsepesarsouquanecseebedeanoeemandas 168 11 1 Introduction The Inter Integrated Circuit 12C API provides a set of functions for using the Stellaris 12C master and slave modules Functions are provided to initialize the I2C modules to send and receive data obtain status and to manage interrupts for the 12C modules The I2C master and slave modules provide the ability to communicate to other IC devices over an I2C bus The I2C bus is specified to support devices that can both transmit and receive write and read data Also devices on the I2C bus can be designated as either a master or a slave The Stellaris 12C modules support both sending and receiving data as either a master or a slave and also support the simultaneous operation as both a master and a slave Finally the Stellaris 12C modules can operate at two speeds Standard 100 kb s and Fast 400 kb s Both the master and slave I2C modules can generate interrupts The I2C master module will generate interrupts when a transmit or receive operation is completed or aborted due to an error The 12C slave module will generate interrupts when data has been sent or requested by a master 11 1 1 Master Operations When using this API to drive the I2C master module the user must first initialize the 12C master module with a call to 12CMasterlInitExpClk That function will set the bus speed and enable the master module The user may transmit or receive data
383. pointConfigSet unsigned long ulBase unsigned long ulEndpoint unsigned long ulMaxPacketSize unsigned long ulFlags void USBDevEndpointDataAck unsigned long ulBase unsigned long ulEndpoint tBoolean blsLastPacket void USBDevEndpointStall unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags void USBDevEndpointStallClear unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags void USBDevEndpointStatusClear unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags void USBDevMode unsigned long ulBase unsigned long USBEndpointDataAvail unsigned long ulBase unsigned long ulEndpoint long USBEndpointDataGet unsigned long ulBase unsigned long ulEndpoint unsigned char pucData unsigned long xpulSize long USBEndpointDataPut unsigned long ulBase unsigned long ulEndpoint unsigned char pucData unsigned long ulSize long USBEndpointDataSend unsigned long ulBase unsigned long ulEndpoint unsigned long ulTransType void USBEndpointDataToggleClear unsigned long ulBase unsigned long ulEndpoint un signed long ulFlags void USBEndpointDMAChannel unsigned long ulBase unsigned long ulEndpoint unsigned long ulChannel void USBEndpointDMADisable unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags void USBEndpointDMAEnable unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags unsigned long USBEndpointStatus unsigned long ulBase unsigned long u
384. pplication know when to supply and transmit data back to the CAN controller that issued the re mote request for data The message type MSG_OBJ_TYPE_RXTX_REMOTE is similar to the MSG_OBJ_TYPE_RX_REMOTE except that it automatically responds with data that the applica tion placed in the message object The remaining information used to configure a CAN message object is contained in the tCANMs gObject structure which is used when calling CANMessageSet or will be filled by data read from the message object when calling CANMessageGet The CAN message identifier is simply stored into the ulMsgID member of the tCANMsgObject structure and is the 11 or 20 bit CAN identifier for this message object The ulMsg DMask is the mask is used in combination with the ulMsgID value to determine a match when the MSG_OBJ_USE_ID_FILTER flag is set for a message object The ulMsgIDMask is ignored if MSG_OBJ_USE_ID_FILTER flag is not set The last of the configuration parameters are specified in the ulFlags which are defined as a combination of the MSG_OBJ_ values The MSG_OBJ_TX_INT_ENABLE and MSG_OBJ_RX_INT_ENABLE flags will enable transmit complete or receive data interrupts If the CAN network is only using extended 20 bit identifiers then the MSG_OBJ_EXTENDED_ID flag should be specified The CANMessageSet function will force this flag set if the identifier is greater than an 11 bit identifier can hold The MSG_OBJ_USE_ID_FILTER is used to enable filtering
385. pport is available Returns None 22 2 2 38 UARTSpaceAvail Determines if there is any space in the transmit FIFO Prototype tBoolean UARTSpaceAvail unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function returns a flag indicating whether or not there is space available in the transmit FIFO Returns Returns true if there is space available in the transmit FIFO or false if there is no space available in the transmit FIFO 22 2 2 39 UARTTxintModeGet 326 Returns the current operating mode for the UART transmit interrupt Prototype unsigned long UARTTxIntModeGet unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function returns the current operating mode for the UART transmit interrupt The return value will be UART_TXINT_MODE_EOT if the transmit interrupt is currently set to be asserted once the transmitter is completely idle the transmit FIFO is empty and all bits including any stop bits have cleared the transmitter The return value will be UART_TXINT_MODE_FIFO if the interrupt is set to be asserted based upon the level of the transmit FIFO January 11 2011 UART Note The availability of end of transmission mode varies with the Stellaris part in use Please consult the datasheet for the part you are using to determine whether this support is available Returns Returns UART_TXINT_MODE_FIFO or UART_T
386. priority of an interrupt See IntPrioritySet for a definition of the priority value Returns Returns the interrupt priority or 1 if an invalid interrupt was specified 13 2 2 8 IntPriorityGroupingGet Gets the priority grouping of the interrupt controller Prototype unsigned long IntPriorityGroupingGet void January 11 2011 191 Interrupt Controller NVIC Description This function returns the split between preemptable priority levels and subpriority levels in the interrupt priority specification Returns The number of bits of preemptable priority 13 2 2 9 IntPriorityGroupingSet Sets the priority grouping of the interrupt controller Prototype void IntPriorityGroupingSet unsigned long ulBits Parameters ulBits specifies the number of bits of preemptable priority Description This function specifies the split between preemptable priority levels and subpriority levels in the interrupt priority specification The range of the grouping values are dependent upon the hardware implementation on the Stellaris family three bits are available for hardware interrupt prioritization and therefore priority grouping values of three through seven have the same effect Returns None 13 2 2 10 IntPriorityMaskGet Gets the priority masking level Prototype unsigned long IntPriorityMaskGet void Description This function gets the current setting of the interrupt priority masking level The value returned is
387. programmed using the EthernetMACAddrSet function this API function can be called to enable the controller for normal operation This function will enable the controllers transmitter and receiver and will reset the receive FIFO Returns None January 11 2011 6 2 2 5 6 2 2 6 Ethernet Controller EthernetinitExpClk Initializes the Ethernet controller for operation Prototype void Ethernet InitExpClk unsigned long ulBase unsigned long ulEthcClk Parameters ulBase is the base address of the controller ulEthClk is the rate of the clock supplied to the Ethernet module Description This function will prepare the Ethernet controller for first time use in a given hardware software configuration This function should be called before any other Ethernet API functions are called The peripheral clock will be the same as the processor clock This will be the value returned by SysCtlClockGet or it can be explicitly hard coded if it is constant and known to save the code execution overhead of a call to SysCtlClockGei This function replaces the original Ethernetlnit API and performs the same actions A macro is provided in ethernet h to map the original API to this API Note If the device configuration is changed for example the system clock is reprogrammed to a different speed then the Ethernet controller must be disabled by calling the EthernetDisable function and the controller must b
388. provides no tuning or frequency measurement mechanisn its frequency is not adjustable Almost the entire device operates from a single clock The ADC and PWM blocks have their own clocks In order to use the ADC the PLL must be used the PLL output will be used to create the clock required by the ADC The PWM has its own optional divider from the system clock this can be power of two divides between 1 and 64 Three modes of operation are supported by the Stellaris family run mode sleep mode and deep sleep mode In run mode the processor is actively executing code In sleep mode the clocking of the device is unchanged but the processor no longer executes code and is no longer clocked In deep sleep mode the clocking of the device may change depending upon the run mode clock configuration and the processor no longer executes code and is no longer clocked An interrupt will return the device to run mode from one of the sleep modes the sleep modes are entered upon request from the code The device has an internal LDO for generating the on chip 2 5 V power supply the output voltage of the LDO can be adjusted between 2 25 V and 2 75 V Depending upon the application lower voltage may be advantageous for its power savings or higher voltage may be advantageous for its improved performance The default setting of 2 5 V is a good compromise between the two and should not be changed without careful consideration and evaluation There are se
389. pucData parameter It will be set to the amount of data returned in the buffer Description This function will return the data from the FIFO for the given endpoint The pu Size parameter should indicate the size of the buffer passed in the pu Data parameter The data in the pulSize parameter will be changed to match the amount of data returned in the pucData parameter If a zero byte packet was received this call will not return a error but will instead just return a zero in the pulSize parameter The only error case occurs when there is no data packet available Returns This call will return O or 1 if no packet was received 24 3 2 14 USBEndpointDataPut Puts data into the given endpoint s FIFO Prototype long USBEndpointDataPut unsigned long ulBase unsigned long ulEndpoint unsigned char xpucData unsigned long ulSize Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access pucDaia is a pointer to the data area used as the source for the data to put into the FIFO ulSize is the amount of data to put into the FIFO Description This function will put the data from the pucData parameter into the FIFO for this endpoint If a packet is already pending for transmission then this call will not put any of the data into the FIFO and will return 1 Care should be taken to not write more data than can fit into the FIFO allocated by the call to USBFIFOContfig Returns T
390. r Prototype void SysCt110SCVerificationSet tBoolean bEnable Parameters bEnable is a boolean that is true if the internal oscillator verification timer should be enabled Description This function allows the internal oscillator verification timer to be enabled or disabled When enabled an interrupt will be generated if the internal oscillator ceases to operate The internal oscillator verification timer is only available on Sandstorm class devices Note Both oscillators main and internal must be enabled for this verification timer to operate as the main oscillator will verify the internal oscillator Returns None 270 January 11 2011 System Control 19 2 2 20 SysCtILDOConfigSet Configures the LDO failure control Prototype void SysCt1LDOConfigSet unsigned long ulConfig Parameters ulConfig is the required LDO failure control setting can be either SYSCTL_LDOCFG_ARST or SYSCTL_LDOCFG_NORST Description This function allows the LDO to be configured to cause a processor reset when the output voltage becomes unregulated The LDO failure control is only available on Sandstorm class devices Returns None 19 2 2 21 SysCtlLDOGet Gets the output voltage of the LDO Prototype unsigned long SysCt1LDOGet void Description This function determines the output voltage of the LDO as specified by the control register Returns Returns the current voltage of the LDO will be one of SYSCTL_L
391. r The application is not required to clear out a message object before setting it with a new configuration because each time CANMessageSet is called it will overwrite any previously programmed configuration The 32 message objects are identical except for priority The lowest numbered message objects have the highest priority Priority affects operation in two ways First if multiple actions are ready January 11 2011 43 Controller Area Network CAN 5 2 2 5 2 2 1 44 at the same time the one with the highest priority message object will occur first And second when multiple message objects have interrupts pending the highest priority will be presented first when reading the interrupt status It is up to the application to manage the 32 message objects as a resource and determine the best method for allocating and releasing them The CAN controller can generate interrupts on several conditions m When any message object transmits a message m When any message object receives a message On warning conditions such as an error counter reaching a limit or occurrence of various bus errors m On controller error conditions such as entering the bus off state An interrupt handler must be installed in order to process CAN interrupts If dynamic interrupt configuration is desired the CANIntRegister can be used to register the interrupt handler This will place the vector in a RAM based vector table However if the application
392. r 0 COMP_ASRCP_REF to use the internally generated voltage as the reference voltage The COMP_OUTPUT_xxx term can take on the following values COMP_OUTPUT_NORMAL to enable a non inverted output from the comparator to a device pin COMP_OUTPUT_INVERT to enable an inverted output from the comparator to a device pin January 11 2011 COMP_OUTPUT_NONE is deprecated COMP_OUTPUT_NORMAL Returns None 3 2 2 2 ComparatorintClear Clears a comparator interrupt Prototype void Analog Comparator and behaves the same as ComparatorIntClear unsigned long ulBase unsigned long ulComp Parameters ulBase is the base address of the comparator module ulComp is the index of the comparator Description The comparator interrupt is cleared so that it no longer asserts This fucntion must be called in the interrupt handler to keep the handler from being called again immediately upon exit Note that for a level triggered interrupt the interrupt cannot be cleared until it stops asserting Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrup
393. r PWM_OUT_7 BIT bEnable determines if the signal is enabled or disabled Description This function is used to enable or disable the selected PWM outputs The outputs are selected using the parameter u PWMOutBits The parameter bEnable determines the state of the se lected outputs If bEnable is true then the selected PWM outputs are enabled or placed in the active state If bEnable is false then the selected outputs are disabled or placed in the inactive state Returns None 16 2 2 30 PWMPulseWidthGet Gets the pulse width of a PWM output Prototype unsigned long PWMPulseWidthGet unsigned long ulBase unsigned long ulPWMOut Parameters ulBase is the base address of the PWM module ulPWMoOut is the PWM output to query Must be one of PWM_OUT_0 PWM_OUT_1 PWM_OUT_2 PWM_OUT_3 PWM_OUT_4 PWM_OUT_5 PWM_OUT 6 or PWM_OUT_7 Description This function gets the currently programmed pulse width for the specified PWM output If the update of the comparator for the specified output has yet to be completed the value returned may not be the active pulse width The value returned is the programmed pulse width mea sured in PWM clock ticks Returns Returns the width of the pulse in PWM clock ticks 16 2 2 31 PWMPulseWidthSet Sets the pulse width for the specified PWM output 234 January 11 2011 Pulse Width Modulator PWM Prototype void PWMPulseWidthSet unsigned long ulBase unsigned long ulPWMOut
394. r mode is a complex mode that provides a way to set up a list of trans fer tasks for the UDMA controller Blocks of data can be transferred to and from arbitrary locations in memory January 11 2011 329 uDMA Controller 23 2 330 Peripheral scatter gather mode is similar to memory scatter gather mode except that it is controlled by a peripheral request Detailed explanation of the various transfer modes is beyond the scope of this document Please refer to the device data sheet for more information on the operation of the UDMA controller The naming convention for the microDMA controller is to use the Greek letter mu to represent micro For the purposes of this document and in the software library function names a lower case u will be used in place of mu when the controller is referred to as UDMA This driver is contained in driverlib udma c with driverlib udma h containing the API definitions for use by applications API Functions Defines m uDMATaskSiructEntry ulTransferCount ulltemSize ulSrclncrement pvSrcAddr ulDstIncre ment pvDstAddr ulArbSize ulMode Functions void UDMAChannelAttributeDisable unsigned long ulChannelNum unsigned long ulAttr void UDMAChannelAttributeEnable unsigned long ulChannelNum unsigned long ulAttr unsigned long uUDMAChannelAttributeGet unsigned long ulChannelNum void UDMAChannelControlSet unsigned long ulChannelStructIndex unsigned long ulCon
395. ral clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None PWMFaultIntRegister Registers an interrupt handler for a fault condition detected in a PWM module Prototype void PWMFaultIntRegister unsigned long ulBase void pfniIntHandler void Parameters ulBase is the base address of the PWM module pfnintHandler is a pointer to the function to be called when the PWM fault interrupt occurs January 11 2011 219 Pulse Width Modulator PWM 16 2 2 6 16 2 2 7 220 Description This function will ensure that the interrupt handler specified by pfnintHandler is called when a fault interrupt is detected for the selected PWM module This function will also enable the PWM fault interrupt in the NVIC the PWM fault interrupt must also be enabled at the module level using PWMIntEnable See also IntRegister for important information about registering interrupt handlers Returns None PWMFaultIntUnregister Removes the PWM fault condition interrupt handler Prototype void PWMFaultIntUnregister unsigned long
396. ral driver library API This directory holds the part specific header files used for the direct register access programming model A set of definitions used by make files January 11 2011 2 2 1 2 2 Programming Model Programming Model ioe lc ee heer ee een Tet te eee cere eee Trent tree Cee aie a Tere ee eer eet eee Tee ek eee ee rene rere S 9 Direct Register Access Model sais chances pesaneniapriGanain kh borewivas OG0 Neda erada ei binae Enei 9 SOW OTIVEE INDO i035 cc E E A T A T T E T EA ET 10 Combining THEMOGES pniicancteneinnneeannmbinne REE E E EA E EED 11 Introduction The peripheral driver library provides support for two programming models the direct register ac cess model and the software driver model Each model can be used independently or combined based on the needs of the application or the programming environment desired by the developer Each programming model has advantages and disadvantages Use of the direct register access model generally results in smaller and more efficient code than using the software driver model However the direct register access model requires detailed knowledge of the operation of each register and bit field as well as their interactions and any sequencing required for proper opera tion of the peripheral the developer is insulated from these details by the software driver model generally requiring less time to develop applications Direct Register Access Model In the di
397. rameter u Config is the logical OR of several sets of choices The processor core frequency must be specified with one of the following EPlSDRAM_CORE_FREQ_0_15 core clock is 0 MHz lt clk lt 15 MHz EPI SDRAM_CORE_FREQ_15_30 core clock is 15 MHz lt clk lt 30 MHz EPI SDRAM_CORE_FREQ_30_50 core clock is 30 MHz lt clk lt 50 MHz EPI SDRAM_CORE_FREQ_50_100 core clock is 50 MHz lt clk lt 100 MHz The low power mode is specified with one of the following EPI SDRAM_LOW_POWER enter low power self refresh state EPlSDRAM_FULL_POWER normal operating state The SDRAM device size is specified with one of the following 91 External Peripheral Interface EP 7 2 2 6 7 2 2 1 92 EPI _SDRAM_SIZE_64MBIT 64 Mbit device 8 MB EPI_SDRAM_SIZE_128MBIT 128 Mbit device 16 MB EPI_SDRAM_SIZE_256MBIT 256 Mbit device 32 MB EPI_SDRAM_SIZE_512MBIT 512 Mbit device 64 MB The parameter u Refresh sets the refresh counter in units of core clock ticks It is an 11 bit value with a range of 0 2047 counts Returns None EPIDividerSet Sets the clock divider for the EPI module Prototype void EPIDividerSet unsigned long ulBase unsigned long ulDivider Parameters ulBase is the EPI module base address ulDivider is the value of the clock divider to be applied to the external interface 0 65535 Description This functions sets the clock divider s that w
398. rameters ulBase is the base address of the CAN controller bAutoRetry enables automatic retransmission Description Enables or disables automatic retransmission of messages with detected errors If bAutoRetry is true then automatic retransmission is enabled otherwise it is disabled Returns None CANStatusGet Reads one of the controller status registers Prototype unsigned long CANStatusGet unsigned long ulBase tCANStsReg eStatusReg Parameters ulBase is the base address of the CAN controller eStatusReg is the status register to read January 11 2011 Controller Area Network CAN Description Reads a status register of the CAN controller and returns it to the caller The different status registers are CAN STS CONTROL the main controller status CAN_STS_TXREQUEST bit mask of objects pending transmission CAN_STS_NEWDAT bit mask of objects with new data CAN_STS_MSGVAL bit mask of objects with valid configuration When reading the main controller status register a pending status interrupt will be cleared This should be used in the interrupt handler for the CAN controller if the cause is a status interrupt The controller status register fields are as follows m CAN STATUS BUS OFF controller is in bus off condition CAN_STATUS_EWARN an error counter has reached a limit of at least 96 CAN_STATUS_EPASS CAN controller is in the error passive state m CAN_STATUS_RXOK a message w
399. rameters ulBase is the base address of the timer module ulTimer specifies the timer s to be adjusted must be one of TIMER_A TIMER_B or TIMER_BOTH ulEvent specifies the type of event must be one of TIMER_EVENT_ POS EDGE TIMER_EVENT_NEG_EDGE or TIMER_EVENT_BOTH_EDGES Description This function sets the signal edge s that will trigger the timer when in capture mode Returns None TimerControlLevel Controls the output level Prototype void TimerControlLevel unsigned long ulBase unsigned long ulTimer tBoolean bInvert Parameters ulBase is the base address of the timer module ulTimer specifies the timer s to adjust must be one of TIMER_A TIMER_B or TIMER_BOTH binvert specifies the output level Description This function sets the PWM output level for the specified timer If the b nvert parameter is true then the timer s output will be made active low otherwise it will be made active high Returns None TimerControlStall Controls the stall handling January 11 2011 21 2 2 5 21 2 2 6 Timer Prototype void TimerControlStall unsigned long ulBase unsigned long ulTimer tBoolean bStall Parameters ulBase is the base address of the timer module ulTimer specifies the timer s to be adjusted must be one of TIMER_A TIMER_B or TIMER_BOTH bSiall specifies the response to a stall signal Description This function controls the stall response for the specified t
400. rect register access model the peripherals are programmed by the application by writing values directly into the peripheral s registers A set of macros is provided that simplifies this process These macros are stored in part specific header files contained in the inc directory the name of the header file matches the part number for example the header file for the LM3S6965 microcontroller is inc 1m3s6965 h By including the header file that matches the part being used macros are available for accessing all registers on that part as well as all bit fields within those registers No macros are available for registers that do not exist on the part in question making it difficult to access registers that do not exist The defines used by the direct register access model follow a naming convention that makes it easier to know how to use a particular macro The rules are as follows Values that end in _R are used to access the value of a register For example SSTO_CRO_R is used to access the CRO register in the SSIO module a Values that end in _M represent the mask for a multi bit field in a register If the value placed in the multi bit field is a number there is a macro with the same base name but ending with _s for example SSI_CRO_SCR_M and SSI_CRO_SCR_S If the value placed into the multi bit field is an enumeration then there are a set of macros with the same base name but ending with identifiers for the various enumeration values for
401. rence Prototype void ADCReferenceSet unsigned long ulBase unsigned long ulRef Parameters ulBase is the base address of the ADC module ulRef is the reference to use January 11 2011 Analog to Digital Converter ADC Description The ADC reference is set as specified by u Ref It must be one of ADC_REF_INT or ADC_REF_EXT_3V for internal or external reference If ADC_REF_INT is chosen then an internal 3V reference is used and no external reference is needed If ADC_REF_EXT_8V is chosen then a 3V reference must be supplied to the AVREF pin Note The ADC reference can only be selected on parts that have an external reference Consult the data sheet for your part to determine if there is an external reference Returns None 4 2 2 20 ADCSequenceConfigure Configures the trigger source and priority of a sample sequence Prototype void ADCSequenceConfigure unsigned long ulBase unsigned long ulSequenceNum unsigned long ulTrigger unsigned long ulPriority Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number ulTrigger is the trigger source that initiates the sample sequence must be one of the ADC_TRIGGER_ values ulPriority is the relative priority of the sample sequence with respect to the other sample sequences Description January 11 2011 This function configures the initiation criteria for a sample sequence
402. reviously stored with the HibernateDataSet function The caller must ensure that pu Data points to a large enough memory block to hold all the data that is read from the non volatile memory Returns None HibernateDataSet Stores data in the non volatile memory of the Hibernation module Prototype void HibernateDataSet unsigned long pulData unsigned long ulCount Parameters pulData points to the data that the caller wants to store in the memory of the Hibernation module ulCount is the count of 32 bit words to store Description Stores a set of data in the Hibernation module non volatile memory This memory will be pre served when the power to the processor is turned off and can be used to store application state information which will be available when the processor wakes Up to 64 32 bit words can be stored in the non volatile memory The data can be restored by calling the HibernateDataGet function Returns None HibernateDisable Disables the Hibernation module for operation Prototype void HibernateDisable void Description Disables the Hibernation module for operation After this function is called none of the Hiber nation module features are available Returns None January 11 2011 Hibernation Module 10 2 2 5 HibernateEnableExpClk Enables the Hibernation module for operation Prototype void HibernateEnableExpClk unsigned long ulHibClk Parameters ul
403. rify the main oscillator Returns None 19 2 2 24 SysCtlPeripheralClockGating Controls peripheral clock gating in sleep and deep sleep mode Prototype void SysCtlPeripheralClockGating tBoolean bEnable Parameters bEnable is a boolean that is true if the sleep and deep sleep peripheral configuration should be used and false if not Description This function controls how peripherals are clocked when the processor goes into sleep or deep sleep mode By default the peripherals are clocked the same as in run mode if peripheral clock gating is enabled they are clocked according to the configuration set by SysCtlPeriph eralSleepEnable SysCtlPeripheralSleepDisable SysCtlPeripheralDeepSleepEnable and SysCtlPeripheralDeepSleepDisable 272 January 11 2011 System Control Returns None 19 2 2 25 SysCtlPeripheralDeepSleepDisable Disables a peripheral in deep sleep mode Prototype void SysCt1lPeripheralDeepSleepDisable unsigned long ulPeripheral Parameters ulPeripheral is the peripheral to disable in deep sleep mode Description This function causes a peripheral to stop operating when the processor goes into deep sleep mode Disabling peripherals while in deep sleep mode helps to lower the current draw of the device and can keep peripherals that require a particular clock frequency from operating when the clock changes as a result of entering deep sleep mode If enabled via SysCtlP
404. rk CAN APIs provide a set of functions for accessing the Stellaris CAN modules Functions are provided to configure the CAN controllers configure message objects and manage CAN interrupts The Stellaris CAN module provides hardware processing of the CAN data link layer It can be configured with message filters and preloaded message data so that it can autonomously send and receive messages on the bus and notify the application accordingly It automatically handles generation and checking of CRCs error processing and retransmission of CAN messages The message objects are stored in the CAN controller and provide the main interface for the CAN module on the CAN bus There are 32 message objects that can each be programmed to handle a separate message ID or can be chained together for a sequence of frames with the same ID The message identifier filters provide masking that can be programmed to match any or all of the message ID bits and frame types This driver is contained in driverlib can c with driverlib can h containing the API defi nitions for use by applications API Functions Data Structures m tCANBitClkParms m tCANMsgObject Defines CAN_INT_ERROR m CAN_INT_MASTER m CAN_INT_STATUS CAN_STATUS_BUS_OFF m CAN_STATUS_EPASS m CAN_STATUS_EWARN m CAN_STATUS_LEC_ACK CAN_STATUS_LEC_BITO m CAN_STATUS_LEC_BIT1 CAN_STATUS_LEC_CRC January 11 2011 41 Controller Area Network CAN 42 CAN_STATUS_LEC_FORM CA
405. rns None GPIOPinTypeGP IOOutputOD Configures pin s for use as GPIO open drain outputs Prototype void GPIOPinTypeGPIOOutputOD unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port January 11 2011 125 GPIO 9 2 2 21 9 2 2 22 126 ucPins is the bit packed representation of the pin s Description The GPIO pins must be properly configured in order to function correctly as GPIO outputs this is especially true of Fury class devices where the digital input enable is turned off by default This function provides the proper configuration for those pin s The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Returns None GPIOPinTypel2C Configures pin s for use by the 12C peripheral Prototype void GPIOPinTypel2C unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The I2C pins must be properly configured for the 12C peripheral to function correctly This function provides the proper configuration for those pin s The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0
406. rns None GPIOPinTypeSSl Configures pin s for use by the SSI peripheral Prototype void GPIOPinTypeSSI unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The SSI pins must be properly configured for the SSI peripheral to function correctly This function provides a typical configuration for those pin s other configurations may work as well depending upon the board setup for example using the on chip pull ups The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into a SSI pin it only configures a SSI pin for proper operation Returns None January 11 2011 GPIO 9 2 2 26 GPlOPinTypeTimer Configures pin s for use by the Timer peripheral Prototype void GPIOPinTypeTimer unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The CCP pins must be properly configured for the timer peripheral to function correctly This function provides a typical configuration for those pin s other configurations may work as well depending upon the board setup for example using th
407. rrectly This function provides a typical configuration for those pin s other configurations may work as well depending upon the board setup for example using the on chip pull ups The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into a PWM pin it only configures a PWM pin for proper operation Returns None 9 2 2 24 GPIOPinTypeQEl Configures pin s for use by the QEI peripheral January 11 2011 127 GPIO 9 2 2 25 128 Prototype void GPIOPinTypeQEI unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The QEI pins must be properly configured for the QEI peripheral to function correctly This function provides a typical configuration for those pin s other configurations may work as well depending upon the board setup for example not using the on chip pull ups The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into a QEI pin it only configures a QEI pin for proper operation Retu
408. rsampling factor of the ADC Prototype void ADCHardwareOversampleConfigure unsigned long ulBase unsigned long ulFactor Parameters ulBase is the base address of the ADC module ulFactor is the number of samples to be averaged Description This function configures the hardware oversampling for the ADC which can be used to provide better resolution on the sampled data Oversampling is accomplished by averaging multiple samples from the same analog input Six different oversampling rates are supported 2x 4x 8x 16x 32x and 64x Specifying an oversampling factor of zero will disable hardware oversampling Hardware oversampling applies uniformly to all sample sequencers It does not reduce the depth of the sample sequencers like the software oversampling APIs each sample written into the sample sequence FIFO is a fully oversampled analog input reading Enabling hardware averaging increases the precision of the ADC at the cost of throughput For example enabling 4x oversampling reduces the throughput of a 250 Ksps ADC to 62 5 Ksps Note Hardware oversampling is available beginning with Rev CO of the Stellaris microcontroller Returns None January 11 2011 27 Analog to Digital Converter ADC 4 2 2 9 4 2 2 10 4 2 2 11 28 ADClIntClear Clears sample sequence interrupt source Prototype void ADCIntClear unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the bas
409. rt unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description Some USB analog pins must be properly configured for the USB peripheral to function correctly This function provides the proper configuration for any USB pin s This can also be used to configure the EPEN and PFAULT pins so that they are no longer used by the USB controller The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This cannot be used to turn any pin into a USB pin it only configures a USB pin for proper operation Returns None GPIOPinTypeUSBDigital Configures pin s for use by the USB peripheral Prototype void GPIOPinTypeUSBDigital unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description Some USB digital pins must be properly configured for the USB peripheral to function correctly This function provides a typical configuration for the digital USB pin s other configurations may work as well depending upon the board setup for example using the on chip pull ups This function should only be used with EPEN and PFAULT pins as all other USB pins are analog in nature or ar
410. rupt Prototype tBoolean IntMasterDisable void January 11 2011 189 Interrupt Controller NVIC 13 2 2 4 13 2 2 5 190 Description Prevents the processor from receiving interrupts This does not affect the set of interrupts enabled in the interrupt controller it just gates the single interrupt from the controller to the processor Note Previously this function had no return value As such it was possible to include interrupt h and call this function without having included hw_types h Now that the return is a tBoolean a compiler error will occur in this case The solution is to include hw_types h before including interrupt h Returns Returns true if interrupts were already disabled when the function was called or false if they were initially enabled IntWasterEnable Enables the processor interrupt Prototype tBoolean IntMasterEnable void Description Allows the processor to respond to interrupts This does not affect the set of interrupts enabled in the interrupt controller it just gates the single interrupt from the controller to the processor Note Previously this function had no return value As such it was possible to include interrupt h and call this function without having included hw_types h Now that the return is a tBoolean a compiler error will occur in this case The solution is to include hw_types h before including interrupt h Returns Returns true if interrupts were disable
411. s de termines the base address of the external memory or device within the processor peripheral and or memory space The parameter u Map is the logical OR of the following EPl_ADDR_PER_SIZE_256B EPI_ADDR_PER_SIZE_64KB EPl_ADDR_PER_SIZE_16MB or EPl_ADDR_PER_SIZE_512MB to choose a pe ripheral address space of 256 bytes 64 Kbytes 16 Mbytes or 512 Mbytes EPl_ADDR_PER_BASE_NONE EPI_ADDR_PER_BASE_A or EPl_ADDR_PER_BASE C to choose the base address of the peripheral space as none 0xA0000000 or OxC0000000 EPl_ADDR_RAM_SIZE_256B EPl_ADDR_RAM_SIZE_64KB EPl_ADDR_RAM_SIZE_16MB or EPI_ADDR_RAM_SIZE_512MB to choose a RAM address space of 256 bytes 64 Kbytes 16 Mbytes or 512 Mbytes EPlADDR_RAM_BASE_NONE EPI_ADDR_RAM_BASE 6 or EPl_ADDR_RAM_BASE_8 to choose the base address of the RAM space as none 0x60000000 or 0x80000000 Returns None January 11 2011 87 External Peripheral Interface EP 7 2 2 2 88 EPIConfigGPModeSet Configures the interface for general purpose mode operation Prototype void EPIConfigGPModeSet unsigned long ulBase unsigned long ulConfig unsigned long ulFrameCount unsigned long ulMaxWait Parameters ulBase is the EPI module base address ulConfig is the interface configuration ulFrameCount is the frame size in clocks if the frame signal is used 0 15 ulMaxWait is the maximum number of external clocks to wait when the external clock enable is holding off the
412. s equivalent to include driverlib rom h include driverlib systick h void SetupSysTick void ROM_SysTickPeriodSet 0x1000 ROM_SysTickEnable 26 4 Firmware Update Functions m void ROM_Updatel2C void void ROM_UpdateSSI void void ROM_UpdateUART void 26 4 1 Detailed Description There are a set of APIs in the ROM for restarting the boot loader in order to commence a firmware update Multiple calls are provided since each selects a particular interface to be used for the update process bypassing the interface selection step of the normal boot loader including the auto bauding in the UART interface See the Stellaris ROM User s Guide for details of the firmware update APIs in the ROM 26 4 2 Function Documentation 26 4 2 1 ROM _Updatel2C Starts an update over the I2CO interface Prototype void ROM_Updatel2C void Description Calling this function commences an update of the firmware via the l2CO interface This function assumes that the I2CO interface has already been configured and is currently operational The I2CO slave is used for data transfer and the I2CO master is used to monitor bus busy conditions therefore both must be enabled Returns Never returns January 11 2011 405 Using the ROM 26 4 2 2 ROM _UpdateSSl Starts an update over the SSIO interface Prototype void ROM_UpdateSSI void Description Calling this function commences an update of the firmware via
413. s is the mask for the CAN Last Error Code LEC CAN_STATUS_LEC_MSK Definition define CAN _STATUS_LEC_MSK Description This is the mask for the last error code field CAN_STATUS_LEC_NONE Definition define CAN_STATUS_LEC_NONE Description There was no error CAN_STATUS_LEC_STUFF Definition define CAN _STATUS_LEC_STUFEF Description A bit stuffing error has occurred CAN_STATUS_RXOK Definition define CAN_STATUS_RXOK Description A message was received successfully since the last read of this status CAN_STATUS_TXOK Definition define CAN_STATUS_TXOK Description A message was transmitted successfully since the last read of this status January 11 2011 5 2 3 18 5 2 3 19 5 2 3 20 9 2 3 21 5 2 3 22 5 2 3 23 Controller Area Network CAN MSG_OBJ_DATA_LOST Definition define MSG_OBJ_DATA_LOST Description This indicates that data was lost since this message object was last read MSG_OBJ_EXTENDED_ID Definition define MSG_OBJ_EXTENDED_ID Description This indicates that a message object will use or is using an extended identifier MSG_OBJ_FIFO Definition define MSG_OBJ_FIFO Description This indicates that this message object is part of a FIFO structure and not the final message object in a FIFO MSG_OBJ_NEW_DATA Definition define MSG_OBJ_NEW_DATA Description This indicates that new data was available in
414. s of the GPIO port ucPins is the bit packed representation of the pin s Description Masks the interrupt for the specified pin s The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Returns None GPIOPinlntEnable Enables interrupts for the specified pin s Prototype void GPIOPinIntEnable unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s January 11 2011 9 2 2 11 9 2 2 12 GPIO Description Unmasks the interrupt for the specified pin s The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Returns None GP1IOPinIntStatus Gets interrupt status for the specified GPIO port Prototype long GPIOPinIntStatus unsigned long ulPort tBoolean bMasked Parameters ulPort is the base address of the GPIO port bMasked specifies whether masked or raw interrupt status is returned Description If bDMasked is set as true then the masked interrupt status is returned otherwise the raw interrupt status will be returned Returns Returns a bit packed byte where each b
415. s that can be configured to operate indepen dently as timers or event counters or they can be configured to operate as one 32 bit timer or one 32 bit Real Time Clock RTC For the purpose of this API the two timers provided by the timer are referred to as TimerA and TimerB When configured as either a 32 bit or 16 bit timer a timer can be set up to run as a one shot timer or a continuous timer If configured as a one shot timer when it reaches zero the timer will cease counting If configured as a continuous timer when it reaches zero the timer will continue counting from a reloaded value When configured as a 32 bit timer the timer can also be configured to operate as an RTC In that case the timer expects to be driven by a 32 768 KHz external clock which is divided down to produce 1 second clock ticks When in 16 bit mode the timer can also be configured for event capture or as a Pulse Width Modulation PWM generator When configured for event capture the timer acts as a counter It can be configured to either count the time between events or it can count the events themselves The type of event being counted can be configured as a positive edge a negative edge or both edges When a timer is configured as a PWM generator the input line used to capture events becomes an output line and the timer is used to drive an edge aligned pulse onto that line The timer module also provides the ability to control other functional parameters such
416. s the number of the uDMA channel and is used to read or write registers within the uUDMA controller In this case it is simply the channel number with no additional qualifier However in other cases the channel number that is supplied as a parameter is really an index into the UDMA channel control structure Because every UDMA channel has a primary and an alternate channel control structure this must also be specified as part of the channel number This is done by passing a value for the channel parameter that is the logical OR of the actual channel number and one of UDMA_PRI_SELECT or UDMA_ALT_SELECT The default is the same as UDMA_PRI_SELECT so if you do not specify then the primary channel control structure is used which is the right thing in most cases January 11 2011 uDMA Controller Note When UDMA_ALT_SELECT is specified what is really happening is that channel index 32 63 is being used This is because the alternate channel control structures for channels 0 31 are located at index locations 32 63 in the channel control table Here is an example of the first case In this example a UDMA channel is to be enabled and only the channel number is used because this is programming a register in the UDMA controller uDMAChannelEnable UDMA_CHANNEL_UARTORX Here is an example of the second case In this example the channel control structure is to be modified to configure some transfer parameters Therefore in addition to specifying the
417. same definition as the ullntFlags parameter to TimerintEn able Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None 21 2 2 10 TimerlntDisable Disables individual timer interrupt sources Prototype void TimerIntDisable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base address of the timer module ullntFlags is the bit mask of the interrupt sources to be disabled January 11 2011 297 Timer Description Disables the indicated timer interrupt sources Only the sources that are enabled can be re flected to the processor interrupt disabled sources have no effect on the processor The ullntFlags parameter has the same definition as the ullntFlags parameter to Timer ntEn able Returns None 21 2 2 11 TimerlntEnable Enables individual timer interrupt sources Prototype void TimerIntEnable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base a
418. sample Each sample can be the same channel different channels or any combination in any order The sample sequences have configurable priorities that determine the order in which they are cap tured when multiple triggers occur simultaneously The highest priority sequence that is currently triggered will be sampled Care must be taken with triggers that occur frequently such as the always trigger if their priority is too high it is possible to starve the lower priority sequences Beginning with Rev CO of the Stellaris microcontroller hardware oversampling of the ADC data is available for improved accuracy An oversampling factor of 2x 4x 8x 16x 32x and 64x is sup ported but reduces the throughput of the ADC by a corresponding factor Hardware oversampling is applied uniformly across all sample sequences Software oversampling of the ADC data is also available even when hardware oversampling is available An oversampling factor of 2x 4x and 8x is supported but reduces the depth of the sample sequences by a corresponding amount For example the first sample sequence will capture eight samples in 4x oversampling mode it can only capture two samples since the first four samples are used over the first oversampled value and the second four samples are used for the second oversampled value The amount of software oversampling is configured on a per sample sequence basis A more sophisticated software oversampling can be used to e
419. scription This function writes BufLen bytes of the packet contained in pucBuf into the transmit FIFO of the controller and then activates the transmitter for this packet This function will wait until the transmit FIFO is empty Once space is available the function will return once BufLen bytes of the packet have been placed into the FIFO and the transmitter has been started The function will not wait for the transmission to complete The function will return the negated BufLen if the length is larger than the space available in the transmit FIFO January 11 2011 79 Ethernet Controller 6 2 2 18 6 2 2 19 80 Note This function blocks and will wait until space is available for the transmit packet before returning Returns Returns the negated packet length IBufLen if the packet is too large for FIFO and the packet length IBufLen otherwise EthernetPacketPutNonBlocking Sends a packet to the Ethernet controller Prototype long EthernetPacketPutNonBlocking unsigned long ulBase unsigned char xpucBuf long 1BufLen Parameters ulBase is the base address of the controller pucBuf is the pointer to the packet buffer IBufLen is number of bytes in the packet to be transmitted Description This function writes BufLen bytes of the packet contained in pucBuf into the transmit FIFO of the controller and then activates the transmitter for this packet If no space is available in the FIFO the function will return imme
420. sfer request The receive FIFO will generate a service request when the number of items in the FIFO is greater than the level specified in the u Leve parameter For example if u Level is 4 then a service request will be generated when there are more than 4 samples available in the receive FIFO For the purposes of counting the FIFO level a left right sample pair counts as 2 whether the mode is dual or compact stereo When mono mode is used internally the mono sample is still treated as a sample pair so a single mono sample counts as 2 Since the FIFO always deals with sample pairs the level must be an even number from 0 to 16 The minimum value is 0 which will cause a service request when there is any data available in the FIFO The maximum value is 16 which disables the service request because there cannot be more than 16 items in the FIFO Returns None 12 2 2 16 l2STxConfigSet Configures the I2S transmit module Prototype void I2STxConfigSet unsigned long ulBase unsigned long ulConfig Parameters ulBase is the 12S module base address ulConfig is the logical OR of the configuration options Description This function is used to configure the options for the 12S transmit channel The parameter ulConfig is the logical OR of the following options m 12S CONFIG_FORMAT_I2S for standard 12S format 12S CONFIG_FORMAT_LEFT_JUST for left justified format or 128 CONFIG_FORMAT_RIGHT_JUST for right justified format
421. signed long ulName Parameters ulName is one of the valid names for the UART pins Description This function takes one of the valid names for a UART pin and configures the pin for its UART functionality depending on the part that is defined The valid names for the pins are as follows UORX UOTX U1RX U1TX U2RX or U2TX See also GPIOPinTypeUART in order to configure multiple UART pins at once Returns None PinTypeUSBDigital Configures the specified USB digital pin to function as a USB pin Prototype void PinTypeUSBDigital unsigned long ulName Parameters ulName is one of the valid names for a USB digital pin January 11 2011 Peripheral Pin Mapping Description This function takes one of the valid names for a USB digital pin and configures the pin for its USB functionality depending on the part that is defined The valid names for the pins are as follows EPEN or PFAULT See also GPIOPinTypeUSBDigital in order to configure multiple USB pins at once Returns None 15 3 Programming Example This example shows the difference in code when configuring a PWM pin on two different parts in the same application In this case the PWMO pin is actually on a different GPIO port on the two parts and requires special conditional code if the GPIOPinTypePWM function is used directly Instead if PinlypePWM is used then the code can remain the same and only the part definition in the project file ne
422. signed short usFall Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to modify Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 usRise specifies the width of delay from the rising edge usFall specifies the width of delay from the falling edge Description This function sets the dead bands for the specified PWM generator where the dead bands are defined as the number of PWM clock ticks from the rising or falling edge of the generator s OutA signal Note that this function causes the coupling of OutB to OutA Returns None PWMFaultIntClear Clears the fault interrupt for a PWM module Prototype void PWMFaultIntClear unsigned long ulBase Parameters ulBase is the base address of the PWM module Description Clears the fault interrupt by writing to the appropriate bit of the interrupt status register for the selected PWM module This function clears only the FAULTO interrupt and is retained for backwards compatibility It is recommended that PWMFaultIntClearExt be used instead since it supports all fault interrupts supported on devices with and without extended PWM fault handling support Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last
423. specify if the signals provided on ChA and ChB should be swapped before being processed ulMaxPosition is the maximum value of the position integrator and is the value used to reset the position capture when in index reset mode and moving in the reverse negative direction Returns None 17 2 2 2 QElIDirectionGet Gets the current direction of rotation Prototype long QETIDirectionGet unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This returns the current direction of rotation In this case current means the most recently detected direction of the encoder it may not be presently moving but this is the direction it last moved before it stopped Returns Returns 1 if moving in the forward direction or 1 if moving in the reverse direction January 11 2011 239 Quadrature Encoder QE 17 2 2 3 17 2 2 4 17 2 2 5 240 QEIDisable Disables the quadrature encoder Prototype void QETDisable unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This will disable operation of the quadrature encoder module Returns None QElEnable Enables the quadrature encoder Prototype void QETEnable unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This will enable operation of the quadrature encoder modu
424. st trigger output January 11 2011 23 Analog to Digital Converter ADC 4 2 2 2 24 ADC_COMP_TRIG_LOW_HONCE to trigger PWM fault condition once when ADC output transitions into low band only if ADC output has been in the high band since the last trigger output ADC_COMP_TRIG_MID_ALWAYS to always trigger PWM fault condition when ADC out put is in the mid band ADC_COMP_TRIG_MID_ONCE to trigger PWM fault condition once when ADC output transitions into the mid band ADC_COMP_TRIG_HIGH_ALWAYS to always trigger PWM fault condition when ADC out put is in the high band ADC_COMP_TRIG_HIGH_ONCE to trigger PWM fault condition once when ADC output transitions into the high band ADC_COMP_TRIG_HIGH_HALWAYS to always trigger PWM fault condition when ADC output is in the high band only if ADC output has been in the low band since the last trigger output ADC_COMP_TRIG_HIGH_HONCE to trigger PWM fault condition once when ADC output transitions into high band only if ADC output has been in the low band since the last trigger output The ADC_COMP_INT_xxx term can take on the following values ADC_COMP_INT_NONE to never generate ADC interrupt ADC_COMP_INT_LOW_ALWAYS to always generate ADC interrupt when ADC output is in the low band ADC_COMP_INT_LOW_ONCE to generate ADC interrupt once when ADC output transi tions into the low band ADC_COMP__INT_LOW_HALWAYS to always generate ADC interrupt when ADC output is in the
425. standards The Ethernet API provides the set of functions required to implement an interrupt driven Ethernet driver for this Ethernet controller Functions are provided to configure and control the MAC to access the register set on the PHY to transmit and receive Ethernet packets and to configure and control the interrupts that are available This driver is contained in driverlib ethernet c with driverlib ethernet h containing the API definitions for use by applications API Functions Functions unsigned long EthernetConfigGet unsigned long ulBase void EthernetConfigSet unsigned long ulBase unsigned long ulConfig void EthernetDisable unsigned long ulBase void EthernetEnable unsigned long ulBase void EthernetlnitExpClk unsigned long ulBase unsigned long ulEthClk void EthernetIntClear unsigned long ulBase unsigned long ullntFlags void EthernetIntDisable unsigned long ulBase unsigned long ullntFlags void EthernetIntEnable unsigned long ulBase unsigned long ullntFlags void EthernetIntRegister unsigned long ulBase void pfnHandler void unsigned long EthernetIntStatus unsigned long ulBase tBoolean bMasked void EthernetIntUnregister unsigned long ulBase void EthernetMACAddrGet unsigned long ulBase unsigned char pucMACAddadr void EthernetMACAddrSet unsigned long ulBase unsigned char pucMACAddr tBoolean EthernetPacketAvail unsigned long ulBase long EthernetPacketGet unsigned long ulBase
426. status is required and true if the masked interrupt status is required Description This returns the interrupt status for the specified sample sequence Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned Returns The current raw or masked interrupt status ADClIntUnregister Unregisters the interrupt handler for an ADC interrupt Prototype void ADCIntUnregister unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description This function unregisters the interrupt handler This will disable the global interrupt in the interrupt controller the sequence interrupt must be disabled via ADCIntDisable See also IntRegister for important information about registering interrupt handlers Returns None ADCPhaseDelayGet Gets the phase delay between a trigger and the start of a sequence Prototype unsigned long ADCPhaseDelayGet unsigned long ulBase Parameters ulBase is the base address of the ADC module January 11 2011 Analog to Digital Converter ADC Description This function gets the current phase delay between the detection of an ADC trigger event and the start of the sample sequence Returns Returns the phase delay specified as one of ADC_PHASE_0 ADC PHASE 22 5 ADC_PHASE_45 ADC_ PHASE 67_5 ADC_PHASE_90
427. stead of completing as soon as PLL lock is achieved Returns None 19 2 2 7 SysCtIDeepSleep Puts the processor into deep sleep mode Prototype void SysCt1lDeepSleep void Description This function places the processor into deep sleep mode it will not return until the processor returns to run mode The peripherals that are enabled via SysCtlPeripheralDeepSleepEnable continue to operate and can wake up the processor if automatic clock gating is enabled with SysCtlPeripheralClockGating otherwise all peripherals continue to operate Returns None 19 2 2 8 SysCtlDelay Provides a small delay Prototype void SysCtlDelay unsigned long ulCount Parameters ulCount is the number of delay loop iterations to perform Description This function provides a means of generating a constant length delay It is written in assembly to keep the delay consistent across tool chains avoiding the need to tune the delay based on the tool chain in use The loop takes 3 cycles loop Returns None January 11 2011 265 System Control 19 2 2 9 SysCtlFlashSizeGet Gets the size of the flash Prototype unsigned long SysCtlFlashSizeGet void Description This function determines the size of the flash on the Stellaris device Returns The total number of bytes of flash 19 2 2 10 SysCtIGPIOAHBDisable Disables a GPIO peripheral for access from the AHB Prototype void SysCt1GPIOAHBDisable uns
428. structure is selected This function will look for the UDMA_PRI_SELECT and UDMA_ALT_SELECT flag along with the channel number and will set the scatter gather mode as appropriate for the primary or alternate control structure The channel must also be enabled using UDMAChannelEnable after calling this function The transfer will not begin until the channel has been set up and enabled Note that the channel is automatically disabled after the transfer is completed meaning that UDMAChannelEnable must be called again after setting up the next transfer Note Great care must be taken to not modify a channel control structure that is in use or else the results will be unpredictable including the possibility of undesired data transfers to or from memory or peripherals For BASIC and AUTO modes it is safe to make changes when the channel is disabled or the UDMAChannelModeGet returns UDMA_MODE_STOP For PING PONG or one of the SCATTER_GATHER modes it is safe to modify the primary or alternate control structure only when the other is being used The UDMAChannelModeGet function will return UDMA_MODE_STOP when a channel control structure is inactive and safe to modify Returns None 23 2 3 15 uDMAControlAlternateBaseGet Gets the base address for the channel control table alternate structures Prototype void x uDMAControlAlternateBaseGet void Description This function gets the base address of the second half of the channel co
429. t unsigned char ucPins void GPIOPinTypeTimer unsigned long ulPort unsigned char ucPins void GPIOPinTypeUART unsigned long ulPort unsigned char ucPins void GPIOPinTypeUSBAnalog unsigned long ulPort unsigned char ucPins void GPIOPinTypeUSBDigital unsigned long ulPort unsigned char ucPins void GPIOPinWrite unsigned long ulPort unsigned char ucPins unsigned char ucVal void GPIOPortIntRegister unsigned long ulPort void pfnintHandler void void GPIOPortIntUnregister unsigned long ulPort Detailed Description The GPIO API is broken into three groups of functions those that deal with configuring the GPIO pins those that deal with interrupts and those that access the pin value The GPIO pins are configured with GPIODirModeSet and GPIOPadConfigSet The configura tion can be read back with GPIODirModeGet and GPIOPadConfigGet There are also con venience functions for configuring the pin in the required or recommended configuration for a January 11 2011 9 2 2 9 2 2 1 9 2 2 2 GPIO particular peripheral these are GPIOPinTypeCAN GPIOPinTypeComparator GPIOPinTypeG PlOlnput GPIOPinTypeGPlOOutput GPIOPinTypeGPIOOutputOD GPIOPinTypel2C GPI OPinTypePWM GPIOPinTypeQEl GPIOPinTypeSSl GPlOPinTypeTimer and GPIOPin TypeUART The GPIO interrupts are handled with GP OIntTypeSet GPlOIntTypeGet GPIOPinIntEnable GP1OPinIntDisable GPIOPinIntStatus GPIOPinIntClear
430. t be done in the interrupt handler to keep it from being called again immediately upon exit Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None FlashIntDisable Disables individual flash controller interrupt sources Prototype void FlashIntDisable unsigned long ulIntFlags Parameters ullntFlags is a bit mask of the interrupt sources to be disabled Can be any of the FLASH_INT_PROGRAM or FLASH_INT_ACCESS values Description Disables the indicated flash controller interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor Returns None FlashIntEnable Enables individual flash controller interrupt sources January 11 2011 105 Flash 8 2 2 5 8 2 2 6 106 Prototype void FlashIntEnable unsigned long ulIntFlags Parameters ullntFlags is a bit mask of the interrupt sources to be enabled Can be any of the FLASH_INT_PROGRAM or
431. t handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None 3 2 2 3 ComparatorintDisable Disables the comparator interrupt Prototype void ComparatoriIntDisable unsigned long ul unsigned long ul Parameters Base Comp ulBase is the base address of the comparator module ulComp is the index of the comparator Description This function disables generation of an interrupt from the specified comparator Only compara tors whose interrupts are enabled can be reflected to the processor January 11 2011 Analog Comparator 3 2 2 4 3 2 2 5 16 Returns None ComparatorIntEnable Enables the comparator interrupt Prototype void ComparatorIntEnable unsigned long ulBase unsigned long ulComp Parameters ulBase is the base address of the comparator module ulComp is the index of the comparator Description This function enables generation of an interrupt from the specified comparator Only compara tors whose interrupts are enabled can be reflected to the processor Returns None ComparatorIntRegister Registers an interrupt handler for the comparator interrupt Prototype void ComparatorIntRegister unsigned long ulBase unsigned long ulComp void pfnHandler void Parameters ulBase is the base address of the comparator module ulComp is the index of the comparator pfnHa
432. t registering interrupt handlers Returns None I2CIntUnregister Unregisters an interrupt handler for the 12C module Prototype void I2CIntUnregister unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This function will clear the handler to be called when an 12C interrupt occurs This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for important information about registering interrupt handlers Returns None I2CMasterBusBusy Indicates whether or not the 12C bus is busy Prototype tBoolean I2CMasterBusBusy unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This function returns an indication of whether or not the I2C bus is busy This function can be used in a multi master environment to determine if another master is currently using the bus January 11 2011 Inter Integrated Circuit 12C Returns Returns true if the 12C bus is busy otherwise returns false 11 2 2 4 l2CMasterBusy Indicates whether or not the I2C Master is busy Prototype tBoolean I2CMasterBusy unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This function returns an indication of whether or not the 12C Master is busy transmitting or receiving data Returns Returns true if
433. tRegister for important information about registering interrupt handlers Returns None MPURegionCountGet Gets the count of regions supported by the MPU Prototype unsigned long MPURegionCountGet void Description This function is used to get the number of regions that are supported by the MPU This is the total number that are supported including regions that are already programmed Returns The number of memory protection regions that are available for programming using MPURe gionSet MPURegionDisable Disables a specific region January 11 2011 14 2 2 7 14 2 2 8 Memory Protection Unit MPU Prototype void MPURegionDisable unsigned long ulRegion Parameters ulRegion is the region number to disable Description This function is used to disable a previously enabled memory protection region The region will remain configured if it is not overwritten with another call to MPURegionSet and can be enabled again by calling MPURegionEnable Returns None MPURegionEnable Enables a specific region Prototype void MPURegionEnable unsigned long ulRegion Parameters ulRegion is the region number to enable Description This function is used to enable a memory protection region The region should already be set up with the MPURegionSet function Once enabled the memory protection rules of the region will be applied and access violations will cause a memory management fault
434. ta ulArbSize is the arbitration size to use for the transfer task ulMode is the transfer mode for this task Description January 11 2011 This macro is intended to be used to help populate a table of UDMA tasks for a scatter gather transfer This macro will calculate the values for the fields of a task structure entry based on the input parameters There are specific requirements for the values of each parameter No checking is done so it is up to the caller to ensure that correct values are used for the parameters 335 uDMA Controller The ulTransferCount parameter is the number of items that will be transferred by this task It must be in the range 1 1024 The ulltemSize parameter is the bit size of the transfer data It must be one of UDMA_SIZE_8 UDMA_SIZE_16 or UDMA_SIZE_32 The ulSrcincrement parameter is the increment size for the source data It must be one of UDMA_SRC_INC_8 UDMA_SRC_INC 16 UDMA_SRC_INC_ 32 or UDMA_SRC_INC_NONE The pvSrcAdoar parameter is a void pointer to the beginning of the source data The ulDstIncrement parameter is the increment size for the destination data It must be one of UDMA_SRC_INC_8 UDMA_SRC_INC 16 UDMA_SRC_INC_ 32 or UDMA_SRC_INC_NONE The pvDstAdadr parameter is a void pointer to the beginning of the location where the data will be transferred The ulArbSize parameter is the arbitration size for the transfer and must be one of UDMA_ARB_1 UDMA_ARB_2 UDMA_ARB 4 and so on
435. taGetNonBlocking unsigned long ulBase unsigned long pulData void SSIDataPut unsigned long ulBase unsigned long ulData long SSIDataPutNonBlocking unsigned long ulBase unsigned long ulData void SSIDisable unsigned long ulBase void SSIDMADisable unsigned long ulBase unsigned long ulIDMAFlags void SSIDMAEnable unsigned long ulBase unsigned long ulDMAFlags void SSIEnable unsigned long ulBase void SSllntClear unsigned long ulBase unsigned long ullntFlags January 11 2011 247 Synchronous Serial Interface SSI 18 2 1 18 2 2 18 2 2 1 248 m void SSlilntDisable unsigned long ulBase unsigned long ullntFlags m void SSllntEnable unsigned long ulBase unsigned long ullntFlags m void SSilntRegister unsigned long ulBase void pfnHandler void m unsigned long SSllntStatus unsigned long ulBase tBoolean bMasked m void SSllntUnregister unsigned long ulBase Detailed Description The SSI API is broken into 3 groups of functions those that deal with configuration and state those that handle data and those that manage interrupts The configuration of the SSI module is managed by the SSIConfigSetExpClk function while state is managed by the SSIEnable and SSI Disable functions The DMA interface is enabled or dis abled by the SSIDMAEnable and SSIDMADisable functions Data handling is performed by the SSIDataPut SSIDataPutNonBlocking SSIDataGet and SSIDataGetNonBlocking functions
436. tchGet unsigned long ulBase unsigned long ulTimer Parameters ulBase is the base address of the timer module ulTimer specifies the timer must be one of TIMER_A or TIMER _B Description This function gets the value of the input clock prescaler match value When in a 16 bit mode that uses the counter match and prescaler the prescale match effectively extends the range of the counter to 24 bits Note This functionality is not available on all parts Returns The value of the timer prescale match TimerPrescaleMatchSet Set the timer prescale match value Prototype void TimerPrescaleMatchSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue Parameters ulBase is the base address of the timer module January 11 2011 Timer ulTimer specifies the timer s to adjust must be one of TIMER_A TIMER_B or TIMER_BOTH ulValue is the timer prescale match value must be between 0 and 255 inclusive Description This function sets the value of the input clock prescaler match value When in a 16 bit mode that uses the counter match and the prescaler the prescale match effectively extends the range of the counter to 24 bits Note This functionality is not available on all parts Returns None 21 2 2 22 TimerPrescaleSet Set the timer prescale value Prototype void TimerPrescaleSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue
437. tched exactly the bit rate is set to the value closest to the desired bit rate without being higher than the u BitRate value Note On some devices the source clock is fixed at 8MHz so the u SourceClock should be set to 8000000 Returns This function returns the bit rate that the CAN controller was configured to use or it returns 0 to indicate that the bit rate was not changed because the requested bit rate was not valid CANBitTimingGet Reads the current settings for the CAN controller bit timing Prototype void CANBitTimingGet unsigned long ulBase tCANBitClkParms xpClkParms Parameters ulBase is the base address of the CAN controller pClikParms is a pointer to a structure to hold the timing parameters January 11 2011 Controller Area Network CAN Description This function reads the current configuration of the CAN controller bit clock timing and stores the resulting information in the structure supplied by the caller Refer to CANBitTimingSet for the meaning of the values that are returned in the structure pointed to by pC kParms This function replaces the original CANGetBitTiming API and performs the same actions A macro is provided in can h to map the original API to this API Returns None 5 2 5 3 CANBitTimingSet Configures the CAN controller bit timing Prototype void CANBitTimingSet unsigned long ulBase tCANBitClkParms pClkParms Parameters ulBase is the base address of the C
438. teClockSelect In order to use the RTC feature of the Hibernation module the RTC must be enabled by calling HibernateRTCEnable It can be later disabled by calling HibernateRTCDisable These functions can be called at any time to start and stop the RTC The RTC value can be read or set by using the HibernateRTCGet and HibernateRT CSet functions The two match registers can be read and set by using the HibernateRTCMatchOGet HibernateRTCMatchO0Set HibernateRTCMatch1 Get and HibernateRT CMatch1Set functions The real time clock rate can be adjusted by using the trim register Use the HibernateRT CTrimGet and HibernateRTCTrimSet functions for this purpose Application state information can be stored in the non volatile memory of the Hibernation module when the processor is powered off Use the HibernateDataSet and HibernateDataGet functions to access the non volatile memory area The module can be configured to wake when the external WAKE pin is asserted or when an RTC match occurs or both Use the HibernateWakeSet function to configure the wake conditions The present configuration can be read by calling HibernateWakeGet The Hibernation module can detect a low battery and signal the processor It can also be configured to abort a hibernation request if the battery voltage is too low Use the HibernateLowBatSet and HibernateLowBatGet functions to configure this feature Several functions are provided for managing
439. ted with more than one GPIO pin Note This function is only valid on Tempest class devices Returns None GP1IOPinIntClear Clears the interrupt for the specified pin s Prototype void GPIOPinIntClear unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description Clears the interrupt for the specified pin s January 11 2011 119 GPIO 9 2 2 9 9 2 2 10 120 The pin s are specified using a bit packed byte where each bit that is set identifies the pin to be accessed and where bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None GPIOPinlntDisable Disables interrupts for the specified pin s Prototype void GPIOPinIntDisable unsigned long ulPort unsigned char ucPins Parameters ulPort is the base addres
440. ter Integrated Circuit 12C Parameters ulBase is the base address of the I2C Slave module Description This function will return the action requested from a master if any Possible values are 12C_SLAVE_ACT_NONE 12C_SLAVE_ACT_RREQ 12C_SLAVE_ACT_TREQ 12C_SLAVE_ACT_RREQ FBR Returns Returns 12C_SLAVE_ACT_NONE to indicate that no action has been requested of the 12C Slave module I2C_SLAVE_ACT_RREQ to indicate that an I2C master has sent data to the 12C Slave module I2C_SLAVE_ACT_TREQ to indicate that an 12C master has requested that the I2C Slave module send data and I2C_SLAVE_ACT_RREQ_FBR to indicate that an 12C master has sent data to the I2C slave and the first byte following the slave s own address has been received 11 3 Programming Example The following example shows how to use the I2C API to send data as a master ff Initialize Master and Slave T2CMasterInitExpClk I2C_MASTER_BASE SysCtlClockGet true Specify slave address I2CMasterSlaveAddrSet I2C_MASTER_BASE 0x3B false if Place the character to be sent in the data register I2CMasterDataPut I2C_MASTER_BASE 0Q ff Initiate send of character from Master to Slave I2CMasterControl I2C_MASTER_BASE I2C_MASTER_CMD_SINGLE_SEND Delay until transmission completes fi while I2CMasterBusBusy I2C_MASTER_BASBE 168 January 11 2011 12 12 1 12 2 Inter IC Sound 12S Inter IC
441. terrupt capability of the Ethernet controller The EthernetIntRegister and EthernetintUnregister functions are used to register an ISR with the system and to enable or disable the Ethernet controller s interrupt signal The EthernetIntEnable and EthernetlntDisable functions are used to manipulate the individual interrupt sources available in the Ethernet controller for example RX Error TX Complete The EthernetIntStatus and EthernetIntClear functions would be used to query the active interrupts to determine which process to service and to clear the indicated interrupts prior to returning from the registered ISR The Ethernetinit EthernetPacketNonBlockingGet and EthernetPacketNonBlockingPut APIs from previous versions of the peripheral driver library have been replaced by the EthernetlnitEx pClk EthernetPacketGetNonBlocking and EthernetPacketPutNonBlocking APIs respectively Macros have been provided in ethernet h to map the old APIs to the new APIs allowing existing applications to link and run with the new APIs It is recommended that new applications utilize the new APIs in favor of the old ones January 11 2011 6 2 2 6 2 2 1 6 2 2 2 Ethernet Controller Function Documentation EthernetConfigGet Gets the current configuration of the Ethernet controller Prototype unsigned long EthernetConfigGet unsigned long ulBase Parameters ulBase is the base address of the controller Descrip
442. terrupt status or false to get the raw interrupt status Description This function returns the 12S interrupt status It can return either the raw or masked interrupt status Returns Returns the masked or raw 2S interrupt status as a bit field of any of the following values I2S_INT_RXERR I2S_INT_RXREQ I2S_INT_TXERR or 12S_INT_TXREQ I2SIntUnregister Unregisters an interrupt handler for the 12S controller Prototype void I2SIntUnregister unsigned long ulBase Parameters ulBase is the 2S module base address Description This function will disable and clear the handler to be called when the 12S interrupt occurs See also IntRegister for important information about registering interrupt handlers Returns None January 11 2011 173 Inter IC Sound 12S 12 2 2 7 12 2 2 8 174 I2SMasterClockSelect Selects the source of the master clock internal or external Prototype void I2SMasterClockSelect unsigned long ulBase unsigned long ulMClock Parameters ulBase is the 2S module base address ulMClock is the logical OR of the master clock configuration choices Description This function selects whether the master clock is sourced from the device internal PLL or comes from an external pin The 12S serial bit clock SCLK and left right word clock LRCLK are derived from the I2S master clock The transmit and receive modules can be configured independently The u MClock parameter
443. th PWMGenlIntTrigEnable ADC_TRIGGER_ALWAYS A trigger that is always asserted causing the sample se quence to capture repeatedly so long as there is not a higher priority source active Note that not all trigger sources are available on all Stellaris family members consult the data sheet for the device in question to determine the availability of triggers The ulPriority parameter is a value between 0 and 3 where 0 represents the highest priority and 3 the lowest Note that when programming the priority among a set of sample sequences each must have unique priority it is up to the caller to guarantee the uniqueness of the priori ties Returns None ADCSequenceDataGet Gets the captured data for a sample sequence Prototype long ADCSequenceDataGet unsigned long ulBase unsigned long ulSequenceNum unsigned long pulBuffer Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number pulBuffer is the address where the data is stored Description This function copies data from the specified sample sequence output FIFO to a memory resi dent buffer The number of samples available in the hardware FIFO are copied into the buffer which is assumed to be large enough to hold that many samples This will only return the samples that are presently available which may not be the entire sample sequence if it is in the process of being executed Returns Returns the
444. the 12C Master is busy otherwise returns false 11 2 2 5 2CMasterControl Controls the state of the 12C Master module Prototype void I2CMasterControl unsigned long ulBase unsigned long ulCmd Parameters ulBase is the base address of the I2C Master module ulCmd command to be issued to the 12C Master module Description This function is used to control the state of the Master module send and receive operations The ucCmd parameter can be one of the following values 12 _MASTER_CMD_SINGLE_SEND 12C_MASTER_CMD_SINGLE_RECEIVE 12C_MASTER_CMD_BURST_SEND_ START 12 _MASTER_CMD_BURST_SEND_ CONT 12C_MASTER_CMD_BURST_SEND FINISH 12 _MASTER_CMD_BURST_SEND ERROR STOP 12C_MASTER_CMD_BURST_RECEIVE_START 12C_MASTER_CMD_BURST_RECEIVE_CONT 12C_MASTER_CMD_BURST_RECEIVE_FINISH 12C_MASTER_CMD_BURST_RECEIVE_ERROR_STOP Returns None January 11 2011 157 Inter Integrated Circuit l2C 11 2 2 6 11 2 2 7 11 2 2 8 158 I2CMasterDataGet Receives a byte that has been sent to the 12C Master Prototype unsigned long I2CMasterDataGet unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This function reads a byte of data from the 12C Master Data Register Returns Returns the byte received from by the I2C Master cast as an unsigned long I2CMasterDataPut Transmits a byte from the I2C Master Prototype void I2CMasterDataPut unsigned long ulBase
445. the I2C Slave cast as an unsigned long 11 2 2 18 12CSlaveDataPut Transmits a byte from the I2C Slave Prototype void I2CSlaveDataPut unsigned long ulBase unsigned char ucData 162 January 11 2011 Inter Integrated Circuit 12C Parameters ulBase is the base address of the I2C Slave module ucData data to be transmitted from the 12C Slave Description This function will place the supplied data into 12C Slave Data Register Returns None 11 2 2 19 12CSlaveDisable Disables the 12C slave block Prototype void I2CSlaveDisable unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description This will disable operation of the 12C slave block Returns None 11 2 2 20 2CSlaveEnable Enables the 12C Slave block Prototype void I2CSlaveEnable unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description This will enable operation of the I2C Slave block Returns None 11 2 2 21 2CSlavelnit Initializes the 12C Slave block Prototype void I2CSlaveInit unsigned long ulBase unsigned char ucSlaveAddr January 11 2011 163 Inter Integrated Circuit I2C Parameters ulBase is the base address of the I2C Slave module ucSlaveAddr 7 bit slave address Description This function initializes operation of the 12C Slave block Upon successful initialization of the I2C blocks this function will h
446. the interrupts to be cleared Description Clears the specified interrupt s by writing a 1 to the specified bits of the interrupt sta tus register for the specified PWM generator The ullnts parameter is the logical OR of PWMN_INT_CNT_ZERO PWM_INT_CNT_LOAD PWM_INT_CNT_AU PWM_INT_CNT_AD PWWN_INT_CNT_BU or PWM_INT_CNT_BD Note Because there is a write buffer in the Cortex M3 processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt source be cleared early in the interrupt handler as opposed to the very last action to avoid 226 January 11 2011 Pulse Width Modulator PWM returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None 16 2 2 16 PWMGenIntRegister Registers an interrupt handler for the specified PWM generator block Prototype void PWMGenIntRegister unsigned long ulBase unsigned long ulGen void xpfnIntHandler void Parameters ulBase is the base address of the PWM module Must be one of PWM_GEN_0 PWM_GEN_1 ulGen is the PWM generator in question PWM_GEN_2 or PWM_GEN_ 3 pfnintHandler is a pointer to the function to be called when the PWM generator interrupt occurs Description
447. the message object MSG_OBJ_NO_FLAGS Definition define MSG_OBJ_NO_FLAGS Description This indicates that a message object has no flags set MSG_OBJ_REMOTE_FRAME Definition define MSG_OBJ_REMOTE_FRAME Description This indicates that a message object is a remote frame January 11 2011 49 Controller Area Network CAN 5 2 3 24 5 2 3 25 5 2 3 26 5 2 3 27 5 2 3 28 50 MSG_OBJ_RX_INT_ENABLE Definition define MSG_OBJ_RX_INT_ENABLE Description This indicates that receive interrupts should be enabled or are enabled MSG_OBJ_STATUS_MASK Definition define MSG_OBJ_STATUS_MASK Description This define is used with the flag values to allow checking only status flags and not configuration flags MSG_OBJ_TX_INT_ENABLE Definition define MSG_OBJ_TX_INT_ENABLE Description This definition is used with the tCANMsgObject ulFlags value and indicates that transmit inter rupts should be enabled or are enabled MSG_OBJ_USE_DIR_FILTER Definition define MSG_OBJ_USE_DIR_FILTER Description This indicates that a message object will use or is using filtering based on the direction of the transfer If the direction filtering is used then ID filtering must also be enabled MSG_OBJ_USE_EXT_FILTER Definition define MSG_OBJ_USE_EXT_FILTER Description This indicates that a message object will use or is using messag
448. the part s data sheet for a description of the trigger chain Note This functionality is not available on all parts Returns None TimerDisable Disables the timer s Prototype void TimerDisable unsigned long ulBase unsigned long ulTimer Parameters ulBase is the base address of the timer module ulTimer specifies the timer s to disable must be one of TIMER_A TIMER_B or TIMER_BOTH Description This will disable operation of the timer module Returns None TimerEnable Enables the timer s Prototype void TimerEnable unsigned long ulBase unsigned long ulTimer Parameters ulBase is the base address of the timer module ulTimer specifies the timer s to enable must be one of TIMER_A TIMER _B or TIMER_BOTH January 11 2011 21 2 2 9 Timer Description This will enable operation of the timer module The timer must be configured before it is en abled Returns None TimerintClear Clears timer interrupt sources Prototype void TimerIntClear unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base address of the timer module ullntFlags is a bit mask of the interrupt sources to be cleared Description The specified timer interrupt sources are cleared so that they no longer assert This must be done in the interrupt handler to keep it from being called again immediately upon exit The ullntFlags parameter has the
449. the peripherals Corresponding to the direct register access model example the following call also programs the CRO register in the SSI module though the register name is hidden by the API January 11 2011 Programming Model SSIConfigSetExpClk SSIO_BASE 50000000 SSI_FRF_MOTO_MODE_3 SSI_MODE_MASTER 1000000 8 The resulting value in the CRO register might not be exactly the same because SSIConfigSetExp Clk may compute a different value for the SCR bit field than what was used in the direct register access model example All example applications other than blinky use the software driver model The drivers in the peripheral driver library are described in the remaining chapters in this document They combine to form the software driver model 2 4 Combining The Models The direct register access model and software driver model can be used together in a single ap plication allowing the most appropriate model to be applied as needed to any particular situation within the application For example the software driver model can be used to configure the periph erals because this is not performance critical and the direct register access model can be used for operation of the peripheral which may be more performance critical Or the software driver model can be used for peripherals that are not performance critical such as a UART used for data logging and the direct register access model for performance critical peripherals
450. tion When configuring an IN endpoint the USB_EP_AUTO_SET bit can be specified to cause the automatic transmission of data on the USB bus as soon as ulMaxPacketSize bytes of data are written into the FIFO for this endpoint This is commonly used with DMA as no interaction is required to start the transmission of data When configuring an OUT endpoint the USB_EP_AUTO_REQUEST bit is specified to trigger the request for more data once the FIFO has been drained enough to receive ulMaxPacketSize more bytes of data Also for OUT endpoints the USB_EP_AUTO_CLEAR bit can be used to clear the data packet ready flag automatically once the data has been read from the FIFO If this is not used this flag must be manually cleared via a call to USBDevEndpointStatusClear Both of these settings can be used to remove the need for extra calls when using the controller in DMA mode Note This function should only be called in device mode Returns None January 11 2011 361 USB Controller 24 3 2 7 USBDevEndpointDataAck Acknowledge that data was read from the given endpoint s FIFO in device mode Prototype void USBDevEndpointDataAck unsigned long ulBase unsigned long ulEndpoint tBoolean bIsLastPacket Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access blsLastPacket indicates if this is the last packet Description This function acknowledges that the data was read from th
451. tion This function will query the control registers of the Ethernet controller and return a bit mapped configuration value See also The description of the EthernetConfigSet function provides detailed information for the bit mapped configuration values that will be returned Returns Returns the bit mapped Ethernet controller configuration value EthernetConfigSet Sets the configuration of the Ethernet controller Prototype void EthernetConfigSet unsigned long ulBase unsigned long ulConfig Parameters ulBase is the base address of the controller ulConfig is the configuration for the controller Description After the EthernetlnitExpClk function has been called this API function can be used to con figure the various features of the Ethernet controller The Ethernet controller provides three control registers that are used to configure the con troller s operation The transmit control register provides settings to enable full duplex opera tion to auto generate the frame check sequence and to pad the transmit packets to the min imum length as required by the IEEE standard The receive control register provides settings to enable reception of packets with bad frame check sequence values and to enable multi cast or promiscuous modes The timestamp control register provides settings that enable support logic in the controller that allow the use of the General Purpose Timer 3 to capture timestamps for the
452. tion to avoid returning from the interrupt handler before the interrupt source is actually cleared Failure to do so may result in the interrupt handler being immediately reentered because the interrupt controller still sees the interrupt source asserted Returns None QElIntDisable Disables individual quadrature encoder interrupt sources Prototype void QEIIntDisable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base address of the quadrature encoder module ullntFlags is a bit mask of the interrupt sources to be disabled Can be any of the QEI_INTERROR QEL INTDIR QEL INTTIMER or QEI_INTINDEX values Description Disables the indicated quadrature encoder interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor January 11 2011 241 Quadrature Encoder QE 17 2 2 8 17 2 2 9 242 Returns None QEllIntEnable Enables individual quadrature encoder interrupt sources Prototype void QEIIntEnable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base address of the quadrature encoder module ullntFlags is a bit mask of the interrupt sources to be enabled Can be any of the QEI_INTERROR QEI_INTDIR QEI_INTTIMER or QEI_INTINDEX values Description Enables the indicated quadrature encoder interrupt sources Only the sources that are en
453. tively the I2C slave can handle transactions using an interrupt handler registered with I2CIntRegister and by enabling the 12C slave interrupt This driver is contained in driverlib i2c c with driverlib i2c h containing the API defi nitions for use by applications API Functions Functions void I2CIntRegister unsigned long ulBase void pfnHandler void void I2CIntUnregister unsigned long ulBase tBoolean 2CMasterBusBusy unsigned long ulBase tBoolean 2CMasterBusy unsigned long ulBase void I2CMasterControl unsigned long ulBase unsigned long ulCmd unsigned long 2CMasterDataGet unsigned long ulBase void I2CMasterDataPut unsigned long ulBase unsigned char ucData void I2CMasterDisable unsigned long ulBase void I2CMasterEnable unsigned long ulBase unsigned long 2CMasterErr unsigned long ulBase void 2CMaster nitExpClk unsigned long ulBase unsigned long ull2CClk tBoolean bFast void I2CMasterlntClear unsigned long ulBase void I2CMasterlIntDisable unsigned long ulBase void I2CMasterlntEnable unsigned long ulBase tBoolean 2CMasiterIntStatus unsigned long ulBase tBoolean bMasked void 2CMasterSlaveAddrSet unsigned long ulBase unsigned char ucSlaveAddr tBoolean bReceive January 11 2011 Inter Integrated Circuit 12C unsigned long 2CSlaveDataGet unsigned long ulBase void I2CSlaveDataPut unsigned long ulBase unsigned char ucData void I2CSlaveDisable unsigned long ulBase void
454. to disable Description This function will disable the control interrupts for the USB controller specified by the u Base parameter The u Flags parameter specifies which control interrupts to disable The flags passed in the u Flags parameters should be the definitions that start with USB_INTCTRL_ and not any other USB_INT flags Returns None 24 3 2 48 USBIntDisableEndpoint Disable endpoint interrupts on a given USB controller Prototype void USBIntDisableEndpoint unsigned long ulBase unsigned long ulFlags Parameters ulBase specifies the USB module base address ulFlags specifies which endpoint interrupts to disable Description This function will disable endpoint interrupts for the USB controller specified by the u Base parameter The u Flags parameter specifies which endpoint interrupts to disable The flags passed in the u Flags parameters should be the definitions that start with USB_INTEP_ and not any other USB_INT flags Returns None 24 3 2 49 USBIntEnable Enables the sources for USB interrupts Prototype void USBIntEnable unsigned long ulBase unsigned long ulFlags Parameters ulBase specifies the USB module base address 384 January 11 2011 USB Controller ulFlags specifies which interrupts to enable Description This function will enable the USB controller s ability to generate the interrupts indicated by the u Flags parameter There are three groups of
455. tput is high and false if the comparator output is low Programming Example The following example shows how to use the comparator API to configure the comparator and read its value Configure the internal voltage reference ComparatorRefSet COMP_BASE COMP_REF_1_65V Configure comparator 0 ComparatorConfigure COMP_BASE 0 COMP_TRIG_NONE COMP_INT_BOTH COMP_ASRCP_REF COMP_OUTPUT_NORMAL Delay for some time Read the comparator output value ih ComparatorValueGet COMP_BASE 0 January 11 2011 19 Analog Comparator 20 January 11 2011 4 1 Analog to Digital Converter ADC Analog to Digital Converter ADC PRET HON wack casicestetdataie a hans eaa a aa a deere eenndieater bpaanketad 21 Vet A ROS ana aA a a Rot ACen a Ca 22 Pregramnimmo ExamMPS sorrento E E RE 40 Introduction The analog to digital converter ADC API provides a set of functions for dealing with the ADC Functions are provided to configure the sample sequencers read the captured data register a sample sequence interrupt handler and handle interrupt masking clearing The ADC supports up to eight input channels plus an internal temperature sensor Four sampling sequences each with configurable trigger events can be captured The first sequence will capture up to eight samples the second and third sequences will capture up to four samples and the fourth sequence will capture a single
456. transmitted and received packets The ulConfig parameter is the logical OR of the following values m ETH_CFG_TS_TSEN Enable TX and RX interrupt status as CCP timer inputs January 11 2011 71 Ethernet Controller 6 2 2 3 6 2 2 4 72 ETH_CFG_RX_BADCRCDIS Disable reception of packets with a bad CRC ETH_CFG_RX_PRMSEN Enable promiscuous mode reception all packets ETH_CFG_RX_AMULEN Enable reception of multicast packets ETH_CFG_TX_DPLXEN Enable full duplex transmit mode ETH_CFG_TX_CRCEN Enable transmit with auto CRC generation ETH_CFG_TX_PADEN Enable padding of transmit data to minimum size These bit mapped values are programmed into the transmit receive and or timestamp control register Returns None EthernetDisable Disables the Ethernet controller Prototype void EthernetDisable unsigned long ulBase Parameters ulBase is the base address of the controller Description When terminating operations on the Ethernet interface this function should be called This function will disable the transmitter and receiver and will clear out the receive FIFO Returns None EthernetEnable Enables the Ethernet controller for normal operation Prototype void EthernetEnable unsigned long ulBase Parameters ulBase is the base address of the controller Description Once the Ethernet controller has been configured using the EthernetConfigSet function and the MAC address has been
457. tration is used then the IntEnable function with the parameter FAULT_MPU must be used to enable the memory management fault handler When the memory management fault handler has been installed with MPUIntRegister it can be removed by calling MPUIntUnregister Function Documentation MPUDisable Disables the MPU for use Prototype void MPUDisable void Description This function disables the Cortex M3 memory protection unit When the MPU is disabled the January 11 2011 Memory Protection Unit MPU default memory map is used and memory management faults are not generated Returns None 14 2 2 2 MPUEnable Enables and configures the MPU for use Prototype void MPUEnable unsigned long ulMPUConfig Parameters ulMPUConfig is the logical OR of the possible configurations Description This function enables the Cortex M3 memory protection unit It also configures the default behavior when in privileged mode and while handling a hard fault or NMI Prior to enabling the MPU at least one region must be set by calling MPURegionSet or else by enabling the default region for privileged mode by passing the MPU_CONFIG_PRIV_DEFAULT flag to MPUEnable Once the MPU is enabled a memory management fault will be generated for any memory access violations The ulMPUConfig parameter should be the logical OR of any of the following MPU_CONFIG_PRIV_DEFAULT enables the default memory map when in privileged mode
458. trol void UDMAChannelDisable unsigned long ulChannelNum void UDMAChannelEnable unsigned long ulChannelNum tBoolean uUDMAChannellsEnabled unsigned long ulChannelNum unsigned long UDMAChannelModeGet unsigned long ulChannelStructIndex void UDMAChannelRequest unsigned long ulChannelNum void UDMAChannelScatterGatherSet unsigned long ulChannelNum unsigned ulTaskCount void pvTaskList unsigned long ullsPeriphSG void UDMAChannelSelectDefault unsigned long ulDefPeriphs void UDMAChannelSelectSecondary unsigned long ulSecPeriphs unsigned long UDMAChannelSizeGet unsigned long ulChannelStructlIndex void uUDMAChannelTransferSet unsigned long ulChannelStructIndex unsigned long ulMode void pvSrcAddr void xpvDstAddr unsigned long ulTransferSize void x uUDMAControlAlternateBaseGet void void x UDMAControlBaseGet void void uDMAControlBaseSet void pControlTable void uUDMADisable void void UDMAEnable void void uUDMAErrorStatusClear void unsigned long UDMAErrorStatusGet void void uDMAIntRegister unsigned long ullntChannel void pfnHandler void void uDMAIntUnregister unsigned long ullntChannel January 11 2011 23 2 1 uDMA Controller Detailed Description The uDMA API functions provide a means to enable and configure the Stellaris microDMA controller to perform DMA transfers The general order of function calls to set up and perform a uDMA transfer is the following m uDMAEnable is ca
459. ts external power control pins USBnPFTL and USBnEPEN The flags specify the power fault level sensitivity the power fault action and the power enable level and source One of the following can be selected as the power fault level sensitivity USB_HOST_PWRFLT_LOW An external power fault is indicated by the pin being driven low USB_HOST_PWRFLT_HIGH An external power fault is indicated by the pin being driven high One of the following can be selected as the power fault action USB_HOST_PWRFLT_EP_NONE No automatic action when power fault detected USB_HOST_PWRFLT_EP_TRI Automatically Tri state the USBnEPEN pin on a power fault USB_HOST_PWRFLT_EP_LOW Automatically drive USBnEPEN pin low on a power fault USB_HOST_PWRFLT_EP_HIGH Automatically drive USBnEPEN pin high on a power fault One of the following can be selected as the power enable level and source USB_HOST_PWREN_MAN_LOW USBEPEN is driven low by the USB controller when USBHostPwrEnable is called USB_HOST_PWREN_MAN_HIGH USBEPEN is driven high by the USB controller when USBHostPwrEnable is called USB_HOST_PWREN_AUTOLOW USBEPEN is driven low by the USB controller auto matically if USBOTGSessionRequest has enabled a session USB_HOST_PWREN_AUTOHIGH USBEPEN is driven high by the USB controller auto matically if USBOTGSessionRequest has enabled a session On devices that support the VBUS glitch filter the USB_HOST_PWREN_FILTE
460. turns None ADCComparatorIntDisable Disables a sample sequence comparator interrupt Prototype void ADCComparatorIntDisable unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description This function disables the requested sample sequence comparator interrupt Returns None ADCComparatorIntEnable Enables a sample sequence comparator interrupt Prototype void ADCComparatorIntEnable unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description This function enables the requested sample sequence comparator interrupt Returns None January 11 2011 25 Analog to Digital Converter ADC 4 2 2 5 4 2 2 6 4 2 2 7 26 ADCComparatorintStatus Gets the current comparator interrupt status Prototype unsigned long ADCComparatorIntStatus unsigned long ulBase Parameters ulBase is the base address of the ADC module Description This returns the digitial comparator interrupt status bits This status is sequence agnostic Returns The current comparator interrupt status ADCComparatorRegionSet Defines the ADC digital comparator regions Prototype void ADCComparatorRegionSet unsigned long ulBase unsigned long ulComp unsigned long ulLowRef unsigned long
461. tus bits in this endpoint in host mode Prototype void USBHostEndpointStatusClear unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulFlags are the status bits that will be cleared Description This function will clear the status of any bits that are passed in the u Flags parameter The ulFlags parameter can take the value returned from the USBEndpointStatus call Note This function should only be called in host mode Returns None 24 3 2 32 USBHostHubAddrGet Get the current device hub address for this endpoint Prototype unsigned long USBHostHubAddrGet unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access ulFlags determines if this is an IN or an OUT endpoint Description This function will return the current hub address that an endpoint is using to communicate with a device The u Flags parameter determines if the device address for the IN or OUT endpoint is returned Note This function should only be called in host mode Returns This function returns the current hub address being used by an endpoint January 11 2011 USB Controller 24 3 2 33 USBHostHubAddrSet Set the hub address for the device that is connected to an endpoint
462. type void USBIntEnableEndpoint unsigned long ulBase unsigned long ulFlags January 11 2011 385 USB Controller Parameters ulBase specifies the USB module base address ulFlags specifies which endpoint interrupts to enable Description This function will enable endpoint interrupts for the USB controller specified by the u Base parameter The u Flags parameter specifies which endpoint interrupts to enable The flags passed in the u Flags parameters should be the definitions that start with USB_INTEP_ and not any other USB_INT flags Returns None 24 3 2 52 USBIntRegister Registers an interrupt handler for the USB controller Prototype void USBIntRegister unsigned long ulBase void pfnHandler void Parameters ulBase specifies the USB module base address pfnHandler is a pointer to the function to be called when a USB interrupt occurs Description This sets the handler to be called when a USB interrupt occurs This will also enable the global USB interrupt in the interrupt controller The specific desired USB interrupts must be enabled via a separate call to USBIntEnable It is the interrupt handler s responsibility to clear the interrupt sources via a calls to USBIntStatusControl and USBIntStatusEndpoint See also IntRegister for important information about registering interrupt handlers Returns None 24 3 2 53 USBiIntStatus Returns the status of the US
463. uf is the pointer to the packet buffer IBufLen is the maximum number of bytes to be read into the buffer Description This function reads a packet from the receive FIFO of the controller and places it into pucBuf If no packet is available the function will return immediately Otherwise the function will read the entire packet from the receive FIFO If there are more bytes in the packet than will fit into pucBuf as specified by BufLen the function will return the negated length of the packet and the buffer will contain BufLen bytes of the packet Otherwise the function will return the length of the packet that was read and pucBuf will contain the entire packet excluding the frame check sequence bytes This function replaces the original EthernetPacketNonBlockingGet API and performs the same actions A macro is provided in ethernet h to map the original API to this API Note This function will return immediately if no packet is available Returns Returns 0 if no packet is available the negated packet length n if the packet is too large for pucBuf and the packet length n otherwise EthernetPacketPut Waits to send a packet from the Ethernet controller Prototype long EthernetPacketPut unsigned long ulBase unsigned char xpucBuf long 1BufLen Parameters ulBase is the base address of the controller pucBuf is the pointer to the packet buffer IBufLen is number of bytes in the packet to be transmitted De
464. ulBase Parameters ulBase is the base address of the PWM module Description This function will remove the interrupt handler for a PWM fault interrupt from the selected PWM module This function will also disable the PWM fault interrupt in the NVIC the PWM fault interrupt must also be disabled at the module level using PWMIntDisable See also IntRegister for important information about registering interrupt handlers Returns None PWMGenConfigure Configures a PWM generator Prototype void PWMGenConfigure unsigned long ulBase unsigned long ulGen unsigned long ulConfig Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to configure Must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_ 2 or PWM_GEN_3 ulConfig is the configuration for the PWM generator January 11 2011 Pulse Width Modulator PWM Description January 11 2011 This function is used to set the mode of operation for a PWM generator The counting mode synchronization mode and debug behavior are all configured After configuration the genera tor is left in the disabled state A PWM generator can count in two different modes count down mode or count up down mode In count down mode it will count from a value down to zero and then reset to the preset value This will produce left aligned PWM signals that is the rising edge of the two PWM signals produced by the generator will occur at th
465. ulHighRef Parameters ulBase is the base address of the ADC module ulComp is the index of the comparator to configure ulLowRef is the reference point for the low mid band threshold ulHighRef is the reference point for the mid high band threshold Description The ADC digital comparator operation is based on three ADC value regions a low band is defined as any ADC value less than or equal to the ulLowRef value mid band is defined as any ADC value greater than the ulLowRef value but less than or equal to the ulHighRef value high band is defined as any ADC value greater than the u HighRef value Returns None ADCComparatorReset Resets the current ADC digital comparator conditions January 11 2011 4 2 2 8 Analog to Digital Converter ADC Prototype void ADCComparatorReset unsigned long ulBase unsigned long ulComp tBoolean bTrigger tBoolean biInterrupt Parameters ulBase is the base address of the ADC module ulComp is the index of the comparator bTrigger is the flag to indicate reset of Trigger conditions bInterrupt is the flag to indicate reset of Interrupt conditions Description Because the digital comparator uses current and previous ADC values this function is provide to allow the comparator to be reset to its initial value to prevent stale data from being used when a sequence is enabled Returns None ADCHardwareOversampleConfigure Configures the hardware ove
466. uld be called before attempting to call this function January 11 2011 22 2 2 5 22 2 2 6 22 2 2 UART UARTCharPut Waits to send a character from the specified port Prototype void UARTCharPut unsigned long ulBase unsigned char ucData Parameters ulBase is the base address of the UART port ucData is the character to be transmitted Description Sends the character ucData to the transmit FIFO for the specified port If there is no space available in the transmit FIFO this function waits until there is space available before returning Returns None UARTCharPutNonBlocking Sends a character to the specified port Prototype tBoolean UARTCharPutNonBlocking unsigned long ulBase unsigned char ucData Parameters ulBase is the base address of the UART port ucData is the character to be transmitted Description Writes the character ucData to the transmit FIFO for the specified port This function does not block so if there is no space available then a false is returned and the application must retry the function later This function replaces the original UARTCharNonBlockingPut API and performs the same actions A macro is provided in uart h to map the original API to this API Returns Returns true if the character was successfully placed in the transmit FIFO or false if there was no space available in the transmit FIFO UARTCharsAvail Determines if there are any characters in the re
467. up to UDMA_ARB_ 1024 This is used to select the arbitration size in powers of 2 from 1 to 1024 The ulMode parameter is the mode to use for this transfer task It must be one of UDMA_MODE_BASIC UDMA_MODE_AUTO UDMA_MODE_MEM_SCATTER_GATHER or UDMA_MODE_PER_SCATTER_GATHER Note that normally all tasks will be one of the scatter gather modes while the last task is a task list will be AUTO or BASIC This macro is intended to be used to initialize individual entries of a structure of tDMACon trolTable type like this tDMAControlTable MyTaskList uDMATaskStructEntry TasklCount UDMA_SIZE_8 UDMA_SRC_INC_8 MySourceBuf UDMA_DST_INC_8 MyDestBuf UDMA_ARB_8 UDMA_MODE_MEM_SCATTER_GATHER uDMATaskStructEntry Task2Count Sg Uday Returns Nothing this is not a function 23 2 3 Function Documentation 23 2 3 1 uDMAChannelAttributeDisable Disables attributes of a uDMA channel Prototype void uDMAChannelAttributeDisable unsigned long ulChannelNum unsigned long ulAttr Parameters 336 ulChannelNum is the channel to configure ulAttr is a combination of attributes for the channel January 11 2011 uDMA Controller Description This function is used to disable attributes of a UDMA channel The ulAttr parameter is the logical OR of any of the following UDMA_ATTR_USEBURST is used to restrict transfers to use only a burst mode UDMA_ATTR_ALTSELECT is used to select the alternate contro
468. upt source via TimerIntClear See also IntRegister for important information about registering interrupt handlers Returns None 21 2 2 13 TimerlntStatus Gets the current interrupt status Prototype unsigned long TimerIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the base address of the timer module bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required Description This returns the interrupt status for the timer module Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned Returns The current interrupt status enumerated as a bit field of values described in TimerlntEnable 21 2 2 14 TimerlntUnregister Unregisters an interrupt handler for the timer interrupt Prototype void TimerIntUnregister unsigned long ulBase unsigned long ulTimer Parameters ulBase is the base address of the timer module ulTimer specifies the timer s must be one of TIMER_A TIMER_B or TIMER_BOTH January 11 2011 299 Timer Description This function will clear the handler to be called when a timer interrupt occurs This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for important information about registering interrupt handlers Returns None 21 2 2 15 TimerLoad
469. use the Quadrature Encoder API to configure the quadrature encoder read back an absolute position Configure the quadrature encoder to capture edges on both signals and maintain an absolute position by resetting on index pulses Using a 1000 line encoder at four edges per line there are 4000 pulses per revolution therefore set the maximum position to 3999 since the count is zero based QETConfigure QEI_BASE QEI_CONFIG_CAPTURE_A_B QEI_CONFIG_RESET_IDX QEI_CONFIG_QUADRATURE QEI_CONFIG_NO_SWAP 3999 Enable the quadrature encoder QEIEnable QEI_BASE Delay for some time Read the encoder position QETPositionGet QEI_BASE January 11 2011 Synchronous Serial Interface SS 18 Synchronous Serial Interface SSI li ea ole ste eee ee ee ae eee kere ean e eet eee nn rene tees Lon meee ete ees Cee ee eee ten ee AET 247 POM CHONS chccccc dag vonerenietnethealewet i ewsricekdd gual ee uleadaben sie euer wesidaie ete eaew ees 247 Programming ERIN DIE ccc sornnenaeceiapisen edd caecagemeeertGagenecEsepeyersouquenecseebedtqneeemantar 256 18 1 Introduction The Synchronous Serial Interface SSI module provides the functionality for synchronous serial communications with peripheral devices and can be configured to use either the Motorola SPI National Semiconductor Microwire or the Texas Instruments synchronous serial interface frame formats The s
470. uses a pre loaded vector table in flash then the CAN controller handler should be entered in the appropriate slot in the vector table In this case CANIntRegister is not needed but the interrupt will need to be enabled on the host processor master interrupt controller using the IntEnable function The CAN module interrupts are enabled using the CANIntEnable function They can be disabled by using the CANIntDisable function Once CAN interrupts are enabled the handler will be invoked whenever a CAN interrupt is triggered The handler can determine which condition caused the interrupt by using the CANIntStatus func tion Multiple conditions can be pending when an interrupt occurs so the handler must be designed to process all pending interrupt conditions before exiting Each interrupt condition must be cleared before exiting the handler There are two ways to do this The CANIntClear function will clear a specific interrupt condition without further action required by the handler However the handler can also clear the condition by performing certain actions If the interrupt is a status interrupt the interrupt can be cleared by reading the status register with CANStatusGet If the interrupt is caused by one of the message objects then it can be cleared by reading the message object using CANMessageGet There are several status registers that can be used to help the application manage the controller The status registers are read us
471. veral system events that when detected will cause system control to reset the device These events are the input voltage dropping too low the LDO voltage dropping too low an external January 11 2011 259 System Control 19 2 260 reset a software reset request and a watchdog timeout The properties of some of these events can be configured and the reason for a reset can be determined from system control Each peripheral in the device can be individually enabled disabled or reset Additionally the set of peripherals that remain enabled during sleep mode and deep sleep mode can be configured allowing custom sleep and deep sleep modes to be defined Care must be taken with deep sleep mode though since in this mode the PLL is no longer used and the system is clocked by the input crystal Peripherals that depend upon a particular input clock rate such as a UART will not operate as expected in deep sleep mode due to the clock rate change these peripherals must either be reconfigured upon entry to and exit from deep sleep mode or simply not enabled in deep sleep mode There are various system events that when detected will cause system control to generate a processor interrupt These events are the PLL achieving lock the internal LDO current limit being exceeded the internal oscillator failing the main oscillator failing the input voltage dropping too low the internal LDO voltage dropping too low and the PLL failing Each of th
472. versampleDataGet unsigned long ulBase unsigned long ulSequenceNum unsigned long xpulBuffer unsigned long ulCount Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number pulBuffer is the address where the data is stored ulCount is the number of samples to be read Description This function copies data from the specified sample sequence output FIFO to a memory resi dent buffer with software oversampling applied The requested number of samples are copied into the data buffer if there are not enough samples in the hardware FIFO to satisfy this many oversampled data items then incorrect results will be returned It is the callers responsibility to read only the samples that are available and wait until enough data is available for example as a result of receiving an interrupt Returns None ADCSoftwareOversampleStepConfigure Configures a step of the software oversampled sequencer Prototype void ADCSoftwareOversampleStepConfigure unsigned long ulBase unsigned long ulSequenceNum unsigned long ulStep unsigned long ulConfig Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number ulStep is the step to be configured ulConfig is the configuration of this step Description This function configures a step of the sample sequencer when using the software oversam pling feature The number of steps availa
473. vileged read write user read write MPU_RGN_PERM_PRV_RO_USR_NO privileged read only user no access MPU_RGN_PERM_PRV_RO_USR_RO privileged read only user read only The region is automatically divided into 8 equally sized sub regions by the MPU Sub regions can only be used in regions of size 256 bytes or larger Any of these 8 sub regions can be disabled This allows for creation of holes in a region which can be left open or overlaid by another region with different attributes Any of the 8 sub regions can be disabled with a logical OR of any of the following flags MPU_SUB_RGN_DISABLE_0 MPU_SUB_RGN_DISABLE_1 MPU_SUB_RGN_DISABLE_2 MPU_SUB_RGN_DISABLE_3 MPU_SUB_RGN_DISABLE_4 MPU_SUB_RGN_DISABLE_5 MPU_SUB_RGN_DISABLE_6 MPU_SUB_RGN_DISABLE_7 Finally the region can be initially enabled or disabled with one of the following flags MPU_RGN_ENABLE MPU_RGN_DISABLE January 11 2011 203 Memory Protection Unit MPU As an example to set a region with the following attributes size of 32 KB execution en abled read only for both privileged and user one sub region disabled and initially enabled the u Flags parameter would have the following value MPU_RG_SIZE_32K MPU_RGN_PERM_EXEC MPU_RGN_PERM_PRV_RO_USR_RO MPU_SUB_RGN_DISABLE_2 MPU_RGN_ENABLE T Note This function will write to multiple registers and is not protected from interrupts It is possible that an interrupt which a
474. void USBHost Suspend unsigned long ulBase Parameters ulBase specifies the USB module base address Description When used in host mode this function will put the USB bus in the suspended state Note This function should only be called in host mode Returns None 24 3 2 46 USBIntDisable Disables the sources for USB interrupts Prototype void USBIntDisable unsigned long ulBase unsigned long ulFlags Parameters ulBase specifies the USB module base address ulFlags specifies which interrupts to disable Description This function will disable the USB controller from generating the interrupts indicated by the ulFlags parameter There are three groups of interrupt sources IN Endpoints OUT End points and general status changes specified by USB_INT_HOST_IN USB_INT_HOST_OUT USB_INT_DEV_IN USB_INT_DEV_OUT and USB_INT_STATUS If USB_INT_ALL is spec ified then all interrupts will be disabled Note WARNING This API cannot be used on endpoint numbers greater than endpoint 3 so USBInt DisableControl or USBIntDisableEndpoint should be used instead Returns None 24 3 2 47 USBIntDisableControl Disable control interrupts on a given USB controller January 11 2011 383 USB Controller Prototype void USBIntDisableControl unsigned long ulBase unsigned long ulFlags Parameters ulBase specifies the USB module base address ulFlags specifies which control interrupts
475. w the brown out control operates It can detect a brown out by looking at only the brown out output or it can wait for it to be active for two consecutive samples separated by a configurable time When it detects a brown out condition it can either reset the device or generate a processor interrupt Returns None 19 2 2 4 SysCtlClkVerificationClear Clears the clock verification status Prototype void SysCt1lclkVerificationClear void Description This function clears the status of the clock verification timers allowing them to assert another failure if detected The clock verification timers are only available on Sandstorm class devices Returns None 19 2 2 5 SysCtlClockGet Gets the processor clock rate Prototype unsigned long SysCt1ClockGet void Description This function determines the clock rate of the processor clock This is also the clock rate of all the peripheral modules with the exception of PWM which has its own clock divider January 11 2011 263 System Control Note This will not return accurate results if SysCtlClockSet has not been called to configure the clocking of the device or if the device is directly clocked from a crystal or a clock source that is not one of the supported crystal frequencies In the later case this function should be modified to directly return the correct system clock rate Returns The processor clock rate 19 2 2 6 SysCtlClockSet Sets the cloc
476. x lt 4 ulIdx MPURegionSet uIdx ulRegionAddr uIdx ulRegionAttr ulIdx 206 January 11 2011 Peripheral Pin Mapping 15 Peripheral Pin Mapping li e lel pe eee eee ee are eee ree ane ee tain T tee e Len ree Teeter eee cee ene ete eter ee ee ite 207 RP PONCHO chceccc daar voseianieimeealwetieesriaekddauci ee ulea dates sie euer Wwe adaee wee dies 207 Pregrammmg ERIN DIE ccc sarnrenaeceiapisew edd caeeagemeeeriGagenecEaepesarsouquenecheebedeoregemaeher 213 15 1 Introduction The peripheral pin mapping functions provide an easy method of configuring a peripheral pin with out having to know which GPIO pin is shared with the peripheral pin This makes peripheral pin configuration easier and clearer since the pin can be specified by the peripheral pin name instead of the GPIO name which may be error prone The mapping of peripheral pins to GPIO pins varies from part to part meaning that the associated definitions change based on the part being used The part to be used can be specified in two ways either via an explicit define in the source code or via a definition provided to the compiler Using a define is very direct but not very flexible Using a definition provided to the compiler is not as explicit since it does not appear clearly in the source code but is much more flexible The real value of the peripheral pin mapping functions is the ability to share a piece of peripheral configura tion control code between projects
477. y be called in device mode Returns None January 11 2011 359 USB Controller 24 3 2 4 USBDevDisconnect Removes the USB controller from the bus in device mode Prototype void USBDevDisconnect unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function will cause the soft connect feature of the USB controller to remove the device from the USB bus A call to USBDevConnect is needed to reconnect to the bus Note This function should only be called in device mode Returns None 24 3 2 5 USBDevEndpointConfigGet Gets the current configuration for an endpoint Prototype void USBDevEndpointConfigGet unsigned long ulBase unsigned long ulEndpoint unsigned long pulMaxPacketSize unsigned long xpulFlags Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access pulMaxPacketSize is a pointer which will be written with the maximum packet size for this endpoint pulFlags is a pointer which will be written with the current endpoint settings On entry to the function this pointer must contain either USB_EP_DEV_IN or USB_EP_DEV_OUT to indicate whether the IN or OUT endpoint is to be queried Description This function will return the basic configuration for an endpoint in device mode The values re turned in xpulMaxPacketSize and pulFlags are equivalent to the u MaxPacketSize and ulFlags previously passed to
478. y the current set of inputs that contribute towards the generation of a fault condition to a given PWM generator Note This function is only available on devices supporting extended PWM fault handling Returns Returns the current fault triggers configured for the fault group provided For PWM_FAULT_GROUP_ the returned value will be a logical OR of PWM_FAULT_FAULTO PWM_FAULT_FAULT1 PWM_FAULT_FAULT2 or PWM_FAULT_FAULTS For PWM_FAULT_GROUP_1 the return value will be the logical OR of PWM_FAULT_DCMPoO PWM_FAULT_DCMP1 PWM_FAULT_DCMP2 PWM_FAULT_DCMP3 PWM_FAULT_DCMP4 PWM_FAULT_DCMP5 PWM_FAULT_DCMP6 or PWM_FAULT_DCMP7 16 2 2 14 PWMGenFaultTriggerSet Configures the set of fault triggers for a given PWM generator Prototype void PWMGenFaultTriggerSet unsigned long ulBase unsigned long ulGen unsigned long ulGroup unsigned long ulFaultTriggers Parameters ulBase is the base address of the PWM module ulGen is the PWM generator whose fault triggers are being set Must be one of PWM_GEN_ 0 PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 ulGroup indicates the subset of possible faults that are to be configured This must be PWM_FAULT_GROUP_0 or PWM_FAULT_GROUP_1 January 11 2011 225 Pulse Width Modulator PWM ulFaultTriggers defines the set of inputs that are to contribute towards generation of the fault signal to the given PWM generator For PWM_FAULT_GROUP_ this will be the log ical OR of PWM_FAULT_FAULTO
479. ys to use the read write interface When an application is writing to the mapped memory or peripheral space the writes will stall the processor until the write to the external interface is completed However the EPI contains an internal transaction FIFO and can buffer up to 4 pending writes without stalling the processor Prior to writing the application can test to see if the EPI can take more write operations without stalling the processor by using the function EPINonBlockingWriteCount which will return the number of non blocking writes that can be made For efficient reads from the external device the EPI contains a programmable read FIFO This can be used to set a starting address and a count and the FIFO will perform sequential reads from the device and store the values in the FIFO The application can then periodically drain the FIFO either by polling or by interrupts or by using the uDMA controller A non blocking read is configured by using the function EPINonBlockingReadCOnfigure The read operation is started with EPINonBlockingReadStart and can be stopped by calling EPINonBlockingReadStop The function EPINonBlockingReadCount can be used to determine the number of items remaining to be read while the function EPINonBlockingReadAvail returns the number of items in the FIFO that can be read immediately without stalling There are 3 functions available for reading data January 11 2011 1 2 2 7 2 2 1 External Peripheral I

Stellaris Peripheral Driver Library User's Guide

Contents

Download Pdf Manuals

Related Search

Related Contents