Home

Stellaris Peripheral Driver Library User's Guide

1. 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 September 05 2012 103 Ethernet Controller EthernetEnable ETH_BASE Send a packet assume that the packet has been filled in appropriately elsewhere in the code EthernetPacketPut ETH_BASE pucMyTxPacket ulMyTxPacketLength Wait for a packet to come in Lf EthernetPacketGet ETH_BASE pucMyRxPacket sizeof pucMyRxPacket 104 September 05 2012 8 8 1 8 2 External Peripheral Interface EP External Peripheral Interface EPI MRT SOT maneia aa aa a debe aati Sed adeeb e ada neheb tenes 105 APOPO ROIS 6 tancaee ec aah oleate aia es bh sunt ca as oe een been aed e enue edie oeaew es 105 Programming Example ccc sarnnenaeceianisen edd cameagemeeentbagenecEaepesarsouqueneebeebedsaieennaedas 121 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 memori
2. 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 September 05 2012 337 Synchronous Serial Interface SSI 23 2 2 7 23 2 2 8 338 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 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 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 the SSI interface Description This function places the supplied data into the transmit FIFO of the specified SSI module If there is no space available in the transmit FIFO this function
3. 2 2004 11 Floating Point Unit FPU 4 TLT DMEOJUSHON sooie eee e a ae eR RE RMR AS TL2 APIFUNCIODS 6 4 0 2 4 eae eR ae Oe KR OE aed 11 3 Programming Example 2222 04 September 05 2012 Table of Contents Table of Contents 12 12 1 12 2 12 3 13 13 1 13 2 13 3 14 14 1 14 2 14 3 15 191 15 2 15 3 16 16 1 16 2 16 3 17 17 1 17 2 18 18 1 18 2 18 3 19 19 1 19 2 20 20 1 20 2 20 3 21 21 1 elie 21 3 22 22 1 PRZ 22 3 23 23 1 23 2 23 3 24 24 1 OPI eee eter ee ee a ie ee a a ee we ae de a dt al dae A 151 WES ING o eee ee ge a ek oe a ee a ee ke ee KR ee ee 151 API FONCIONS 3 2 dice ar kee aa ar we haw aaa eat ee ee bees Sok ee hk he ek di aaa 152 Progamming Example e sa eaa REE EAM A ww oo Pe A aa ee E 176 Hibernation Module 5 255 606000008 GRR ee ee 179 WWEPGISNOM i ale a wen de Be ee Os ee ew ee SE we 179 API FONCIONS o ce eg tea eae Ae ee WR ew a eee oa GON De hee oe ES 179 Programming Example lt a sssr rask RY MESA AGS AR E aaa ee Par eee 4 197 Inter Integrated Circuit I2C 2 2 es 201 MEMO ci ve erica 42d aea telat on Ie a a ees ee ee cee JB Gok ee ge Ma es 201 PP PURVIS a ice 3 5 eve ey eee we ed eae Ba eh a a i a 202 Programming Example ea dick ach Se RAR ww Been Pa Aa A E 221 iieriG Sound 25 noe crs bb a war ees we Pe ee a ee me ee A 223 WVESCUECRIOIN ots dois Ok Rae Se a ee OO A ew lr oo OE A 2
4. Parameters ulBase specifies the LPC 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 LPC module Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned The interpretation of the LPC_INT_CHhn fields varies based on the type value programed for the specific Channel See also The description of the LPCIntEnable function provides detailed information for the bit mapped values returned by this function Returns The current interrupt status 17 2 1 28 LPCintUnregister Unregisters an interrupt handler for the LPC module Prototype void LPCIntUnregister unsigned long ulBase Parameters ulBase specifies the LPC module base address 264 September 05 2012 Low Pin Count Interface LPC Description This function unregisters the handler to be called when an LPC interrupt occurs This fucntion also masks 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 17 2 1 29 LPCIRQClear Clear the manual LPC IRQ bits Prototype void LPCIROQClear unsigned long ulBase unsigned long ulIRQ Parameters ulBase specifies the LPC module base address
5. Modem control flow control IrDA serial IR SIR encoder decoder m DMA interface m 9 bit operation 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 UART9BitAddrSend unsigned long ulBase unsigned char ucAddr m void UART9BitAddrSet unsigned long ulBase unsigned char ucAddr unsigned char ucMask m void UART9BitDisable unsigned long ulBase m void UART9BitEnable unsigned long ulBase m void UARTBreakCtl unsigned long ulBase tBoolean bBreakState m Boolean UARTBusy unsigned long ulBase September 05 2012 409 UART 410 long UARTCharGet unsigned long ulBase long UARTCharGetNonBlocking unsigned long ulBase void UARTCharPut unsigned long ulBase unsigned char ucData tBoolean UARTCharPutNonBlocking unsigned long ulBase unsigned char ucData tBoolean UARTCharsAvail unsigned long ulBase unsigned long UARTClockSourceGet unsigned long ulBase void UARTClockSourceSet unsigned long ulBase unsigned long ulSource void UARTConfigGetExpClk unsigned long ulBase unsigned long ulUARTClk unsigned long pulBaud unsigned long pulConfig void UARTConfigSetExpClk unsigned long ulBase unsigned long ulUARTClk unsigned long ulBaud unsigned long ulConfig void UART Disable unsigned long ulBase void UARTDisableSIR unsigned long ulBase void UARTDMADisable unsigned long ulBase unsigned long ulDM
6. SysCtlPeripheralEnable unsigned long ulPeripheral September 05 2012 363 System Control Parameters ulPeripheral is the peripheral to enable Description This function enables peripherals At power up all peripherals are disabled they must be enabled in order to operate or respond to register reads writes The ulPeripheral ing values SYSCTL_PERIPH_CANO SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_EEPROMO SYSCTL_PERIPH_FANO SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPIOQ SYSCTL_PERIPH_12C1 SYSCTL_PERIPH_I2C4 SYSCTL_PERIPH_LPCO SYSCTL_PERIPH_PWM1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI3 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMERS SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UART5 param eter must be only SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOK SYSCTL_PERIPH_GPION SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2C2 SYSCTL_PERIPH_I2C5 SYSCTL_PERIPH_PECIO SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_UARTE6 one of the follow SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH_12CO
7. 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 This function 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 10 2 2 4 FlashiIntEnable Enables individual flash controller interrupt sources September 05 2012 137 Flash 10 2 2 5 10 2 2 6 138 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 FLASH_INT_ACCESS values Description This function 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 pfnHandler void Parameters pfnHandler is a pointer to the function to be called when the flash interrupt occurs Description This function 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
8. Prototype void PWMGenIntRegister unsigned long ulBase unsigned long ulGen void pfnIntHandler void Parameters ulBase is the base address of the PWM module ulGen is the PWM generator in question This parameter must be one of PWM_GEN_0O PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 pfnintHandler is a pointer to the function to be called when the PWM generator interrupt occurs Description This function ensures that the interrupt handler specified by pfnintHandler is called when an interrupt is detected for the specified PWM generator block This function also enables the cor responding PWM generator interrupt in the interrupt controller individual generator interrupts and interrupt sources must be enabled with PWMIntEnable and PWMGenIntTrigEnable See also IntRegister for important information about registering interrupt handlers Returns None 21 2 2 17 PWMGentIntStatus Gets interrupt status for the specified PWM generator block Prototype unsigned long PWMGenIntStatus unsigned long ulBase unsigned long ulGen tBoolean bMasked Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to query This parameter must be one of PWM_GEN_0O PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 bMasked specifies whether masked or raw interrupt status is returned Description If bMasked is set as true then the masked interrupt status is returned otherwise the raw interrupt sta
9. Prototype void SSIClockSourceSet unsigned long ulBase unsigned long ulSource Parameters ulBase is the base address of the SSI port ulSource is the baud clock source for the SSI Description This function allows the baud clock source for the SSI to be selected The possible clock source are the system clock SSI_CLOCK_SYSTEM or the precision internal oscillator SSI_CLOCK_PIOSC Changing the baud clock source changes the data rate generated by the SSI Therefore the data rate should be reconfigured after any change to the SSI clock source Note The ability to specify the SSI baud clock source varies with the Stellaris part and SSI in use Please consult the data sheet for the part in use to determine whether this support is available Returns None September 05 2012 335 Synchronous Serial Interface SSI 23 2 2 4 SSIConfigSetExpClk Configures the synchronous serial interface Prototype void SSIConfigSetExpClk unsigned long ulBase unsigned long ulSSIC1k unsigned long ulProtocol unsigned long ulMode unsigned long 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 Desc
10. 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 function determines if a sample sequence underflow has occurred Underflow happens if too many samples are read from the FIFO September 05 2012 4 2 2 30 4 2 2 31 Analog to Digital Converter ADC Returns Returns zero if there was not an underflow and non zero if there was ADCSequenceUnderflowClear Clears the underflow condition on a sample sequence 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 function clears an underflow condition on one of the sample sequencers 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 nu
11. Use this value to set the period PWMGenPeriodSet PWM_BASE PWM_GEN_0 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_0 Enable the outputs PWMOutputState PWM_BASE PWM_OUT_O_BIT PWM_OUT_1_BIT true September 05 2012 22 22 1 Quadrature Encoder QE Quadrature Encoder QEI PRET SIT anera a bie ave mi a debe ant ding De aden heed he aw aaah on Lars 323 PP PMC MOUS 6 ancaee ecaek ol EE s eet ca ea oa bone ede eae eae ocaw ae 324 Pregrammmg REIN DIE ccc sarnrematceiapisdn edd camea generar bagenecEsepegarsouqueneckeabedsqnememaadas 332 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 pul
12. ullRQ specifies the IRQ bits that should be cleared Description This function clears the IRQ bits that are sent in the SERIRQ frame The value in the ullRQ register is OR ed into the existing manual IRQ setting The value for the ullRQ parame ter can be any combination of the following values LPC_IRQ15 LPC_IRQ14 LPC_IRQ13 LPC_IRQ12 LPC_IRQ11 LPC_IRQ10 LPC_IRQ9 LPC_IRQ8 LPC_IRQ7 LPC_IRQ6 LPC_IRQ5 LPC_IRQ4 LPC_IRQ3 LPC_IRQ2 LPC_IRQ1 or LPC_IRQO Returns None 17 2 1 30 LPCIRQContfig Configure the LPC IRQ operation Prototype void LPCIRQConfig unsigned long ulBase tBoolean bIRQPulse tBoolean bIRQOnChange Parameters ulBase is the base address of the LPC module bIRQPulse is a flag to indicate the manual IRQ bits should be cleared after they have been sent in an SIRQ frame bIRQOnChange is a flag to indicate that an SIRQ frame should be sent whenever any IRQ bits manual auto change status September 05 2012 265 Low Pin Count Interface LPC Description This function configures the LPC IRQs If the b RQPulse parameter is true then manual IRQ values are cleared after they are sent If the b RQOnChange parameter is true then IRQ values manual and or automatic are sent when a change is detected Returns None 17 2 1 31 LPCIRQGet Get the configuration and status of the IRQ signals Prototype unsigned long LPCIROQGet unsigned long ulBase Parameters ulBase specifies th
13. 00022 ee eee Ql WOOUCHON 2c aa ee RR ER eee ad foe eRe ee ae ees ee APIFUNGIONS oat ma eee WEG OWE EEA oe A 3 3 Programming Example 2 2 4 44 040 Bbw eee ee es 4 Analog to Digital Converter ADC 4 1 WWOGUCHON s e a sa sate eaaa ER ee we RES 42 APIFUNCIONS oo sosida a a aia he A A A e a a a 4 3 Programming Example aoaaa a 5 Controller Area Network CAN 55 51 Inioduchon o aa saaie nessas tp Re ee aai 5 2 API FUNCIONS a ae ea eee a a ee oe EG 5 3 CAN Message Objects o oo aa 00005 eee 5 4 Programming Examples a aaau aaa aa 6 EEPROR wicker ends Sah a aa a Be 6 1 UMOOGUCHON so ke ee Ae Be ee eR RRS G62 API FUNCIONS 2 0 28 208880045 bee ewe eee 6 3 Programming Example isss 6 ee 7 Ethernet Controller 000 ee eee es YA UROOUCHON ww ee eee baad ee ak a a a a Te APLFUNCHIONS 64 40 0065 26 6c ede Hea Pee ee 7 3 Programming Example 2 2 ee 8 External Peripheral Interface EPI 8 1 MPOOUCHON s ace ace ea ae Pe RRR RRA B2 API FUNCIONS 2 2 2 8 206 68 eae Se EE ea 8 3 Programming Example 20005 9 FanConmoller 564 ces ce ee ese eee ees 9 1 UMMOOUCHON o sacs aea eh ba aaad ee che ee ewe AS 92 AP FUNCIONS 4 4 4 4 65 a ee ede aoe ee ew we we ed 9 3 Programming Example 2 0005 WO UBS eens eer Ee Rw ee aie oe a a a 10 1 IWOOGUCUGWN i eos ees Re ee eR ROR REEMA YS 10 2 API FUNCIONS oo a 28 bea Made Bae Ree BES 10 3 Programming Example
14. EEPROMBlockFromAddr Returns the EEPROM block number containing a given offset address Definition define EEPROMBlockFromAddr ulAddr Parameters ulAddr is the linear byte address of the EEPROM location whose block number is to be re turned This is a zero based offset from the start of the EEPROM storage Description This macro may be used to translate an EEPROM address offset into a block number suitable for use in any of the driver s block protection functions The address provided is expressed as a byte offset from the base of the EEPROM Returns Returns the zero based block number which contains the passed address Function Documentation EEPROMBlockCountGet Determines the number of blocks in the EEPROM September 05 2012 79 EEPROM 6 2 3 2 6 2 3 3 80 Prototype unsigned long EEPROMBlockCountGet void Description This function may be called to determine the number of blocks in the EEPROM Each block is the same size and the number of bytes of storage contained in a block may be determined by dividing the size of the device obtained via a call to the EERROMSizeGet function by the number of blocks returned by this function Returns Returns the total number of bytes in the device EEPROM EEPROMBlockHide Hides an EEPROM block until the next reset Prototype void EFEPROMBlockHide unsigned long ulBlock Parameters ulBlock is the EEPROM block
15. Parameters ulBase specifies the LPC module base address ulChannel specifies the LPC channel to disable Description This function disables the specified LPC Channel See also The description of the LPCChannelEnable function provides detailed information for the val ues that can be used for the u Channe parameter Returns None September 05 2012 255 Low Pin Count Interface LPC 17 2 1 8 17 2 1 9 LPCChannelDMAConfigGet Gets the configuration of DMA for LPC channels Prototype unsigned long LPCChannelDMAConfigGet unsigned long ulBase Parameters ulBase specifies the LPC module base address Description This function returns the configuration of the LPC DMA channels Returns Returns the bit mapped DMA channel configuration LPCChannelDMAConfigSet Sets the configuration of DMA for LPC channels Prototype void LPCChannelDMAConfigSet unsigned long ulBase unsigned long ulConfig unsigned long ulMask Parameters ulBase specifies the LPC module base address ulConfig specifies the DMA channel configuration ulMask specifies the configuration mask to be used Description This function sets the specified DMA channel operation based on the u Config parameter Returns None 17 2 1 10 LPCChannelEnable 256 Enables an LPC Channel Prototype void LPCChannelEnable unsigned long ulBase unsigned long ulChannel Parameters ulBase specifies the
16. Prototype unsigned long EEPROMMassErase void Description This function completely erases the EEPROM and removes any and all access protection on its blocks leaving the device in the factory default condition After this operation all EEPROM words contain the value OxFFFFFFFF and all blocks are accessible for both read and write operations in all CPU modes No passwords are active The function is synchronous and does not return until the erase operation has completed Returns Returns 0 on success or non zero values on failure Failure codes are logical OR combi nations of EEPROM_RC_INVPL EEPROM_RC_WRBUSY EEPROM_RC_NOPERM EEP ROM_RC_WKCOPY EEPROM_RC_WKERASE and EEPROM_RC_WORKING EEPROMProgram Writes data to the EEPROM Prototype unsigned long EEPROMProgram unsigned long xpulData unsigned long ulAddress unsigned long ulCount Parameters pulData points to the first word of data to write to the EEPROM ulAddress defines the byte address within the EEPROM that the data is to be written to This value must be a multiple of 4 ulCount defines the number of bytes of data that is to be written This value must be a multiple of 4 Description This function may be called to write data into the EEPROM at a given word aligned address The call is synchronous and returns only after all data has been written or an error occurs Returns Returns 0 on success or non zero values on failure Fai
17. SYSCTL_SYSDIV_64 Only SYSCTL_SYSDIV_1 through SYSCTL_SYSDIV_16 are valid on Sandstorm class de vices Half dividers such as SYSCTL_SYSDIV_2 5 and SYSCTL_SYSDIV_3_5 are available on Tempest Firestorm and Blizzard 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 SYSCTL_XTAL_16_3MHZ SYSCTL_XTAL_18MHZ SYSCTL_XTAL_20MHZ SYSCTL_XTAL_24MHZ or SYSCTL_XTAL_25MHz Values below September 05 2012 24 2 2 7 System Control SYSCTL_XTAL_3_57MHZ are not valid when the PLL is in operation on Sandstorm Fury Dusidevil Tempest and Firestorm class devices Values below SYSCTL_XTAL_5MHZ are not valid when the PLL is in operation on Blizzard class devices Values below SYSCTL_XTAL_4MHZ are never valid on Blizzard class devices On Sandstorm and Fury class devices values above SYSCTL_XTAL_8_19MHZ are not valid On Dusidevil Tempest and Firestorm class devices values above SYSCTL_XTAL_1
18. The following tool chains are supported Keil RealView Microcontroller Development Kit CodeSourcery Sourcery G for Stellaris EABI m IAR Embedded Workbench m Texas Instruments Code Composer Studio September 05 2012 7 Introduction Source Code Overview The following is an overview of the organization of the peripheral driver library source code 8 September 05 2012 EULA txt driverlib hw_ h inc makedefs September 05 2012 Introduction 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 peripheral 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 Introduction 10 September 05 2012 2 2 1 2 2 Programming Model Programming Model ioc Aart neta er ee Terres cree eer ren ie Cee ree ery reer nT ee ae erent er rere Fe eres eee 11 Direct Register Access Model o ecissrcraceiiesarossieeriro seeandniws iiae OTERA E e arD ERANS Ti EAE ikea ao e E EE TA EE T E T T ASIA A a S EET 12 Combining THEMOGEE pniicdnccene
19. 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 in 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 enable 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
20. 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 to be any type of CAN message object as well as to use au tomatic 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 MSG_OBJ_TYPE_RX_REMOTE CAN receive remote request message object MSG_OBJ_TYPE_RXTX_REMOTE CAN remote frame receive remote then transmit message object The message object pointed to by pMsgObject must be populated by the caller as follows September 05 2012 Controller Area Network CAN ulMsgID 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 inter
21. 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 unsigned long ADCResolutionGet unsigned long ulBase void ADCResolutionSet unsigned long ulBase unsigned long ulResolution 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 unsigned 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 ulF
22. Interrupt Controller NVIC 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 only looks 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 16 2 2 14 IntRegister 248 Registers a function to be called when an interrupt occurs Prototype void IntRegister unsigned long ulInterrupt void pfnHandler void Parameters ullnterrupt specifies the interrupt 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 pro
23. Note The interrupt handler for the uDMA is for transfer completion when the channel UDMA_CHANNEL_SW is used and for error interrupts The interrupts for each peripheral channel are handled through the individual peripheral interrupt handlers Returns None 29 2 3 25 uDMAIntStatus Gets the uDMA controller channel interrupt status September 05 2012 455 uDMA Controller Prototype unsigned long uDMAInt Status void Description This function is used to get the interrupt status of the UDMA controller The returned value is a 32 bit bit mask that indicates which channels are requesting an interrupt This function can be used from within an interrupt handler to determine or confirm which UDMA channel has requested an interrupt Note This function is only available on devices that have the DMA Channel Interrupt Status Register DMACHIS Please consult the data sheet for your part Returns Returns a 32 bit mask which indicates requesting UDMA channels There is a bit for each channel and a 1 indicates that the channel is requesting an interrupt Multiple bits can be set 29 2 3 26 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 disables and unregisters the handler to be called for the specified uDMA inter rupt The ulintCha
24. 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 480 September 05 2012 USB Controller 30 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 functional address for the controller to use for this endpoint ulFlags determines if this is an IN or an OUT endpoint Description This function configures the functional address for a device that is using this endpoint for com munication This u Addr parameter is the address of the target device that this endpoint is communicating with The u Flags parameter indicates if the IN or OUT endpoint should be set Note
25. SYSCTL_PERIPH_12C3 SYSCTL_PERIPH_12S0 SYSCTL_PERIPH_PWMO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI2 SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART4 SYSCTL_PERIPH_UART 7 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER2 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER4 or SYSCTL_PERIPH_WTIMERS5 Note It takes five clock cycles after the write to enable a peripheral before the the peripheral is actually enabled During this time attempts to access the peripheral result in a bus fault Care should be taken to ensure that the peripheral is not accessed during this brief time period Returns None 24 2 2 31 SysCtlPeripheralPowerOff Powers off a peripheral Prototype void SysCtlPeripheralPowerOff unsigned long ulPeripheral Parameters 364 ulPeripheral is the peripheral to be powered off September 05 2012 Description System Control This function allows the power to a peripheral to be turned off The peripheral continues to receive power when its clock is enabled but the power is removed when its clock is disabled The ulPeripheral ing values SYSCTL_PERIPH_CANO SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_EEPROMO SYSCTL_PERIPH_FANO SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPIOQ SYSCTL_PERIPH_1I2C1 SYSCTL_PER
26. SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI2 SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART4 Returns None 24 2 2 36 SysCtlPeripheralSleepDisable Disables a peripheral in sleep mode Prototype void SysCtlPeripheralSl pDisable unsigned long ulPeripheral Parameters ulPeripheral is the peripheral to disable in sleep mode Description 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 enabled via SysCtlPeripheralEnable the peripheral automatically resumes 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 SysCitlPeripheralClockGating if dis abled the peripheral sleep mode configuration is maintained but has no effect when sleep mode is entered The ulPeripheral ing values SYSCTL_PERIPH_CANO SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_EEPROMO one of the follow SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_ETH parameter must be only SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_FANO SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOu SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPIOQ SYSCTL_PERIPH_12C1 SYSCTL_
27. September 05 2012 477 USB Controller 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 address is needed when the USB is going to be used with the uDMA controller and the source or destination address must be set to the physical FIFO address for a given endpoint Returns None 30 3 2 22 USBFlFOConfigGet Returns the FIFO configuration for an endpoint Prototype void USBFIFOConfigGet unsigned long ulBase unsigned long ulEndpoint unsigned long pulFIFOAddress unsigned long xpulFIFOSize 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 as specified by one of the USB_FIFO_SZ_ values ulFlags specifies what information to retrieve from the FIFO configuration Description This function returns 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
28. pfnHandler void 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 function registers the handler to be called when a timer interrupt occurs In addition this function enables the global interrupt in the interrupt controller specific timer interrupts must be enabled via TimerlntEnable It is the interrupt handler s responsibility to clear the interrupt source via TimerIntClear See also IntRegister for important information about registering interrupt handlers Returns None 27 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 September 05 2012 397 Timer Description This function 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 27 2 2 14 TimerlntUnregister Unregisters an interrupt handler for the timer interrup
29. ulBase is the base address of the controller ucRegAddar is the address of the PHY register to be accessed ulData is the data to be written to the PHY register Description This function writes the u Data to the PHY register specified by ucRegAdar Returns None September 05 2012 Ethernet Controller 7 2 2 24 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 transmit 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 simply checks 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 7 3 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 Ethernet InitExpClk ETH_BASE SysCt1lClockGet
30. 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 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 lon
31. 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 September 05 2012 Controller Area Network CAN 51 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 52 CAN_STATUS_LEC_MASK Definition define CAN_STATUS_LEC_ MASK Description This 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_
32. Configure 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 configures a set of CAN message objects in FIFO mode using CAN controller tCANBitClkParms CANBitClk tCANMsgObject sMsgObjectRx unsigned char ucBufferIn 8 unsigned char ucBufferOut 8 Lf 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 CANBitRateSet CANO_BASE 8000000 1000000 Take the CANO device out of INIT state CANEnable CANO_BASE Configure a receive object as a CAN FIFO to receive message objects with message ID 0x400 0x407 September 05 2012 Controller Area Network CAN sMsgObjectRx sMsgObjectRx sMsgObjectRx The first that they ulMsgID 0x400 ulMsgIDMask 0x7f8 ulFlags MSG_OBJ_USE_ID_FILTER MSG_OBJ_FIFO three message objects have the MSG_OBJ_FIFO set to ind
33. Get next L R sample pair in compact 16 format from some buffer code not shown here I2STxDataPutNonBlocking I2SO_BASE ulDataSamples September 05 2012 239 Inter IC Sound 12S 240 September 05 2012 16 16 1 Interrupt Controller NVIC Interrupt Controller NVIC STOUT SON manaa a a a chit dba Detainee here D 241 APOPO ROIS 6 tarcaee occa elena aia es Cs sunet ca aun eda beten ase e enue edie ee awe 242 Pregramimmg REIN DIE ccc cornrenaeceiapisew edd caetagemerertbagenecEsepesarsouquenerseebedeereeemander 249 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 and disable interrupts register interrupt handlers and set the priority of interrupts The NVIC provides global interrupt masking prioritization and handler dispatching Devices within the Stellaris family support up to 154 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 M microprocessor When the processor responds to an interrupt the NVIC supplies the address of the function to handle the interrupt directly to the processor This action eliminates the need for a global interrupt handler that queries the interrupt controller to determin
34. HIBERNATE_INT_RTC_MATCH_1 RTC match 1 interrupt Note The HIBERNATE_INT_WR_COMPLETE and HIBERNATE_INT_RTC_MATCH_1 settings are not available on all Stellaris devices Please consult the data sheet for the Stellaris device that you are using to determine if these interrupt sources are available Returns None 13 2 2 15 HibernatelntRegister Registers an interrupt handler for the Hibernation module interrupt Prototype void HibernateIntRegister void pfnHandler void Parameters pfnHandler points to the function to be called when a hibernation interrupt occurs Description This function 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 HibernatelIntEnable See also IntRegister for important information about registering interrupt handlers Returns None 13 2 2 16 HibernatelntStatus 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 188 September 05 2012 Hibernation Module Description This function returns the interrupt status of the Hibernation module The caller can use this function to determine the cause of a hibernation interrupt Either the masked or raw interrupt sta
35. None 19 2 1 16 PEClIntClear Clears PECI interrupt sources Prototype void PECIIntClear unsigned long ulBase unsigned long ulIntFlags September 05 2012 289 Platform Environment Control Interface PECI Parameters ulBase specifies the PECI module base address ullntFlags is a bit mask of the interrupt sources to be cleared Description This function clears the specified PECI interrupt sources 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 any combination of the PECI_READ PECI_ERR PECI_AC PECI_MODO PECI_M0D1 PECI_M1D0 or PECI_M1D1 values Note Because there is a write buffer in the Cortex M 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 1 17 PEClIntDisable Disables individual PECI interrupt sources Prototype void PECIIntDisable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase specif
36. Parameters ulBase is the base address of the timer module Description This function gets the currently programmed interval load value for the specified 64 bit timer Returns Returns the load value for the timer 27 2 2 17 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 full width operation ulValue is the load value Description This function configures the timer load value if the timer is running then the value is immedi ately loaded into the timer Note This function can be used for both full and half width modes of 16 32 bit timers and for half width modes of 32 64 bit timers Use TimerLoadSet64 for full width modes of 32 64 bit timers Returns None September 05 2012 399 Timer 27 2 2 18 TimerLoadSet64 Sets the timer load value for a 64 bit timer Prototype void TimerLoadSet 64 unsigned long ulBase unsigned long long ullValue Parameters ulBase is the base address of the timer module ullValue is the load value Description This function configures the timer load value for a 64 bit timer if the timer is running then the value is immediately loaded into the timer R
37. Register the port level interrupt handler This handler is the first level interrupt handler for all the pin interrupts GPIOPortIntRegister GPIO_PORTA_BASE PortAIntHandler if Initialize the GPIO pin configuration Set pins 2 4 and 5 as input SW controlled ft GPIOPinTypeGPIOInput GPIO_PORTA_BASE GPIO_PIN_2 GPIO_PIN_4 GPIO_PIN_5 if Set pins 0 and 3 as output SW controlled GPIOPinTypeGPIOOutput GPIO_PORTA_BASE GPIO_PIN_O GPIO_PIN_3 September 05 2012 GPIO Make pins 2 and 4 rising edge triggered interrupts 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 Write some pins Even though pins 2 4 and 5 are specified those pins are unaffected by this write because 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 September 05 2012 177 GPIO 178 September 05 2012 Hibernation Modu
38. Returns Never returns 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 the SSIO interface This function assumes that the SSIO interface has already been configured and is currently operational Returns Never returns 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 September 05 2012 33 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 an error code would be returned The caller then has to check the return code from each invocation of the function to make sure that it succeeded This method results in a sizable amount of argument checking code in each function and return code checking code at each call site For a self contained application this extra code becomes an unneeded burden once the appli
39. Returns None 18 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 M memory protection unit It also configures the default be havior 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 MPUEn able Once the MPU is enabled a memory management fault is generated for memory access violations The ul MPUConfig parameter should be the logical OR of any of the following MPU_CONFIG_PRIV_DEFAULT enables the default memory map when in privileged mode 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 isl not enabled in the fault handlers Returns None 18 2 2 3 MPUIntRegister Register
40. See also The description of the EthernetConfigSet function provides detailed information for the bit mapped configuration values that are 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 September 05 2012 91 Ethernet Controller 7 2 2 3 7 2 2 4 92 for the transmitted and received packets Note that not all de
41. This function writes a word to the channel pool The u Offset specified must be word aligned Returns None September 05 2012 269 Low Pin Count Interface LPC 270 September 05 2012 Memory Protection Unit MPU 18 Memory Protection Unit MPU IS N s e E EE TEETE TIT TT AAE T TE AEREE ES AN T AE A T A baa eat knee 271 AP PONCHO sorosseoi k ikoner eea Ear a rA AAEE 271 Pregramimmg Example cecon a A E E A 278 18 1 Introduction The Memory Protection Unit MPU API provides functions to configure the MPU The MPU is tightly coupled to the Cortex M 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 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 configured for read only access read write access or no access for both privileged and user modes Access permissions can be used to create 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
42. 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 causes the endpoint number passed in to go into a stall condition If the u Flags parameter is USB_EP_DEV_IN then the stall is issued on the IN portion of this endpoint If the u Flags parameter is USB_EP_DEV_OUT then the stall is issued on the OUT portion of this endpoint Note This function should only be called in device mode Returns None USBDevEndpointStallClear Clears the stall condition on the specified endpoint in device mode September 05 2012 USB Controller Prototype void USBDevEndpointStallClear unsigned long ulBase unsigned long ulEndpoint unsigned long ulFlags 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 causes the endpoint number passed in to exit the stall condition If the u Flags parameter is USB_EP_DEV_IN then the stall is cleared on the IN portion of this endpoint If the u Flags para
43. 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 Finally once the module is appropriately configured the state saved and the software application is ready to hibernate call the HibernateRequest function This function initiates the sequence to remove power from the processor At a power on reset the software application can use the HibernatelsActive function to determine if the Hibernation module is already active and therefore does not need to be enabled This function 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 the 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 use the new API in favor of the old one 13 2 2 Function Documentation 13 2 2 1 HibernateBatCheckDone Returns if a forced battery check has completed Prototy
44. and values smaller than 0x40 speed up PIOSC Returns Returns 1 if the calibration was successful and 0 if it failed 24 2 2 40 SysCtIPLLVerificationSet Configures the PLL verification timer Prototype void SysCt1lPLLVerificationSet tBoolean bEnable Parameters bEnable is a boolean that is true if the PLL verification timer should be enabled Description This function allows the PLL verification timer to be enabled or disabled When enabled an interrupt is 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 verification 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 24 2 2 41 SysCtIPWMClockGet Gets the current PWM clock configuration Prototype unsigned long SysCt1lPWMClockGet void 372 September 05 2012 System Control Description This function returns the current PWM clock configuration Returns Returns the current PWM clock configuration is one of SYSCTL_PWMDIV_1 SYSCTL_PWMDIV_2 SYSCTL_PWMDIV_4 SYSCTL_PWMDIV_8 SYSCTL_PWMDIV_16 SYSCTL_PWMDIV_32 or SYSCTL_PWMDIV_64 24 2 2 42 SysCtIPWMClockSet Sets the PWM clock configuration Prototype void SysCt1lPWMClockSet unsigned long ulConfig Parameters ulConfig is the configuration for the PWM cl
45. cessor Trigger function m ADC_TRIGGER_COMPO0 A trigger generated by the first analog comparator configured with ComparatorConfigure September 05 2012 4 2 2 23 Analog to Digital Converter ADC 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 Note that some microcontrollers can select from any GPIO using the GPIOADCTriggerEnable function ADC_TRIGGER_TIMER A trigger generated by a timer configured with TimerCon trolTrigger 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 PWMGenlntTrigEnable ADC_TRIGGER_PWN2 A trigger generated by the third PWM generator configured with PWMGenlIntTrigEnable ADC_TRIGGER_PWMS A trigger generated by the fourth PWM generator configured with PWMGenIntTrigEnable 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 determin
46. gt ulPhase2Seg parameter These two parameters along with pClkParms gt ulSJW are based in units of bit time quanta The actual quantum time is determined by the pC kParms gt ulQuantumPrescaler value which specifies the divisor for the CAN module clock The total bit time in quanta is the sum of the two Seg parameters as follows bit_time_q ulSyncPropPhase1Seg ulPhase2Seg 1 Note that the Sync_Seg is always one quantum in duration and is 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 u SyncPropPhase1Seg ulPhase2Seg 1 x ulQuantumPrescaler Thus with u SyncPropPhase1Seg 4 ulPhase2Seg 1 ul QuantumPrescaler 2 and an 8 MHz CAN clock the bit rate is 8 MHz 5 2 1 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 CANDisable Disables the CAN controller Prototype void CANDisable unsigned long ulBase September 05 2012 57 Controller Area Network CAN 5 2 5 5 5 2 5 6 58 Parameters ulBase is the base address of the CAN controller to disable Description Disables the CAN controller for message processing When disabled the controller no longer automatically processes data on the CAN bus The controller can be restarted by calling CA NEnable T
47. interface actually transmits 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 allowing 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 to communicate with both IN and OUT endpoints of different types as well For example Endpoint 2 could be used to communicate with one device s interrupt IN endpoint and another device s bulk OUT endpoint at the same time This configuration effectively gives the application one dedicated control endpoint for IN or OUT control transactions on endpoint 0 and three seven or fifteen IN endpoints and three seven or fifteen OUT endpoints depending on the total number of endpoints on the Stellaris device The USB controller has a configurable FIFO 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 2048 or 4096 bytes depend ing on the Stellaris device used It is important to note that the first 64 bytes of this memory are dedicated to endpoint 0 for control transactions
48. m void SysExclntEnable unsigned long ullntFlags m void SysExclintRegister void pfnHandler void m unsigned long SysExclntStatus tBoolean bMasked m void SysExclntUnregister void Detailed Description The system exception module interrupts are managed with SysExclntRegister SysExclntUnreg ister SysExcIntEnable SysExclntDisable SysExclntStatus and SysExclintClear Function Documentation SysExclintClear Clears system exception interrupt sources Prototype void SysExcIntClear unsigned long ulIntFlags September 05 2012 377 System Exception Module 20 2 2 2 378 Parameters ullntFlags is a bit mask of the interrupt sources to be cleared Description This function clears the specified system exception interrupt sources so that they no longer assert This function must be called in the interrupt handler to keep the interrupt from being recognized again immediately upon exit The ul ntFlags parameter is the logical OR of any of the following SYSEXC_INT_FP_IXC Floating point inexact exception interrupt SYSEXC_INT_FP_OFC Floating point overflow exception interrupt SYSEXC_INT_FP_UFC Floating point underflow exception interrupt SYSEXC_INT_FP_IOC Floating point invalid operation interrupt SYSEXC_INT_FP_DZC Floating point divide by zero exception interrupt SYSEXC_INT_FP_IDC Floating point input denormal exception interrupt Note Because there is a write buffe
49. 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 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 m DMA_CHANNEL_USBEP1TX DMA_CHANNEL_USBEP2RX DMA_CHANNEL_USBEP2TX DMA_CHANNEL_USBEP3RX m DMA_CHANNEL_USBEP3TX For devices with more than 8 endpoints the required endpoints must be assigned to one of the 3 DMA receive channels and 3 DMA transmit channels using the USBEndpointDMAChannel func tion Because 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 an
50. 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 returns immediately without writing any data to the FIFO Returns The number of elements written to the 12S transmit FIFO 1 or 0 15 2 2 19 l2STxDisable Disables the 12S transmit module for operation Prototype void I2STxDisable unsigned long ulBase Parameters ulBase is the 2S 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 are generated on the I2S signals Returns None 234 September 05 2012 Inter IC Sound 12S 15 2 2 20 l2STxEnable Enables the I2S transmit module for operation Prototype void I2STxEnable unsigned long ulBase Parameters ulBase is the I2S 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 are generated on the I2S signals Returns None 15 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 t
51. ulBase specifies the SSI module base address Description This function disables operation of the synchronous serial interface Returns None 23 2 2 10 SSIDMADisable Disables 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 September 05 2012 339 Synchronous Serial Interface SSI 23 2 2 11 m SSI_DMA_RX disable DMA for receive m SSI_DMA_TX disable DMA for transmit Returns None SSIDMAEnable Enables 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 This function enables the specified SSI DMA features 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 must also be set up before DMA can be used with the SSI Returns Non
52. unsigned long ulBase September 05 2012 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 is clocked in regardless of the signals on the 12S interface Returns None 15 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 internally the mono sample is still treated as a sample pair so a single mono sample counts as 2 Because the FIFO always deals with sample pairs normally the level is 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 is 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 is normally an even number 15 2 2 14 l2SRxFIFOLimitGet Gets the current setting of the FIFO service request level Prototype unsigned long I2SRxFIFOLimitGet unsigned lo
53. unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function unregisters the interrupt handler This function also disables the USB interrupt in the interrupt controller See also IntRegister for important information about registering or unregistering interrupt handlers Returns None 30 3 2 58 USBModeGet Returns the current operating mode of the controller Prototype unsigned long USBModeGet unsigned long ulBase Parameters ulBase specifies the USB 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 returns one 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 September 05 2012 497 USB Controller 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 an OTG session request is started with no cable in place this mode is the default USB_OTG_MODE_NONE indicates that the controll
54. unsigned long ulConfig void TimerControlEvent unsigned long ulBase unsigned long ulTimer unsigned long ulEvent void TimerControlLevel unsigned long ulBase unsigned long ulTimer tBoolean blnvert 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 Timer IntDisable unsigned long ulBase unsigned long ullntFlags void TimerlntEnable unsigned long ulBase unsigned long ullntFlags void TimerIntRegister unsigned long ulBase unsigned long ulTimer void pfnHandler 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 unsigned long long TimerLoadGet64 unsigned long ulBase void TimerLoadSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue void TimerLoadSet64 unsigned long ulBase unsigned long long ullValue unsigned long TimerMatchGet unsigned long ulBase unsigned long ulTimer unsigned long long TimerMatchGet64 unsigned long ulBase
55. unsigned long ulPort unsigned char ucPins void GPIOPinTypeFan unsigned long ulPort unsigned char ucPins void GPIOPinTypeGP OInput unsigned long ulPort unsigned char ucPins void GPIOPinTypeGP lOOutput unsigned long ulPort unsigned char ucPins void GPIOPinTypeGP IOOutputOD unsigned long ulPort unsigned char ucPins void GPIOPinTypel2C unsigned long ulPort unsigned char ucPins void GPIOPinTypel2CSCL unsigned long ulPort unsigned char ucPins void GPIOPinTypel2S unsigned long ulPort unsigned char ucPins void GPIOPinTypeLPC unsigned long ulPort unsigned char ucPins void GPIOPinTypePECIRx unsigned long ulPort unsigned char ucPins void GPIOPinTypePECITx unsigned long ulPort unsigned char ucPins void GPIOPinTypePWM unsigned long ulPort unsigned char ucPins void GPIOPinTypeQE unsigned long ulPort unsigned char ucPins void GPIOPinTypeSSI unsigned long ulPort 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 September 05 2012 12 2 1 12 2 2 12 2
56. void TimerMatchSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue void TimerMatchSet64 unsigned long ulBase unsigned long long ullValue 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 void TimerSynchronize unsigned long ulBase unsigned long ulTimers unsigned long TimerValueGet unsigned long ulBase unsigned long ulTimer unsigned long long TimerValueGet64 unsigned long ulBase 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 full or half width modes and to select between PWM capture September 05 2012 27 2 2 217 2 2 1 Timer and timer operations Timer control is performed by TimerEnable TimerDisable TimerCon trolLevel TimerControlTrigger TimerControlEvent TimerControlStall TimerRTCEnable and Ti
57. 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 September 05 2012 28 2 1 28 2 2 28 2 2 1 UART 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 The clock source for the baud rate generator is handled by the UARTClockSourceSet and UART ClockSourceGet functions Configuration and control of the UART are handled by the UARTConfigGetExpClk UARTCon figSetExpClk UARTDisable UARTEnable UARTParityModeGet and UARTParityModeSet 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 VARTCharPutNonBlocking UARTBreakCtl UARTCharsAvail and UARTSpaceAvail functions Man
58. 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 Kbps and Fast 400 Kbps Both the master and slave 12C modules can generate interrupts The 12C master module generates interrupts when a transmit or receive operation is completed or aborted due to an error and on some devices when a clock low timeout has occurred The 12C slave module generates interrupts when data has been sent or requested by a master and on some devices when a START or STOP condition is present Master Operations When using this API to drive the I2C master module the user must first initialize the I2C master module with a call to 2CMasterInitExpClk That function sets the bus speed and enables the master module The user may transmit or receive data 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
59. 12S CONFIG_EMPTY_ZERO or 12S CONFIG_EMPTY_REPEAT to select whether the module transmits zeroes or repeats the last sample when the FIFO is empty Returns None 15 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 128 MODE_DUAL_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 126 MODE_COMPACT_STEREO_16 or I28_ MODE_COMPACT_STEREO_8 then the ulData parameter contains both the left and right samples If the transmit mode is I2S MODE_SINGLE_MONDO 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 ri
60. 151 PP iPM CHOUS 6 tancaee ec aek clue naritce cabana tease came bees adeenee a eiecie A 152 Programming Example ccc sonnrenaeaeinpisewedscemeepemeegr eGeanecneeoegerseugusncreeebedeeieesmae das 176 Introduction The 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 modul
61. 2 31 2 2 1 502 void WatchdoglntTypeSet unsigned long ulBase unsigned long ulType 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 void WatchdogResetEnable unsigned long ulBase tBoolean WatchdogRunning unsigned long ulBase void WatchdogStallDisable unsigned long ulBase void WatchdogStallEnable unsigned long ulBase void WatchdogUnlock unsigned long ulBase unsigned long WatchdogValueGet 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 Wa
62. 2 1 12 2 2 2 GPIO 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 GPIOPadConfigSet and GPIOPinCon figure The configuration can be read back with GPIODirModeGet and GPIOPadConfigGet There are also convenience functions for configuring the pin in the required or recommended con figuration for a particular peripheral these are GPIOPinTypeCAN GPIOPinTypeComparator GPIOPinTypeGP OlInput GPIOPinTypeGPlOOutput GPIOPinTypeGPIOOutputOD GPIOPin Typel2C GPIOPinTypePWM GPIOPinTypeQEI GPIOPinTypeSSI GPIOPinTypeTimer and GPIOPinTypeUART The GPIO interrupts are handled with GP OIntlypeSet GPIOlntTypeGet GPIOPinIntEnable GPIOPinlntDisable GPIOPinIntStatus GPIOPinIntClear GPIOPortIntRegister and GPIO PortIntUnregister The GPIO pin state is accessed with GPIOPinRead and GPIOPinWrite Function Documentation GPIOADCTriggerDisable Disable a GPIO pin as a trigger to start an ADC capture Prototype void GPIOADCTriggerDisable 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 This function disables a GPIO pin to be used as a trigger to start an ADC sequenc
63. 2 3 25 2 2 4 System Exception Module Returns None SysExclntEnable Enables individual system exception interrupt sources Prototype void SysExcIntEnable unsigned long ulIntFlags Parameters ullntFlags is the bit mask of the interrupt sources to be enabled Description This function enables the indicated system exception 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 SYSEXC_INT_FP_IXC Floating point inexact exception interrupt SYSEXC_INT_FP_OFC Floating point overflow exception interrupt SYSEXC_INT_FP_UFC Floating point underflow exception interrupt SYSEXC_INT_FP_IOC Floating point invalid operation interrupt SYSEXC_INT_FP_DZC Floating point divide by zero exception interrupt SYSEXC_INT_FP_IDC Floating point input denormal exception interrupt Returns None SysExclntRegister Registers an interrupt handler for the system exception interrupt Prototype void SysExcIntRegister void pfnHandler void Parameters pfnHandler is a pointer to the function to be called when the system exception interrupt oc curs Description This function places the address of the system exception interrupt handler into the interrupt vector table in SRAM This function also enables the global interrupt in the interr
64. 2012 59 Controller Area Network CAN 5 2 5 9 5 2 5 10 60 It is not necessary to use this function to clear an interrupt This function 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 M 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 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 ullntFla
65. 21 Analog Comparator 22 September 05 2012 4 1 Analog to Digital Converter ADC Analog to Digital Converter ADC PRT HON wack asics tdataiea haw eaa adibeiehe dy ater aden dda eenndia eater peannence 23 UN A A 26 0 eae ee ee Re eae a MOS eee eae are See On ee Roe ACen ae ee er eee eR EE CAN 24 Pregranimmo Exame lt csccucaateneeeeoueareceeecdiqpideadanectessuadeipeeeatnseedeasnrediemnaeaenties 43 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 Depending on the features of the individual microcontroller the ADC supports up to twenty four input channels plus an internal temperature sensor Four sampling sequencers each with con figurable trigger events can be captured The first sequencer captures up to eight samples the second and third sequencers capture up to four samples and the fourth sequencer captures a sin gle sample Each sample can be the same channel different channels or any combination in any order The sample sequencers have configurable priorities that determine the order in which they are captured when multiple triggers occur simultaneously The highest priority sequencer that is cur rently triggered is sampled first Care must be taken with triggers that occur frequently such as t
66. 5 System Control SysCtlIBrownOutConfigSet Configures the brown out 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 how 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 Note The availability of the resample feature is only available on Sandstorm class devices Please consult the data sheet for the part you are using to determine whether this feature is available Returns None 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 SysCtlClockGet Gets the pro
67. 6 2 2 3 6 2 2 4 76 Interrupt handling is managed with EEPROMIntEnable EEPROMIntDisable EEPROMIntSta tus and EEPROMIntClear An additional function EEPROMSizeGet is provided to allow an application to query the size of the device storage and the number of blocks it contains Define Documentation EEPROM_INIT_ERROR Definition define EEPROM_INIT_ERROR Description This value may be returned from a call to EEPROMInit It indicates that a previous data or protection write operation was interrupted by a reset event and that the EEPROM peripheral was unable to clean up after the problem This situation may be resolved with another reset or may be fatal depending upon the cause of the problem For example if the voltage to the part is unstable retrying once the voltage has stabilized may clear the error EEPROM_INIT_OK Definition define EEPROM_INIT_OK Description This value may be returned from a call to EEPROMInit It indicates that no previous write operations were interrupted by a reset event and that the EEPROM peripheral is ready for use EEPROM_INIT_RETRY Definition define EEPROM_INIT_RETRY Description This value may be returned from a call to EEPROMInit It indicates that a previous data or protection write operation was interrupted by a reset event The EEPROM peripheral has recovered its state but the last write operation may have been lost The a
68. 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 is one of ADC_REF_INT ADC_REF_EXT_3V or ADC_REF_EXT_1V 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 reference September 05 2012 4 2 2 20 4 2 2 21 Analog to Digital Converter ADC 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 Description The ADC reference is set a
69. 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 specify if edges on chan nel A or on both channels A and B should be counted by the position integrator and velocity accumulator QEI_CONFIG_NO_RESET or QEIl_CONFIG_RESET_IDX specify if the position integrator should be reset when the index pulse is detected QEI_CONFIG_QUADRATURE or QEI_CONFIG_CLOCK_DIR 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 QEIl_CONFIG_SWAP to 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 22 2 2 2 QEI DirectionGet 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 function returns the current direction of rotation In this case current means the most re cently 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
70. FO CANS opasite E E E EE 514 Firmware UpdalS eererccisrenenmurerensrcenie pein aaO E PEET AAEE EEEE 515 Introduction Many Stellaris devices have portions of the peripheral driver library stored in an on chip ROM By using 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 using a preprocessor symbol which can be done either within the source code or in the project that builds the application The latter 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 is used instead A define is used to to select the device being used because the set of functions available in the ROM must be a compile time decision checking at run time does not provide any flash savings because 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 silico
71. GPIO retention after wake from hibernate Prototype void HibernateGPIORetentionDisable void Description Calling this function disables the retention of the the GPIO pin state during hibernation and allows the GPIO pins to be controlled by the system If the HibernateGPlORetentionEnable function is called before entering the hibernate this function must be called after returning from the hibernate state to allow the GPIO pins to be controlled by GPIO module Note The hibernate GPIO retention setting is not available on all Stellaris devices Please consult the data sheet to determine if the device you are using supports this feature in the Hibernation module Returns None September 05 2012 185 Hibernation Module 13 2 2 10 HibernateGPlORetentionEnable 13 2 2 11 Enables GPIO retention after wake from hibernate Prototype void HibernateGPIORetentionEnable void Description Calling this function enables the GPIO pin state to be maintained during hibernation and remain active even when waking from hibernation The GPIO module itself is reset upon entering hi bernation and no longer controls the output pin To maintain the current output level after waking from hibernation the GPIO module must be reconfigured and then the HibernateGPI ORetentionDisable function must be called to return control of the GPIO pin to the GPIO module Note The hibernation GPIO retention setting is not available on a
72. I2C_SLAVE_ACT_QCMD_DATA to indicate that the data bit was set when the quick command was received 14 3 Programming Example The following example shows how to use the I2C API to send data as a master if Initialize Master and Slave T2CMasterInitExpClk I2C_MASTER_BASE SysCtlClockGet true Specify slave address ff I2CMasterSlaveAddrSet I2C_MASTER_BASE 0x3B false Place the character to be sent in the data register I2CMasterDataPut I2C_MASTER_BASE 0Q Initiate send of character from Master to Slave I2CMasterControl I2C_MASTER_BASE I2C_MASTER_CMD_SINGLE_SEND Delay until transmission completes while I2CMasterBusBusy I2C_MASTER_BASBE September 05 2012 221 Inter Integrated Circuit I2C 222 September 05 2012 15 15 1 15 2 Inter IC Sound 12S Inter IC Sound 12S MOGUCOM maneia a denna nbd debe ant ine De adeeb hee datos taedsd 223 APOPO MOUS 6 tancaee ec aah owns aiken es Co a sunet aai 223 Pregrammmg ERIN DIE ccc sannrenaeaeiapisdn edd cameagemeeertbagenecEsepegersouquenerheebedeereeenanies 238 Introduction The 12S API provides functions to use the I2S peripheral in the Stellaris microcontroller The 12S 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 1
73. LPC module base address ulChannel specifies the LPC channel to enable September 05 2012 17 2 1 11 Low Pin Count Interface LPC Description The specified LPC Channel is enabled The value for the ulChannel parameter can be any one of the following val ues LPC_CHAN_CHO LPC_CHAN_CH1 LPC_CHAN_CH2 LPC_CHAN_CH3 LPC_CHAN_CH4 LPC_CHAN_CH5 LPC_CHAN_CH6 or LPC_CHAN_CH7 Returns None LPCChannelPoolAddressGet Gets the absolute base address of the channel pool Prototype unsigned long LPCChannelPoolAddressGet unsigned long ulBase unsigned long ulChannel Parameters ulBase specifies the LPC module base address ulChannel specifies the LPC channel to configure Description Thos function calculates the absolute address of the channel pool from the channel configura tion setting and returns it Returns Returns the absolute base address of the channel pool 17 2 1 12 LPCChannelStatusClear Clears the user bits in the status word 16 bits of an LPC Channel Prototype void LPCChannelStatusClear unsigned long ulBase unsigned long ulChannel unsigned long ulStatus Parameters ulBase specifies the LPC module base address ulChannel specifies the LPC Channel ulStatus is the user bit values to clear Description This function sets the selected user bits of the status word for an LPC channel Returns None September 05 2012 257 Low Pin Count Interface LPC 17 2 1
74. LPCCOMxIntDisable unsigned long ulBase unsigned long ullIntFlags Parameters ulBase specifies the LPC module base address ullntFlags is a bit mask of the interrupt sources to be disabled Description This function disables the indicated COM x interrupt sources from triggering the COMx interrupt in the primary LPC interrupt registers Returns None 17 2 1 17 LPCCOMxIntEnable Enables individual COMx interrupt sources Prototype void LPCCOMxIntEnable unsigned long ulBase unsigned long ullIntFlags Parameters ulBase specifies the LPC module base address ullntFlags is a bit mask of the interrupt sources to be enabled Description This function enables the indicated COM x interrupt sources to trigger the COMx interrupt in the primary LPC interrupt registers Returns None September 05 2012 259 Low Pin Count Interface LPC 17 2 1 18 LPCCOMxiIntStatus Gets the current COM x interrupt status Prototype unsigned long LPCCOMxIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase specifies the LPC 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 COMx module Returns The current interrupt status 17 2 1 19 LPCConfigGet Gets the current configuration of the LPC module Prototype unsigned long LP
75. LPCStatusGet Returns the status of the LPC module Prototype unsigned long LPCStatusGet unsigned long ulBase unsigned long pulCount unsigned long xpulPoolSize Parameters ulBase is the base address of the LPC module pulCount is a pointer to storage for the channel count pulPoolSize is a pointer to storage for the register pool size Description This function reads the value of the LPC Status register calculates the number of channels and buffer pool size and then returns the raw status value Returns Returns the contents of the LPC Status register 268 September 05 2012 Low Pin Count Interface LPC 17 2 1 38 LPCWordRead Reads a word from the LPC channel pool Prototype unsigned long LPCWordRead unsigned long ulBase unsigned long ulOffset Parameters ulBase specifies the LPC module base address ulOffset specifies the offset from the beginning of the LPC channel pool Description This function reads a word from the channel pool The u Offset specified must be word aligned Returns Returns the word read from the pool memory 17 2 1 39 LPCWordWrite Writes a word to the LPC channel pool Prototype void LPCWordWrite unsigned long ulBase unsigned long ulOffset unsigned long ulData Parameters ulBase specifies the LPC module base address ulOffset specifies the offset from the beginning of the LPC channel pool ulData specifies the word to write Description
76. None 21 2 2 21 PWMGenPeriodGet Gets the period of a PWM generator block Prototype unsigned long PWMGenPeriodGet unsigned long ulBase unsigned long ulGen Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to query This parameter 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 specified 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 September 05 2012 315 Pulse Width Modulator PWM 21 2 2 22 PWMGenPeriodSet Sets 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 This parameter must be one of PWM_GEN_0O 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 p
77. 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 has 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 option 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 30 3 2 29 USBHostEndpointDataAck Acknowledge that data was read from the given endpoint s FIFO in host mode 482 September 05 2012 USB Controller Prototype void USBHostEndpointDataAck unsigned long ulBase unsigned long ulEndpoint 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 30 3 2 30 USBHostEndpointDataToggle
78. PECI polls ulOffset is the offset to be applied to all temperature values to convert from relative to abso lute ulRetry is the number of retry attempts for a PECI transaction Description This function initializes operation of the PECI block It programs the bit rate polling rate and retry counts for PECI transactions It also programs the offset value to be used to translate relative temperature values from PECI transactions to absolute values At the end of this function no host domain combinations are enabled Each desired host domain combination can be configured enabled with a call to PECIDomainEnable The peripheral clock is the same as the processor clock This value is returned by SysCtlClock Get or it can be explicitly hard coded if it is constant and known to save the code execution overhead of a call to SysCtlClockGet The u Baud parameter defines the starting bit rate for the PECI transactions This value is used to calculate a divisor value based on the specified u PECICI k If the exact baud rate cannot be achieved due to rounding the baud rate is programmed to the nearest value that is less than the specified value Note that due to client clock stretching and delays through external components the actual baud rate observed on the PECI bus will always be lower than the value specified in this parameter The ulPoll parameter defines the polling rate in milliseconds used for PECI transactions For generati
79. 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 is set to the DATAO state and if it is true it is 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 September 05 2012 483 USB Controller 30 3 2 31 USBHostEndpointStatusClear Clears the status 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 should be cleared Description This function clears the status of any bits that are passed in the u Flags parameter T
80. Slave Data Register Returns Returns the byte received from by the I2C Slave cast as an unsigned long 14 2 2 27 2CSlaveDataPut Transmits a byte from the I2C Slave Prototype void I2CSlaveDataPut unsigned long ulBase unsigned char ucData Parameters ulBase is the base address of the I2C Slave module ucDaia is the data to be transmitted from the 12C Slave Description This function places the supplied data into 12C Slave Data Register Returns None September 05 2012 215 Inter Integrated Circuit I2C 14 2 2 28 2CSlaveDisable Disables the I2C slave block Prototype void I2CSlaveDisable unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description This function disables operation of the 12C slave block Returns None 14 2 2 29 2CSlaveEnable Enables the I2C Slave block Prototype void I2CSlaveEnable unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description This fucntion enables operation of the 12C Slave block Returns None 14 2 2 30 I2CSlavelnit Initializes the 12C Slave block Prototype void I2CSlaveInit unsigned long ulBase unsigned char ucSlaveAddr 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 by configuring the slave address and enabl
81. Synchronous Serial Interface SS The peripheral clock is the same as the processor clock This value is returned by SysCtIClock Get 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 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 DataGet 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 pulData 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 If there is no data available this function waits until data is received before returning 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 Data contain valid data Returns None SSIDataGetNonBlocking Gets a data element from the SSI receive FIFO Prototype long SSIDataGetNonBlocking unsigned long ulBase unsigned long pulData
82. The remaining 1984 or 4032 bytes are configurable however the application requires The FIFO configuration is usually set up at the beginning of the September 05 2012 465 USB Controller 30 3 2 30 3 2 1 30 3 2 2 466 application and not modified once the USB controller is in use The FIFO configuration uses the USBFIFOConfig API to configure 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 Lf USBF IFOConfig USBO_BASE USB_EP_1 64 USB_FIFO_SZ_512 USB_EP_DEV_IN ah 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 in size ff 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 returns the current device address This address was set by a call to USBDevAd drSet Note This funct
83. Then if a floating point instruction is executed from within the interrupt handler the floating point context is written to the stack prior to the execution of the floating point instruction Finally upon return from the interrupt the floating point context is restored from the stack only if it was written Using lazy save restore provides a blend between fast interrupt response and the ability to use floating point instructions in the interrupt handler The floating point unit can generate an interrupt when one of several exceptions occur The ex ceptions are underflow overflow divide by zero invalid operation input denormal and inexact exception The application can optionally choose to enable one or more of these interrupts and use the interrupt handler to decide upon a course of action to be taken in each case The behavior of the floating point unit can also be adjusted specifying the format of half precision floating point values the handle of NaN values the flush to zero mode which sacrifices full IEEE compliance for execution speed and the rounding mode for results This driver is contained in driverlib fpu c with driverlib fpu h containing the API defi nitions for use by applications September 05 2012 145 Floating Point Unit FPU 11 2 11 2 1 11 2 2 11 2 2 1 11 2 2 2 API Functions Functions void FPUDisable void void FPUEnable void void FPUFlushToZeroModeSet unsigned long ulMode void FPUH
84. UARTFlowControlGet unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function returns the current hardware flow control mode Note The 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 value is a logical OR combina tion of values UART_FLOWCONTROL_TX if transmit CTS flow control is enabled and UART_FLOWCONTROL_RX lt if receive RTS flow control is in use If hardware flow control is disabled VUART_FLOWCONTROL_NONE is returned 28 2 2 27 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 parameter is a logical OR com bination of values UART_FLOWCONTROL_TX and UART_FLOWCONTROL_RX to enable hardware transmit CTS and receive RTS flow control or UART_FLOWCONTROL_NONE to disable hardware flow control Description This function configures the required hardware flow control modes If u Mode contains flag UART_FLOWCONTROL_TX data is only transmitted if the incoming CTS signal is asserted If ulMode contains flag VART_FLOWCONTROL_RxX the RTS output is control
85. UDMA_DEF_RESERVED_SEC_ADC12 UDMA_DEF_RESERVED_SEC_ADC13 UDMA_DEF_I2SORX_SEC_RESERVED UDMA_DEF_I2S0TX_SEC_RESERVED Returns None 29 2 3 14 uDMAChannelSizeGet Gets the current transfer size for 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 450 September 05 2012 uDMA Controller 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 is returned If the transfer is complete then 0 is returned Returns Returns the number of items remaining to transfer 29 2 3 15 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 ulTransferSi
86. USB_EP_DEV_OUT or USB_EP_DEV_IN Returns None 30 3 2 23 USBFlFOConfigSet Sets the FIFO configuration for an endpoint Prototype void USBFIFOConfigSet unsigned long ulBase unsigned long ulEndpoint 478 September 05 2012 USB Controller 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 specified by one of the USB_FIFO_SZ_ values ulFlags specifies what information to set in the FIFO configuration Description This function configures the starting FIFO RAM address and size of the FIFO for a given endpoint Endpoint zero does not have a dynamically configurable FIFO so this function must not be called for endpoint zero The u FiFOSize parameter must 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 _DB at the end of the value For example use USB_FIFO_SZ_16_DB to configure an endpoint to have a 16 byte double buffered FIFO If a double buffered FIFO is used then the actual size of the FIFO is twice the size indicated by the ulFIFOSize parameter For example the USB_FIFO_SZ_16 DB value uses 32 bytes of the USB controllers FIFO memory The u FiFOAddress value should be a multiple of 8 bytes and dir
87. and USB_INT_STATUS If USB_INT_ALL is spec ified then all interrupts are 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 30 3 2 48 USBIntDisableControl Disables control interrupts on a given USB controller Prototype void USBIntDisableControl unsigned long ulBase unsigned long ulFlags Parameters ulBase specifies the USB module base address ulFlags specifies which control interrupts to disable Description This function disables 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 492 September 05 2012 USB Controller 30 3 2 49 USBIntDisableEndpoint Disables 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 disables endpoint interrupts for the USB controller specified by the u Base param eter The u Flags parameter specifies which endpoint interrupts to disable The flags pass
88. are the Organizationally Unique Iden tifier OUI This is a number assigned by the IEEE to an organization that requests a 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 September 05 2012 97 Ethernet Controller 7 2 2 14 7 2 2 15 98 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 EthernetPacketAvail Check for packet available from the Ethernet controller Prototype tBoolean EthernetPacketAvail unsigned long ulBase 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 is decremented Returns Returns true if there are one or more packets availa
89. asserted This mode 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 gather mode is a complex mode that provides a way to set up a list of transfer tasks for the UDMA controller Blocks of data can be transferred to and from arbitrary locations in memory September 05 2012 435 uDMA Controller 29 2 436 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 Defi
90. at all This inaccessible region 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 area is created by disabling the fifth sub region 4 and overlaying an additional region 4 in that space with the appropriate permissions MPURegionSet 3 0x40000000 MPU_RGN_SIZE_1M MPU_RGN_PERM_NOEXEC MPU_RGN_PERM_PRV_RW_USR_NO MPU_SUB_RGN_DISABLE_1 MPU_SUB_RGN_DISABLE_4 MPU_RGN_ENABLBE MPURegionSet 4 0x40080000 MPU_RGN_SIZE_128K MPU_RGN_PERM_NOEXEC MPU_RGN_PERM_PRV_RW_USR_RW MPU_RGN_ENABLBE In this example compile time registration of interrupts is used so the handler does not have to be registered However it must be enabled IntEnable FAULT_MPU When setting up the regions region 2 was initially disabled for some reason At some point it must be enabled it MPURegionEnable 2 Now the MPU is enabled It is configured so that a default map is available in privileged mode if no regions are defined The MPU is not enabled for the hard fault and NMI handlers meaning that a default is not 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 config
91. base address of the I2C Master module ullntFlags is the bit mask of the interrupt sources to be disabled Description This function disables the indicated 12C Master 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 I2CMasterIntEnableEx Returns None 14 2 2 16 2CMasterlntEnable Enables the I2C Master interrupt Prototype void I2CMasterIntEnable unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This function enables the 12C Master interrupt source Returns None 210 September 05 2012 Inter Integrated Circuit 12C 14 2 2 17 2CMasterlntEnableEx Enables individual 12C Master interrupt sources Prototype void I2CMasterIntEnableEx unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the base address of the I2C Master module ullntFlags is the bit mask of the interrupt sources to be enabled Description This function enables the indicated 12C Master 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_MASTER_INT_TIMEOUT Clock Timeout interrupt m 12C_MASTE
92. bits including any stop bits have cleared the transmitter The return value is VART_TXINT_MODE_FIFO if the interrupt is configured to be asserted based on the level of the transmit FIFO 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_TXINT_MODE_EOT 28 2 2 46 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 432 September 05 2012 28 3 Description This function allows the mode of the UART transmit interrupt to be set 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 is asserted once the transmitter is com pletely idle the transmit FIFO is empty and all bits including any stop bits have cleared the transmitter Note UART By default The availability of end of transmissi
93. by interrupts optionally using the UDMA controller A non blocking read is configured by using the function EPINonBlock ingReadConfigure 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 EPINonBlock ingReadAvail returns the number of items in the FIFO that can be read immediately without stalling There are 3 functions available for reading data from the FIFO and into a buffer provided by September 05 2012 External Peripheral Interface EP the application These functions are EPINonBlockingReadGet32 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 EPIIntDisable 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 EP
94. comparator input it only configures an analog comparator pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 20 GPIOPinTypeEP 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 Description The external peripheral interface pins must be properly configured for the external peripheral interface 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 function cannot be used to turn any pin into an external peripheral interface pin it only configures an external peripheral interface pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 21 GPlOPinTypeEthernetLED Configures pin s for use by the Ethernet peripheral as LED signals Prototype void GPIOPinTypeEthernet LED unsigned long ulPort unsigned
95. 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 Description This function reads a status register of the CAN controller and returns it to the caller The different status registers are m CAN_STS_ CONTROL the main controller status September 05 2012 5 3 Controller Area Network CAN 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 is cleared This parameter 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 m CAN_STATUS_EPASS CAN controller is in the error passive state CAN_STATUS_RXOK a message was received successfully independent of any mes sage filtering m CAN_STATUS_TXOK a message was successfully transmitted m CAN_STATUS_LEC_ MSK mask of last error code bits 3 bits m CAN STATUS LEC NONE no error m CAN_STATUS_LEC STUFF stuffing error detected CAN_STATUS_LEC FORM a format error occu
96. 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 Note The interrupt sources vary based on the Stellaris part in use Please consult the data sheet for the part you are using to determine which interrupt sources are available 24 2 2 19 SysCtllntUnregister Unregisters the interrupt handler for the system control interrupt Prototype void SysCtlIntUnregister void Description This function unregisters the handler to be called when a system control interrupt occurs This function also masks 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 24 2 2 20 SysCtllOSCVerificationSet Configures the internal oscillator verification timer Prototype void SysCt110SCVerificationSet tBoolean bEnable September 05 2012 357 System Control 24 2 2 21 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 is generated if the internal oscillator ceases to operate The internal oscillator verification timer is only available on Sandstorm class
97. current value of the sub second count for the for the RTC in 1 32768 of a second increments Note The Hibernation sub second RTC Match 0 feature is not available on all Stellaris devices Please consult the data sheet for the Stellaris device that you are using to determine if this feature is available Returns The current RTC sub second count in 1 32768 seconds 13 2 2 31 HibernateRTCSSMatchOGet Returns the value of the RTC sub second match 0 register Prototype unsigned long HibernateRTCSSMatch0Get void 194 September 05 2012 Hibernation Module Description This function returns the current value of the sub second match 0 register for the RTC The value returned is in 1 32768 second increments Note The Hibernation sub second RTC Match 0 feature is not available on all Stellaris devices Please consult the data sheet for the Stellaris device that you are using to determine if this feature is available Returns Returns the value of the sub section match register 13 2 2 32 HibernateRTCSSMatchOSet Sets the value of the RTC sub second match 0 register Prototype void HibernateRTCSSMatchOSet unsigned long ulMatch Parameters ulMatch is the value for the sub second match register Description This function sets the sub second match 0 register for the RTC in 1 32768 of a second incre ments The Hibernation module can be configured to wake from hibernation and or generate an interrupt when the value o
98. 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 is returned Returns Returns a bit packed byte where each bit 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 September 05 2012 161 GPIO 12 2 2 16 GPlOPinRead 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 Returns Returns a bit packed byte providing the state of the specified pin where bit O of the byte represen
99. function Note The amount of memory available in the Hibernation module varies across Stellaris devices Please consult the data sheet for the Stellaris device that you are using to determine the amount of memory available in the Hibernation module Returns None HibernateDisable Disables the Hibernation module for operation Prototype void HibernateDisable void September 05 2012 Hibernation Module Description This function disables the Hibernation module After this function is called none of the Hiber nation module features are available Returns None 13 2 2 8 HibernateEnableExpClk Enables the Hibernation module for operation Prototype void HibernateEnableExpClk unsigned long ulHibClk Parameters ulHibClk is the rate of the clock supplied to the Hibernation module Description This function enables the Hibernation module for operation This function should be called before any of the Hibernation module features are used The peripheral clock is the same as the processor clock This value is returned by SysCtIClock Get 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 13 2 2 9 HibernateGPlORetentionDisable Disables
100. 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 12 2 2 13 GPlOPinIntDisable Disables interrupts for the specified pin s Prototype void GPIOPinIntDisable 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 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 160 September 05 2012 GPIO Returns None 12 2 2 14 GPlOPinIntEnable 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 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 12 2 2 15 GPlOPinIntStatus Gets interrupt status
101. interrupts are enabled the handler is 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 clears 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 using 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 me
102. is the ADC bit resolution Description The ADC resolution is set as specified by u Resolution It must be one of ADC_RES_12BIT or ADC_RES_10BIT Note The ADC resolution can only be set on parts that are capable of changing ADC resolution mode Consult the data sheet for your part to determine if it is capable of operating in more than one resolution mode Returns None 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 This function configures the initiation criteria for a sample sequence Valid sample sequencers range from zero to three sequencer zero captures up to eight samples sequencers one and two capture up to four samples and sequencer three captures a single sample The trigger condition and priority with respect to other sample sequencer execution are set The ulTrigger parameter can take on the following values ADC_TRIGGER_PROCESSOR A trigger generated by the processor via the ADCPro
103. 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 M 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 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 enabled comparator interrupts can be reflected to the processor Sept
104. long ulBase Parameters ulBase specifies the USB module base address Description This function changes the mode of the USB controller to OTG mode This function is only valid on microcontrollers that have the OTG capabilities Returns None USBOTGSessionRequest Starts or ends a session 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 starts a session and if it is false it ends a session Returns None 30 3 2 62 USBPHYPowerOff Powers off the USB PHY Prototype void USBPHYPowerOff unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function powers off the USB PHY reducing the current consuption of the device While in the powered off state the USB controller is unable to operate Returns None September 05 2012 499 USB Controller 30 3 2 63 USBPHYPowerOn 30 4 500 Powers on the USB PHY Prototype void USBPHYPowerOn unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function powers on the USB PHY enabling it return to normal operation By default the PHY is powered on so this func
105. long ulBase unsigned long ulFlags void USBIntDisableControl unsigned long ulBase unsigned long ulFlags void USBIntDisableEndpoint 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 USBiIntUnregister unsigned long ulBase unsigned long USBModeGet unsigned long ulBase unsigned long USBNumEndpointsGet unsigned long ulBase void USBOTGMode unsigned long ulBase void USBOTGSessionRequest 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 complies with the standard USB interpretation of these terms For example an OUT endpoint on a microcontroller that has only a device interface actually receives data on this endpoint while a microcontroller that has a host
106. meaning with each interrupt flag Returns None FanintRegister Registers an interrupt handler for the FAN module Prototype void FanIntRegister unsigned long ulBase void pfnHandler void Parameters ulBase is the base address of the FAN module pfnHandler is a pointer to the function to be called when the interrupt is activated Description This function registers and enables the handler to be called when the FAN module generates an interrupt Specific FAN interrupts must still be enabled with the FanIntEnable function See also IntRegister for important information about registering interrupt handlers September 05 2012 9 2 2 15 9 2 2 16 9 3 Fan Controller Returns None FanlntStatus Gets the FAN module interrupt status Prototype unsigned long FanIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase is the base address of the FAN module bMasked is true to get the masked interrupt status or false to get the raw interrupt status Description This function returns the interrupt status of the FAN module It can return either the raw or masked interrupt status Returns Returns the masked or raw FAN interrupt status as a bit field of multiple FAN interrupt flags For a list of all the possible interrupt flags refer to the documentation for the function FanIntEn able FanIntUnregister Unregisters an interrupt handler for the FAN module Proto
107. module base address ulEndpoint is the endpoint to access ulFlags specifies which direction to disable Description This function disables DMA on a given endpoint to allow non DMA USB transactions to gener ate interrupts normally The ulFlags should be USB_EP_DEV_IN or USB_EP_DEV_OUT all other bits are ignored Returns None September 05 2012 475 USB Controller 30 3 2 19 USBEndpointDMAEnable Enable DMA on a given endpoint Prototype void USBEndpointDMAEFnable 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 enables DMA on a given endpoint and configures the mode according to the values in the u Flags parameter The u Flags parameter should have USB_EP_DEV_IN or USB_EP_DEV_OUT set Returns None 30 3 2 20 USBEndpointStatus 476 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 returns the status of a given endpoint If any of these status bits must be cleared then the USBDevEndpointStatusClear or the USBHostEndpointStatusClear f
108. 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 comparator 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 September 05 2012 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
109. 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 function cannot be used to turn any pin into a SSI pin it only configures a SSI pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 36 GPIOPinTypeTimer Configures pin s for use by the Timer peripheral Prototype void GPIOPinTypeTimer unsigned long ulPort unsigned char ucPins 172 September 05 2012 GPIO 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 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
110. peripheral pin with out having to know which GPIO pin is shared with the peripheral pin This method makes peripheral pin configuration easier and clearer because the pin can be specified by the peripheral pin name instead of the GPIO name which may be error prone These functions can only be used on mi crocontrollers that don t offer flexible pin muxing See the device data sheet to determine if these functions can be used with a particular microcontroller 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 because 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 configuration control code between projects that use 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 is automatically reconfigured based on the target part Because the peripheral pin mapping functions configure a single pin at a time it may be more efficient to use the GPIOPinTypex functions instead
111. port pin 0 bit 1 represents GPIO port pin 1 and so on Note This function cannot be used to turn any pin into an Ethernet MII pin it only configures an Ethernet MIl pin for proper operation Devices with flexible pin muxing also require a GPIOPin Configure function call Returns None 12 2 2 23 GPIOPinTypeFan Configures pin s for use by the fan module Prototype void GPIOPinTypeFan unsigned long ulPort unsigned char ucPins September 05 2012 165 GPIO Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s Description The fan pins must be properly configured for the fan controller to function correctly This func tion 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 function cannot be used to turn any pin into a fan pin it only configures a fan pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 24 GPIOPinTypeGPIOInput Configures pin s for use as GPIO inputs Prototype void GPIOPinTypeGPIOInput unsigned long ulPort unsigned cha
112. read is determined by the e ntStsReg parameter which can have one of the following values CAN_INT_STS_CAUSE indicates the cause of the interrupt 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 The value returned is 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 also clears 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_STS_OBJECT returns a bit mask indicating which message objects have pending interrupts This value 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 CANIntUnregister Unregisters an interrupt handler for the CAN controller Prototype void C
113. result Returns Returns true if the module is already active and false if not September 05 2012 189 Hibernation Module 13 2 2 19 HibernateLowBatGet Gets the currently configured low battery detection behavior Prototype unsigned long HibernateLowBatGet void Description This function returns a value representing the currently configured low battery detection be havior The return value is a combination of the values described in the HibernateLowBatSet function Returns Returns a value indicating the configured low battery detection 13 2 2 20 HibernateLowBatSet Configures the low battery detection Prototype void HibernateLowBatSet unsigned long ulLowBatFlags Parameters ulLowBatFlags specifies behavior of low battery detection Description This function enables the low battery detection and whether hibernation is allowed if a low battery is detected If low battery detection is enabled then a low battery condition is indicated in the raw interrupt status register which 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 The other setting in the u LowBatFlags allows the caller to set one of the following voltage l
114. 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 13 2 2 13 HibernatelntDisable 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 This function disables the specified interrupt sources from the Hibernation module The ulintFlags parameter has the same definition as the ullntFlags parameter to the Hiber natelntEnable function Returns None 13 2 2 14 HibernatelntEnable Enables interrupts for the Hibernation module Prototype void HibernateIntEnable unsigned long ullIntFlags Parameters ullntFlags is the bit mask of the interrupts to be enabled September 05 2012 187 Hibernation Module Description This function 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_WR_COMPLETE write complete interrupt HIBERNATE_INT_PIN_WAKE wake from pin interrupt HIBERNATE_INT_LOW_BAT low baitery interrupt HIBERNATE_INT_RTC_MATCH_0 RTC match 0 interrupt
115. 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 following values LPC_INT_RST LPC_INT_SLEEP LPC_INT_COMx LPC_INT_SIRQ LPC_INT_CHn_EP_TO HOST LPC_INT_CHn_EP_FROM_DATA LPC_INT_CHn_EP_FROM_CMD LPC_INT_CHn_MB_HOST_WON LPC_INT_CHn_MB_HOST_WRITE LPC_INT_CHn_MB_HOST_READ or LPC_INT_CHn_MB_MCU_LOST where CHn can be CH6 CH5 CH4 CH3 CH2 CH1 or CHO Returns None 17 2 1 26 LPCIntRegister Registers an interrupt handler for the LPC module Prototype void LPCIntRegister unsigned long ulBase void pfnHandler void Parameters ulBase specifies the LPC module base address September 05 2012 263 Low Pin Count Interface LPC pfnHandler is a pointer to the function to be called when the LPC interrupt occurs Description This function registers the handler to be called when an LPC interrupt occurs This function enables the global interrupt in the interrupt controller specific LPC interrupts must be enabled via LPCIntEnable If necessary it is the interrupt handler s responsibility to clear the interrupt source via LPCIntClear See also IntRegister for important information about registering interrupt handlers Returns None 17 2 1 27 LPCintStatus Gets the current interrupt status Prototype unsigned long LPCIntStatus unsigned long ulBase tBoolean bMasked
116. subseconds counter can be set and read using the HibernateRT CSSMatchOSet and HibernateRTCSSMatchOSet functions Application state information can be stored in the battery backed memory of the Hibernation module when the processor is powered off Use the HibernateDataSet and HibernateDataGet functions to access the battery backed 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 September 05 2012 Hibernation Module present configuration can be read by calling HibernateWakeGet In addition some devices can be configured to wake when the battery is low 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 On some devices the battery level can be measured using the HibernateBatCheckStart and HibernateBatCheckDone functions Several functions are provided for managing 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
117. systick h containing the API definitions for use by applications 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 September 05 2012 383 System Tick SysTick 26 2 2 2 26 2 2 3 384 Prototype void SysTickDisable void Description This function stops the SysTick counter If an interrupt handler has been registered it is not called until SysTick is restarted Returns None SysTickEnable Enables the SysTick counter Prototype void SysTickEnable void Description This function starts the SysTick counter If an interrupt handler has been registered it is called when the SysTick counter rolls over Note Calling this function causes th
118. than one GPIO pin To fully configure a pin a GPIOPinTypex function should also be called The available mappings are supplied on a per device basis in pin_map h The PART_IS_ lt partno gt define enables the appropriate set of defines for the device that is be ing used Note This function is not valid on Sandstorm Fury and Dustdevil class devices Also if the same signal is assigned to two different GPIO port pins the signal is assigned to the port with the lowest letter and the assignment to the higher letter port is ignored September 05 2012 159 GPIO Returns None 12 2 2 12 GPlOPinIntClear 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 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 M 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
119. that is read from the Hibernation module is stored ulCount is the count of 32 bit words to read September 05 2012 183 Hibernation Module 13 2 2 6 13 2 2 7 184 Description This function retrieves a set of data from the Hibernation module battery backed memory that was previously stored with the HibernateDataSet function The caller must ensure that pul Data points to a large enough memory block to hold all the data that is read from the battery backed memory Note The amount of memory available in the Hibernation module varies across Stellaris devices Please consult the data sheet for the Stellaris device that you are using to determine the amount of memory available in the Hibernation module Returns None HibernateDataSet Stores data in the battery backed 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 battery backed memory This memory is pre served when the power to the processor is turned off and can be used to store application state information which is available when the processor wakes Up to 16 32 bit words can be stored in the battery backed memory The data can be restored by calling the HibernateDataGet
120. 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 also clears any pending interrupt on the message object Once a message object has been configured using CANMessageSet the message object has been allocated and continues to perform its programmed function unless it is released by a call to CANMessageClear The application is not required to clear out a message object before set ting it with a new configuration because each time CANMessageSei is called it overwrites 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 September 05 2012 47 C
121. 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 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 places the supplied data into 12C Master Data Register Returns None September 05 2012 Inter Integrated Circuit 12C 14 2 2 8 2CMasterDisable Disables the 12C master block Prototype void I2CMasterDisable unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This function disables operation of the 12C master block Returns None 14 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 function enables operation of the 12C Master block Returns None 14 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
122. to have interrupts and triggers enabled This parameter 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 This function unmasks the specified interrupt s and trigger s by setting the specified bits of the interrupt 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 September 05 2012 Pulse Width Modulator PWM 21 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 This parameter must be one of PWM_GEN_0O PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 Description This function unregisters the interrupt handler for the specified PWM generator block This function also disables 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
123. 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 configure 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
124. u Config as one of the following values TIMER_CFG_ONE_SHOT Full width one shot timer a TIMER_CFG_ONE_SHOT_UP Full width one shot timer that counts up instead of down not available on all parts TIMER_CFG_PERIODIC Full width periodic timer a TIMER_CFG_PERIODIC_UP Full width periodic timer that counts up instead of down not available on all parts a TIMER_CFG_RTC Full width real time clock timer TIMER_CFG_SPLIT_PAIR Two half width timers When configured for a pair of half width 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 ulConfig TIMER_CFG_A_ONE_SHOT Half width one shot timer September 05 2012 391 Timer Pll ER 27 2 2 3 392 TIMER_CFG_A_ONE_SHOT_UP Half width one shot timer that counts up instead of down not available on all parts TIMER_CFG_A_PERIODIC Half width periodic timer TIMER_CFG_A_PERIODIC_UP Half width periodic timer that counts up instead of down not available on all parts a TIMER_CFG_A_CAP_COUNT Half width edge count capture a TIMER_CFG_A_CAP_COUNT_UP Half width edge count capture that counts up instead of down not available on all parts TIMER_CFG_A_CAP_TIME Half width edge time capture TIMER_CFG_A_CAP_TIME_UP Half width edge time capture that counts up instead of down not available on all parts a TIMER_CFG_A_PWM Half widt
125. 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 function 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 September 05 2012 31 2 2 6 31 2 2 7 Watchdog Timer WatchdoglIntTypeSet Sets the type of interrupt generated by the watchdog Prototype void WatchdogIntTypeSet unsigned long ulBase unsigned long ulType Parameters ulBase is the base address of the watchdog timer module ulType is the type of interrupt to generate Description This function sets the type of interrupt that is generated if the watchdog timer expires u Type can be either WATCHDOG_INT_TYPE_INT to generate a standard interrupt the default or WATCHDOG_INT_TYPE_NMI to generate a non maskable interrupt NMI When configured to generate an NMI the watchdog interrupt must still be enabled with Watch dogIntEnable and it must still be cleared inside the NMI handler with WatchdogIntClear Note The ability to select an NMI interrupt varies with the Stellaris part in use Please consul
126. ulBlock unsigned long pulPassword unsigned long ulCount Parameters ulBlock is the EEPROM block number for which the password is to be set pulPassword points to an array of unsigned long values comprising the password to set Each element may be any 32 bit value other than OxFFFFFFFF This array must contain the number of elements given by the ulCount parameter ulCount provides the number of unsigned longs in the ulPassword Valid values are 1 2 and 3 Description This function allows the password used to unlock an EEPROM block to be set Valid passwords may be either 32 64 or 96 bits comprising words with any value other than OxFFFFFFFF The password may only be set once Any further attempts to set the password result in an error Once the password is set the block remains unlocked until EEPROMBlockLock is called for that block or block 0 or a reset occurs If a password is set on block 0 this affects locking of the peripheral as a whole When block 0 is locked all other EEPROM blocks are inaccessible until block 0 is unlocked Once block 0 is unlocked other blocks become accessible according to any passwords set on those blocks and the protection set for that block via a call to EEPROMBlockProtectSet Returns Returns a logical OR combination of EEPROM_RC_INVPL EEPROM_RC_WRBUSY EEPROM_RC_NOPERM EEPROM_RC_WKCOPY EEPROM_RC_WKERASE and EEP ROM_RC_WORKING to indicate status and error conditions 6 2 3 5 EEPROMBlockP
127. 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 the part s data sheet for a description of the trigger chain Note This functionality is not available on all parts This function should not be used for Timer OA or Wide Timer 0A 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 September 05 2012 27 2 2 8 217 2 2 9 Timer Description This function disables 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 Description This function enables operation of the timer module The timer must be configured before it is enabled Returns None TimerlntClear Clears t
128. 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 full width operation Description This function reads the current value of the specified timer Note This function can be used for both full and half width modes of 16 32 bit timers and for half width modes of 32 64 bit timers Use TimerValueGet64 for full width modes of 32 64 bit timers Returns Returns the current value of the timer TimerValueGet64 Gets the current 64 bit timer value Prototype unsigned long long TimerValueGet 64 unsigned long ulBase Parameters ulBase is the base address of the timer module Description This function reads the current value of the specified timer September 05 2012 Timer Returns Returns the current value of the timer 27 3 Programming Example The following example shows how to use the timer API to configure the timer as a half width one shot timer and a half width edge capture counter Configure TimerA as a half width one shot timer and TimerB as a half width edge capture counter TimerConfigure TIMERO_BASE TIMER_CFG_SPLIT_PAIR TIMER_CFG_A_ONE_SHOT TIMER_CFG_B_CAP_COUNT Set the count time for the the one shot timer TimerA TimerLoadSet TIMERO_BASE TIMER_A 3000 Configure the counter Ti
129. used to only accept the direction specified in the message type Another additional filter flag is MSG_OBJ_USE_EXT_FILTER which filters on only extended identi fiers In a mixed 11 bit and 20 bit identifier system this parameter prevents an 11 bit identifier from being confused with a 20 bit identifier of the same value It is not necessary to specify this param eter 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 uIMsgIDMask 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 flag is useful when an application must receive more than the 8 bytes of data that can be received by a single CAN message object It can also be used to reduce the likelihood of causing an overrun of data 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 September 05 2012 5 4 Contr
130. void FanIntClear unsigned long ulBase unsigned long ulFlags void FanIntDisable unsigned long ulBase unsigned long ulFlags void FanIntEnable unsigned long ulBase unsigned long ulFlags void FanIntRegister unsigned long ulBase void xpfnHandler void unsigned long FanIntStatus unsigned long ulBase tBoolean bMasked void FanIntUnregister unsigned long ulBase Detailed Description In order to function a FAN channel must first be enabled using the function FanChannelEnable A channel can be disabled with FanChannelDisable A FAN channel can be configured for manual or automatic mode In manual mode the application sets the PWM duty cycle directly and can monitor the RPM In automatic mode the application sets the desired RPM and the Fan Controller adjusts the PWM duty cycle to achieve the commanded RPM A FAN channel must be configured for either automatic or manual mode using FanChannel ConfigAuto or FanChannelConfigManual Once a FAN channel is configured the application can update the speed of the cooling fan by using FanChannelRPMSet if in automatic mode or FanChannelDutySet if in manual mode The actual RPM can be queried for both manual and automatic mode by using FanChannelRPMGet The duty cycle can be determined by calling FanChannelDutyGet If the channel is configured for manual mode the duty cycle value that is returned is the same value that was commanded But if the channel is in automatic mode th
131. void SysCtlIUSBPLLDisable void void SysCtlIUSBPLLEnable void 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 provided 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 September 05 2012 347 System Control 24 2 2 24 2 2 1 24 2 2 2 348 The system control interrupt is managed with SysCtllntRegister SysCtllntUnregister SysCtlln tEnable SysCtllntDisable SysCtlIntClear SysCtlIntStatus The LDO is controlled with SysCtILDOSet and SysCtiLDOConfigSet Its status is provided by SysCt
132. x pucBuf long 1BufLen Parameters ulBase is the base address of the controller pucBuf 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 returns immediately Otherwise the function reads the entire packet from the receive FIFO If there are more bytes in the packet than can fit into pucBuf as specified by BufLen the function returns the negated length of the packet and the buffer contains BufLen bytes of the packet Otherwise the function returns the length of the packet that was read and pucBuf contains 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 returns 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 pucBuf long 1BufLen September 05 2012 99 Ethernet Controller 7 2 2 18 100 Parameters ulBase is the base a
133. 0 indicating that the processor is running at 20 MHz This call is only needed on a Sandstorm or Fury device FlashUsecSet 20 def Erase a block of the flash FlashErase 0x800 Program some data into the newly erased block of the flash pulData 0 0x12345678 pulData 1 0x56789abc FlashProgram pulData 0x800 sizeof pulData September 05 2012 143 Flash 144 September 05 2012 11 11 1 Floating Point Unit FPU Floating Point Unit FPU OUT anena aa aa aa dbe andi Deeded abide here daubon ad Meee 145 Pr PMC HONS 6 tancaee ec aah oleate aman ls bo sent ca eo boa been nee e eae bee ntoreuwess 146 Pregrammmg ERIN DIE ccc annntnaeceipisew edd caeeagemeeentbagenecEsepegarsouqueneeseebedeereenmaedas 150 Introduction The floating point unit FPU driver provides methods for manipulating the behavior of the floating point unit in the Cortex M processor By default the floating point is disabled and must be enabled prior to the execution of any floating point instructions If a floating point instruction is executed when the floating point unit is disabled a NOCP usage fault is generated This feature can be used by an RTOS for example to keep track of which tasks actually use the floating point unit and therefore only perform floating point context save restore on task switches that involve those tasks There are three methods of handling the floating point context when the proc
134. 0 PWMGenFaultClear 308 Clears one or more latched fault triggers for a given PWM generator September 05 2012 21 2 2 11 Pulse Width Modulator PWM Prototype void PWMGenFaultClear 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 for which fault trigger states are being queried This parameter 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 parameter 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 generator This function is only required if PWMGenConfigure has previously been called with flag PWM_GEN_MODE_FAULT_LATCHED 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 for which
135. 1 PECI_M0OD1_MODE2 PECI_M0D1_MODE3 PECI_M1D0_MODE1 PECI_M1D0_MODE2 PECI_M1D0_MODE3 PECI_M1D1_MODE1 PECI_M1D1_MODE2 or PECI_M1D1_MODESs3 Returns None 19 2 1 19 PEClIntRegister Registers an interrupt handler for the PECI module Prototype void PECIIntRegister unsigned long ulBase void x pfnHandler void Parameters ulBase specifies the PECI module base address pfnHandler is a pointer to the function to be called when the PECI interrupt occurs Description This function registers the handler to be called when an PECI interrupt occurs This function enables the global interrupt in the interrupt controller specific PECI interrupts must be enabled via PECIIntEnable If necessary it is the interrupt handler s responsibility to clear the interrupt source via PEClIntClear See also IntRegister for important information about registering interrupt handlers Returns None September 05 2012 291 Platform Environment Control Interface PECI 19 2 1 20 PEClIntStatus Gets the current interrupt status Prototype unsigned long PECIIntStatus unsigned long ulBase tBoolean bMasked Parameters ulBase specifies the PECI 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 PECI module Either the raw interrupt status or the status of int
136. 100 to select 100 startup duty cycle One of the following to select the number of tachometer pulses used for speed averaging FAN_CONFIG_AVG_NONE to disable fan speed averaging FAN_CONFIG_AVG_2 to select 2 pulses for speed averaging FAN_CONFIG_AVG_4 to select 4 pulses for speed averaging FAN_CONFIG_AVG_8 to select 8 pulses for speed averaging One of the following to select the tachometer pulses per revolution FAN_CONFIG_TACH_1 to select 1 pulse per revolution m FAN_CONFIG_TACH_2 to select 2 pulses per revolution FAN_CONFIG_TACH_4 to select 4 pulses per revolution FAN_CONFIG_TACH_8 to select 8 pulses per revolution Returns None 126 September 05 2012 9 2 2 2 9 2 2 3 Fan Controller FanChannelConfigManual Configures a FAN channel for manual operation Prototype void FanChannelConfigManual unsigned long ulBase unsigned long ulChannel unsigned long ulConfig Parameters ulBase is the base address of the FAN module ulChannel is the FAN channel to configure ulConfig is the logical OR of manual configuration flags Description This function configures a specific FAN channel to operate in manual mode The ulConfig parameter is the logical OR of several choices of configuration flags as follows One of the following to select the number of tachometer pulses used for speed averaging a FAN_CONFIG_AVG_NONE to disable fan speed averaging m FAN_CONFIG_AVG_2 to select 2 pulses for speed avera
137. 13 LPCChannelStatusGet Reads the status word from an LPC Channel Prototype unsigned long LPCChannelStatusGet unsigned long ulBase unsigned long ulChannel Parameters ulBase specifies the LPC module base address ulChannel specifies the LPC Channel Description This function reads the status word from an LPC channel and returns it to the caller Returns content of the channel status register 17 2 1 14 LPCChannelStatusSet Sets the user bits in the status word 16 bits of an LPC Channel Prototype void LPCChannelStatusSet unsigned long ulBase unsigned long ulChannel unsigned long ulStatus Parameters ulBase specifies the LPC module base address ulChannel specifies the LPC Channel ulStatus is the user bit values to set Description This function sets the selected user bits of the status word for an LPC channel Returns None 17 2 1 15 LPCCOMxIntClear Clears COMx interrupt sources Prototype void LPCCOMxIntClear unsigned long ulBase unsigned long ulIntFlags Parameters ulBase specifies the LPC module base address 258 September 05 2012 Low Pin Count Interface LPC ullntFlags is a bit mask of the interrupt sources to be cleared Description This function clears the specified COMx interrupt sources so that they no longer assert Returns None 17 2 1 16 LPCCOMxIntDisable Disables individual COM x interrupt sources Prototype void
138. 2 4 13 2 2 5 Hibernation Module Note The ability to configure the clock input in the Hibernation module is not available on all Stellaris devices Please consult the data sheet for the Stellaris device that you are using to determine if this feature is available Returns None HibernateClockSelect Selects the clock input for the Hibernation module Prototype void HibernateClockSelect unsigned long ulClockInput Parameters ulClockInput specifies the clock input Description This function configures the clock input for the Hibernation module The configuration option chosen depends entirely on hardware design The clock input for the module is either a 32 768 kHz oscillator crystal or a 4 194304 MHz crystal The u ClockFlags parameter must be one of the following a HIBERNATE_CLOCK_SEL_RAW use the raw signal from a 32 768 kHz oscillator HIBERNATE_CLOCK_SEL_DIV128 use the 4 194304 MHz crystal input divided by 128 Note The HIBERNATE_CLOCK_SEL_DIV128 setting is not available on all Stellaris devices Please consult the data sheet to determine if the device that you are using supports the 4 194304 crystal as a source for the Hibernation module Returns None HibernateDataGet Reads a set of data from the battery backed memory of the Hibernation module Prototype void HibernateDataGet unsigned long pulData unsigned long ulCount Parameters pulData points to a location where the data
139. 2 445 uDMA Controller 29 2 3 7 29 2 3 8 446 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 cannot respond to uDMA transfer requests until re enabled via UDMAChannelEnable 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 is automatically disabled by the UDMA con troller Therefore this function should be called prior to starting up any new transfer Returns None 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 function can be used to check the status of a transfer as the channel is automatically disabled at the end of a transfer Returns Returns true if the channel is enabled false if disabled September 05 2012 uDMA Controlle
140. 23 API FUNCIONS acraea eet a wear ee GE ae eee aw a GK ee ee ee eG a 223 Programming Exaile 2 ba waa kA ke EMR Ge Ok A hh wana we dee ee 238 Interrupt Controller NVIC 2 0 ee es 241 WESSON ss a Sie wee ee Bk ee ew aa A ow eA ale a ad ei ee a 241 API FUNCIONS oi a aoii ae arara wk Beep eae aoe eae GOR a a wre he a 242 Programming Example ewe OH ee ee RARE DO we eee PERE 249 Low Pin Count Interface LPC 0 0 eee es 251 WESSON oo oe em ek ee os oe a e EM A Qe ew a eo eR 251 API PURO 3 ma deg a ee a ae wt ee a A ee ea a EO ee ee EA aO ali 251 Memory Protection Unit MPU 2 00 2 ee 271 WOOUBEON a ee ebb bb aan Ea iian Aa a a Ww we Re eee ee ee AS woe a 271 PAP UGS oo saca a aa niea ee OR Hee pe ed a ee BO ee RR A a 271 Programming Example lt s a aca ese hE wb eb awe een eee eed PEGG a ee aa a 278 Platform Environment Control Interface PECI 000 ce ee eee eee 281 IMOGUCION ct ee ee ee OS Make AO ee nk Go eG Ge eH ea ee A a a ed 281 API PUNGIONE 22626 bee te hatascea hhene en eedigees hee ada P Oe Paw oe eS 281 Peripheral Pin Mapping 2 2 2 eee 293 WEPSHURINGT 5 se wee tee i even ee A oe a ee RE RA A oe ee ee amp Gerri Ga 293 PPPS 14 606 4008 ee ed BOG AMUN EO De ee ae ee a 293 Programming Example 24 64 ARG DP PRO EGG DEE Ee RR ER 299 Pulse Width Modulator PWM 2 62 ee 301 IPOGUCOON c or aves ee ek Re PO ee RE he ee ee Ree Re Sa BRS 301 PP PUGH o s tarada a aara a OO e
141. 2S 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 long 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 September 05 2012 223 Inter IC Sound 12S 15 2 1 224 m void I2SRxConfigSet unsigned long ulBase unsigned long ulConfig void I2SRxDataGet unsigned long ulBase unsigned long xpulData long 12SRxDataGetNonBlocking unsigned long ulBase un
142. 387 2i TIMO she De eee aa a a a ee eR de ee 389 Pol OUO oka ee bee ee ee RR REA a E hoe ae tha eed eee 389 27 2 BPLPUNCIONS oo ccr 402 be ee aaa HSH EEE ERR EEG eee ee ee eA a 390 27 9 Programming Example 0c he AeA ee ee Oe Po ene Reed ded Ga Be es 407 2 UART oot ee ee Se ee eee eae ee a ee we es ee ee 409 CST OOO a we ee ee a ee RA Ro ee ak ae ESES 4 409 26 2 AF FUNCIONS 6 6 oe ae ee ae AEE Oe ee ee RR Bae eee 409 28 9 Programming Example o essea rare oppa aaaea 42 be Pee RAPE Oe Re a 433 29 UDMA Controller o e asc r es nrasane a aaa ee ee aA a 435 el MO e aa a a EEA eae aus See E a EOS Bie Pw amp 435 202 API PUNCIONS 2 6644 5e0 0452 404 a aS Pee ewe ee ee a a a aaa ee a 436 29 9 Programming Example lt seso 4 0 eee 2 2 De Se ee eee eee ee 456 30 USB Controller ce ee a ee ee Oe ee mm ee A 459 OU Mo N WOM es a0 ke ae an oe Se ue EE Pe RE GG Gu Ew P88 ee Ete 459 30 2 Using USB with the UDMA Controller 00000 ee es 459 OU APIF eb oe ee eG Ge eS Das iy Se Ele A Le Pa EY Be aes 463 230 4 Programming Example lt s seassa OR eh eee eR Re eee ee ES 500 31 Watchdog Timer 2 6 6d eee eee ae eee ee eee 501 Sal MOGUC 2c a 4 ae eb ee Re ee ee Pe eee ee ee eee eee 501 SLL Fr UPUMCUONS soho ot eee A ES Se ee Ee ee Ree RES aw Be bes 501 91 3 Programming Example vas sas ach doe ee eee A Ee ae ee eee ee eke ee 510 32 Using the ROM aema o ee ee eae eee RE See eee ee Ree YY eee ee ewe 513 22 1 IMPOOUEIGH i 4448 a 08 e50 00
143. 4462 gee Dee eee ee eee eee OL eee Be 513 vee Direct ROM Calls e ocre e heb eee eeeod beeen eee e ER EEE ERG e ee Oe eee 513 32 3 Mapped ROM Calls c 2 ss amoa ee ee oe a we a ee oe ee ee RR 514 3224 Firmware Upale lt c ee ee e a a a e e e 515 33 EGO ManNE es ecra tse en Re lS ee Se we i ee ee Se AG 517 IMPORTANT NOTICE o eea eee tenn bee eb eee wee eee eee ewe eee ee 518 September 05 2012 5 Table of Contents 6 September 05 2012 Introduction 1 Introduction The Texas Instruments Stellaris Peripheral Driver Library is a set of drivers for accessing the peripherals found on the Stellaris family of ARM Cortex M 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 m 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 t
144. 6 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_ADDEMUX 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 EPIl_HB16_ WRWAIT_3 to select the number of write wait states default is 0 wait states m one of EPI_HB16_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 81 16 If absent all data transfers use bits 15 0 EPI_HB16_BSEL enables byte selec
145. 6_3MHZ 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 is prevented by the hardware 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 polls 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 delays until its timeout has occurred instead of completing as soon as PLL lock is achieved Returns None Sys
146. AFlags 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 UARTModemControlClear 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 ulParity void UARTRxErrorClear unsigned long ulBase unsigned long UARTRxErrorGet unsigned long ulBase
147. ANIntUnregister unsigned long ulBase Parameters ulBase is the base address of the controller Description This function unregisters the previously registered interrupt handler and disables the interrupt in the interrupt controller September 05 2012 5 2 5 14 5 2 5 15 Controller Area Network CAN 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 no longer automatically sends or receives messages nor does it generate inter rupts Returns None CANMessageGet Reads a CAN message from one of the message object buffers Prototype void CANMessageGet unsigned 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 plMsgObject points to a structure containing message object fields bCirPendingInt indicates whether an associated interrupt should be cleared Description This function is used to read
148. ATE SYSCTL_PERIPH_I2C2 SYSCTL_PERIPH_I2C5 SYSCTL_PERIPH_PECIO SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_UARTE6 one of the follow SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH_12CO SYSCTL_PERIPH_12C3 SYSCTL_PERIPH_12S0 SYSCTL_PERIPH_PWMO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI2 SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART4 SYSCTL_PERIPH_UART 7 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER2 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER4 or SYSCTL_PERIPH_WTIMERS5 Returns 362 None September 05 2012 24 2 2 29 SysCtlPeripheralDisable Disables a peripheral Prototype System Control void SysCtlPeripheralDisable unsigned long ulPeripheral Parameters ulPeripheral is the peripheral to disable Description This function disables peripherals are disabled with this function Once disabled they do not operate or respond to register reads writes The ulPeripheral parameter must be only one of the follow ing values SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CANO SYSCTL_PERIPH_CAN1
149. A_DST_INC_8 UDMA_ARB_8 The transfer buffers and transfer size are now configured The transfer uses AUTO mode which means that the transfer automatically runs to completion after the first request uDMAChannelTransferSet UDMA_CHANNEL_SW UDMA_PRI_SELECT UDMA_MODE_AUTO ucSourceBuffer ucDestBuffer sizeof ucDestBuffer Finally the channel must be enabled Because this is a software initiated transfer a request must also be made The request starts the transfer uDMAChannelEnable UDMA_CHANNEL_SW uDMAChannelRequest UDMA_CHANNEL_SW September 05 2012 457 uDMA Controller 458 September 05 2012 30 30 1 30 2 USB Controller USB Controller Mii OWEN E A ett AEPS TE E AAA E TT PO nce gah nid tots dua TA A EA ATTAT 459 Using UDMA wiih USE niies aa a D Ea E A ESR 459 PP POUMGUONS scorsi niaaa AO OR O E EE ERE 463 Programming Example vicciineseririahenteeneeagr tanner RE An NS OA EPE EDERE 500 Introduction The USB APIs provide a set of functions that are used to access the Stellaris USB device host and or device or OTG controllers The APIs are split into groups according to the functionality provided by the USB controller present in the microcontroller The groups are the following USB Dev 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
150. Avail function should be called before attempting to call this function 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 This function 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 28 2 2 10 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 This function 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 September 05 2012 415 UART 28 2 2 11 UARTCharsAvail Deter
151. BIntStatusControl Returns the control interrupt status on a given USB controller Prototype unsigned long USBIntStatusControl unsigned long ulBase September 05 2012 495 USB Controller Parameters ulBase specifies the USB module base address Description This function reads control interrupt status for a USB controller This call returns the current status for control interrupts only the endpoint interrupt status is retrieved by calling USBIntSta tusEndpoint The bit values returned should be compared against the USB_INTCTRL_ values The following are 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 USBIntDisableControl Some of these flags are only valid in the following modes as indicated in the parentheses 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 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 sig
152. Base unsigned long ulFlags September 05 2012 131 Fan Controller 9 2 2 14 132 Parameters ulBase is the base address of the FAN module ulFlags is the logical OR of all the interrupts to be enabled Description This function enables one or more interrupts from the FAN module The u Flags parameter is the logical OR of all the possible interrupts that can be enabled For each channel the following interrupt flags are available FAN_CHn_INT_STALL means that a stall was detected in either mode FAN_CHn_INT_AUTO_SPEED_ERROR means that in automatic mode the cooling fan cannot attain the commanded speed FAN_CHn_INT_AUTO_SPEED_OK means that in automatic mode the cooling fan has attained the commanded speed The interrupt flags have a different meaning if the FAN channel is configured for manual mode The following alternate set of flag names is available for convenience to use in manual mode FAN_CHn_INT_MANUAL_SPEED_UPDATE means that in manual mode the speed was calculated FAN_CHn_INT_MANUAL_SPEED_CHANGE means that in manual mode the speed changed In the above flag names the CHn placeholder should be replaced with the actual channel number 0 5 for example CH1 Note that even though the names are different for manual mode the values are the same For example _AUTO_SPEED_ ERROR is the same value as MANUAL_SPEED_UPDATE The different names are provided just to make it easier to associate a
153. BlockingReadGet16 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 reads and stores 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 is returned Returns The number 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 September 05 2012 8 2 2 21 8 2 2 22 External Peripheral Interface EPI 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 reads and stores 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 is returned Returns The number of ite
154. CConfigGet unsigned long ulBase Parameters ulBase is the base address of the LPC module Description This function queries the control register of the LPC module and returns a bit mapped value See also The description of the LPCConfigSet function provides detailed information for the bit mapped configuration values that are returned Returns Returns the bit mapped LPC module configuration value 17 2 1 20 LPCConfigSet Sets the configuration of the LPC module Prototype void LPCConfigSet unsigned long ulBase unsigned long ulConfig 260 September 05 2012 Low Pin Count Interface LPC Parameters ulBase is the base address of the LPC module ulConfig specifies the configuration of the LPC module Description This function configures the LPC module for basic operation The configuration of individual channels is handled in a separate function The ulConfig parameter is the logical OR of the following values LPC_CFG_WAKE Force assertion of the LPCOCLKRUN signal when the LPC bus is powered down LPCOPD is asserted Returns None 17 2 1 21 LPCHalfWordRead Reads a half word from the LPC channel pool Prototype unsigned short LPCHalfWordRead unsigned long ulBase unsigned long ulOffset Parameters ulBase specifies the LPC module base address ulOffset specifies the offset from the beginning of the LPC channel pool Description This function reads a half wor
155. CTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_GPIOK SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPION SYSCTL_PERIPH_GPIOQ SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2C2 SYSCTL_PERIPH_I2C4 SYSCTL_PERIPH_I2C5 SYSCTL_PERIPH_LPCO SYSCTL_PERIPH_PECIO SYSCTL_PERIPH_PWM1 SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_SSI3 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_TIMERS SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_UART5 SYSCTL_PERIPH_UARTE6 SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH_I2Co SYSCTL_PERIPH_I2C3 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_PWMO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI2 SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART4 SYSCTL_PERIPH_UART7 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER2 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER4 or SYSCTL_PERIPH_WTIMER5 Returns None September 05 2012 361 System Control 24 2 2 28 SysCtlPeripheralDeepSleepEnable Enables a peripheral in deep sleep mode Prototype void SysCt1lPeriph
156. CTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH_I2C0 SYSCTL_PERIPH _12C3 SYSCTL_PERIPH_12S0 SYSCTL_PERIPH_PWMO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI2 SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_UART1 September 05 2012 System Control SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_UART4 SYSCTL_PERIPH_UARTS5 SYSCTL_PERIPH_UARTE6 SYSCTL_PERIPH_UART7 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER2 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER4 or SYSCTL_PERIPH_WTIMERS5 Returns None 24 2 2 38 SysCtlPinPresent Determines if a pin is present Prototype tBoolean SysCt1lPinPresent unsigned long ulPin Parameters ulPin is the pin in question Description This function determines if a particular pin is present in the device The PWM analog compara tors ADC and timers have a varying number of pins across members of the Stellaris family this function determines which pins are present on this device The ulPin argument must be only one of the following values SYSCTL_PIN_PWMO SYSCTL_PIN_PWM1 SYSCTL_PIN_PWM2 SYSCTL_PIN_PWM3 SYSCTL_PIN_PWM4 SYSCTL_PIN_PWM5 SYSCTL_PIN_COMINUS SYSCTL_PIN_COPLUS SYSCTL_PIN_COO SYSCTL_PIN_C1MINUS SYSCTL_PIN_C1PLUS SYSCTL_PIN_C10 SYSCTL_PIN_C2MINUS SYSCTL_PIN_C2PLUS SYSCTL_PIN_C20 SYSCTL_PIN_ADCO SYSCTL_PIN_A
157. 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 HibernateClockSelect 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 HibernateRTCTrimGet and HibernateRTCTrimSet functions for this purpose On devices which include the subseconds counter the value of the subseconds counter can be read using HibernateRTCSSGet The match value of the
158. ClIntUnregister 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 function disables 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 September 05 2012 Analog to Digital Converter ADC Prototype unsigned long ADCPhaseDelayGet unsigned long ulBase Parameters ulBase is the base address of the ADC module 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 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 lo
159. CtIDeepSleep Puts the processor into deep sleep mode Prototype void SysCt1lDeepSleep void Description This function places the processor into deep sleep mode it does 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 September 05 2012 351 System Control 24 2 2 8 24 2 2 9 352 SysCtIDeepSleepClockSet Sets the clocking of the device while in deep sleep mode Prototype void SysCt1lDeepSleepClockSet unsigned long ulConfig Parameters ulConfig is the required configuration of the device clocking while in deep sleep mode Description This function configures the clocking of the device while in deep sleep mode The oscillator to be used and the system clock divider are configured with this function The ulConfig parameter is the logical OR of the following values The system clock divider is chosen from one of the following values SYSCTL_DSLP_DIV_1 SYSCTL_DSLP_DIV_2 SYSCTL_DSLP_DIV_3 SYSCTL_DSLP_DIV_ 64 The oscillator source is chosen from one of the following values SY SCTL_DSLP_OSC_MAIN SYSCTL_DSLP_OSC_INT SYSCTL_DSLP_OSC_INT30 or SYSCTL_DSLP_OSC_EXT32 SYSCTL_OSC_EXT32 is only available on devices with the hibernation module and t
160. DC1 SYSCTL_PIN_ADC2 SYSCTL_PIN_ADC3 SYSCTL_PIN_ADC4 SYSCTL_PIN_ADC5 SYSCTL_PIN_ADC6 SYSCTL_PIN_ADC7 SYSCTL_PIN_CCP0O SYSCTL_PIN_CCP1 SYSCTL_PIN_CCP2 SYSCTL_PIN_CCP3 SYSCTL_PIN_CCP4 SYSCTL_PIN_CCP5 SYSCTL_PIN_CCP6 SYSCTL_PIN_CCP7 SYSCTL_PIN_32KHZ or SYSCTL_PIN_MC_FAULTO Returns Returns true if the specified pin is present and false if it is not 24 2 2 39 SysCtIPIOSCCalibrate Calibrates the precision internal oscillator Prototype unsigned long SysCt1lPIoOSCCalibrate unsigned long ulType Parameters ulType is the type of calibration to perform September 05 2012 371 System Control Description This function performs a calibration of the PIOSC There are three types of calibration available the desired calibration type as specified in u Type is one of m SYSCTL_PIOSC_CAL_AUTO to perform automatic calibration using the 32 kHz clock from the hibernate module as a reference This type is only possible on parts that have a hibernate module and then only if it is enabled and the hibernate module s RTC is also enabled SYSCTL_PIOSC_CAL_FACT to reset the PIOSC calibration to the factory provided cali bration SYSCTL_PIOSC_CAL_USER to set the PIOSC calibration to a user supplied value The value to be used is ORed into the lower 7 bits of this value with 0x40 being the nominal value in other words if everything were perfect 0x40 provides exactly 16 MHz Values larger than 0x40 slow down PIOSC
161. DMAEnable void void uUDMAErrorStatusClear void unsigned long UDMAErrorStatusGet void September 05 2012 29 2 1 uDMA Controller void uUDMAIntClear unsigned long ulChanMask void uUDMAIntRegister unsigned long ullntChannel void pfnHandler void m unsigned long uUDMAIntStatus void m void uUDMAIntUnregister unsigned long ullntChannel Detailed Description The uDMA API functions provide a means to enable and configure the Stellaris UDMA 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 called once to enable the controller m uDMAControlBaseSet is called once to set the channel control table m 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 is only 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
162. GEN_ 3 ulGroup indicates the subset of faults that are being queried This parameter 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 PWM GenConfigure has previously been called with flag PWM_GEN_MODE_FAULT_LATCHED 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_ 0 the returned value is a logical OR of PWM_FAULT_FAULTO PWM_FAULT_FAULT1 PWM_FAULT_FAULT2 or PWM_FAULT_FAULT3 For PWM_FAULT_GROUP_1 the return value is the log ical 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 21 2 2 138 PWMGenFaultTriggerGet Returns the set of fault triggers currently configured for a given PWM generator Prototype unsigned long PWMGenFaultTriggerGet unsigned long ulBase 310 September 05 2012 Pulse Width Modulator PWM unsigned long u
163. HB8 use with host bus 8 bit interface EPI MODE_HB16 use with host bus 16 bit interface EPl_MODE_DISABLE disable the EP module Selection of any of the above modes enables the EPI module except for EPL MODE_DISABLE which should be used to disable the module Returns None 116 September 05 2012 8 2 2 16 8 2 2 17 External Peripheral Interface EP 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 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 a
164. Hard Fault and NMI fault handlers The MPU can be configured so that when in privileged mode and no re gions are enabled 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 in stead 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 func tion MPUIntRegister can be used to install the fault handler which is called whenever a memory protection violation occurs This function also enables the fault handler If compile time interrupt registration 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 M memory protection unit When the MPU is disabled the September 05 2012 Memory Protection Unit MPU default memory map is used and memory management faults are not generated
165. I interrupt handler can be registered by calling EPlIntRegister This function loads the interrupt handler s address into the vector table The handler can be removed with EPIIntUnregister 8 2 2 Function Documentation 8 2 2 1 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 This 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 EPl_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 EP l_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 EPl_ADDR_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 Retur
166. I2C2 SYSCTL_PERIPH_I2C5 SYSCTL_PERIPH_PECIO SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH_I2Co SYSCTL_PERIPH_I2C3 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_PWMO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI2 SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART4 SYSCTL_PERIPH_UART7 SYSCTL_PERIPH_WDOGO Note The ability to power off a peripheral varies based on the Stellaris part in use Please consult the data sheet for the part you are using to determine if this feature is available Returns None 24 2 2 33 SysCtlPeripheralPresent Determines if a peripheral is present Prototype tBoolean SysCtlPeripheralPresent unsigned long ulPeripheral Parameters ulPeripheral is the peripheral in question Description 366 This function determines if a particular peripheral is present in the device Each member of the Stellaris family has a different peripheral set this function determines which peripherals are present on this device The ulPeripheral ing values SYSCTL_PERIPH_CANO SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_EPIO one of the follow SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_FANO parameter must be only SYSCTL_
167. IG_ACCEL_SLOW or FAN_CONFIG_ACCEL_FAST September 05 2012 9 2 2 9 2 2 1 The Fan Controller Startup setting a FAN channel can be configured to start using the calculated value for the PWM duty cycle or by applying a fixed PWM duty cycle for a period of time in order to quickly bring the cooling fan up to speed It may also be useful to briefly apply a higher PWM value to a cooling fan intended to run at low speed in order to overcome static friction and get it started If an initial fixed PWM duty cycle is not needed to start the cooling fan then use the configu ration flag FAN_CONFIG_START_DUTY_OFF However if a fixed PWM duty cycle is needed to start the cooling fan then choose one of the flags FAN_CONFIG_START_DUTY_50 75 or _100 to use 50 75 or 100 duty cycle to start the cooling fan If a starting duty cy cle is used then the startup period must also be specified using FAN_CONFIG_START_2 FAN_CONFIG_START_4 etc This setting chooses the number of tachometer edges to de termine the amount of time that the starting duty cycle is applied Speed adjustment rate the rate at which the FAN makes changes can be adjusted using the flags FAN_CONFIG_HYST_1 FAN_CONFIG_HYST_2 etc This setting chooses the number of tachometer pulses to delay between speed changes Using a larger value can smooth out the changes of cooling fan speed Speed averaging the speed measurement can be averaged over several samples in order to smooth ou
168. IPH_I2C4 SYSCTL_PERIPH_LPCO SYSCTL_PERIPH_PWM1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI3 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMERS SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UART5 SYSCTL_PERIPH_UART6 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER2 parameter must be only SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOK SYSCTL_PERIPH_GPION SYSCTL_PERIPH_I2C2 SYSCTL_PERIPH_I2C5 SYSCTL_PERIPH_PECIO SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_HIBERNATE one of the follow SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH_12CO SYSCTL_PERIPH_12C3 SYSCTL_PERIPH_12S0 SYSCTL_PERIPH_PWMO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI2 SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART4 SYSCTL_PERIPH_UART 7 SYSCTL_PERIPH_WDOGO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER4 or SYSCTL_PERIPH_WTIMERS5 Note The ability to power off a peripheral varies based on the Stellaris part in use Please consult the data sheet for the part you are using to de
169. IPH_SSI he GPIO blocks and the SSI in sleep mode heralSleepEnable SYSCTL_PERIPH_GPIOA heralSleepEnable SYSCTL_PERIPH_GPIOB heralSleepEnable SYSCTL_PERIPH_SSI SYSCTL_USE_PLL SYSCTL_XTAL_4MHZ September 05 2012 25 25 1 25 2 25 2 1 25 2 2 25 2 2 1 System Exception Module System Exception Module POCUT aneia aa aaa a a DR adeeb hea D av PP iPM ROIS 6 tanec ee ec aah olen amen ete bs sunt ca aad oe ea beden nee e eal uesbeabin eet aches 377 Programming ERIN DIS eeo rea r a A EE E ERa 380 Introduction The system exception module driver provides methods for manipulating the behavior of the sys tem exception module that handles system level Cortex M4 FPU exceptions The exceptions are underflow overflow divide by zero invalid operation input denormal and inexact exception The application can optionally choose to enable one or more of these interrupts and use the interrupt handler to decide upon a course of action to be taken in each case All the interrupt events are ORed together before being sent to the interrupt controller so the System Exception module can only generate a single interrupt request to the controller at any given time This driver is contained in driverlib sysexc c with driverlib sysexc h containing the API definitions for use by applications API Functions Functions m void SysExclntClear unsigned long ullntFlags m void SysExclntDisable unsigned long ullntFlags
170. MA_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 application must set extra flags in the u Flags parameter The USB_EP_DMA_MODE_0 and USB_EP_DMA_MODE_1 parameters control the mode of the transaction USB_EP_AUTO_CLEAR allows the data to be received automatically without manually acknowledging that the data has been read If the transfer size is not known USB_EP_DMA_MODE_1 should be used as it does not generate an interrupt when each packet is sent over USB and interrupts if a short packet is received In USB_EP_DMA_MODE_1 the last short packet remains in the FIFO and must be read by software when the interrupt is received If the full transfer size is known USB_EP_DMA_MODE_0 can be used because it does not inter rupt the processor after each packet and completes even if the last packet is a short packet The USB_EP_AUTO_CLEAR flag should normally be specified when using uDMA to allow the USB controller to transfer multiple packets without interruption of the microcontroller The example be September 05 2012 461 USB Controller low configures endpoi
171. MPACT_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 because the interrupt vector was allocated at compile time the peripheral interrupt must be enabled on the master controller September 05 2012 Inter IC Sound 12S I2SIntEnable I2SO_BASE I2S_INT_TXERR I2S_INT_TXREQ IntEnable INT_I2S0 ih Finally the I2S transmitter must 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
172. 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 September 05 2012 277 Memory Protection Unit MPU 18 3 278 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_RGN_SIZE_32K MPU_RGN_PERM_EXEC MPU_RGN_PERM_PRV_RO_USR_RO MPU_SUB_RGN_DISABLE_2 MPU_RGN_ENABLE Note This function writes to multiple registers and is not protected from interrupts 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 handle this is to disable a region before changing it Refer to the discussion of this in the API Detailed Description section Returns None 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 1 MB of peripheral space for access only in privileged mode except for a 128 KB hole that is not acces
173. 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 September 05 2012 207 Inter Integrated Circuit 12C 14 2 2 11 l2CMasterInitExpClk Initializes the 12C Master block Prototype void T2CMasterInitExpClk unsigned long ulBase unsigned long ull2cCClk 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 Description This function initializes operation of the 12C Master block by configuring the bus speed for the master and enabling the I2C Master block If the parameter bFast is true then the master block is set up to transfer data at 400 Kbps otherwise it is set up to transfer data at 100 Kbps If Fast Mode Plus 1 Mbps is desired soft ware should manually write the I2CMTPR after calling this function For High Speed 3 4 Mbps mode a specific command is used to switch to the faster clocks after the initial communication with the slave is done at either 100 Kbps or 400 Kbps The peripheral clock is the same as the processor clock This value is returned by SysCtlClock Get 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 origina
174. O Haianelale idee ea Dou EUS 135 Progiaimimg Example nce ctauc icaediin othaenedusetacedsus deena eles cide bee he e eaea 143 10 1 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 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 on some older devices the flash controller must know the clock rate of the system in order to be able to time
175. OCKED if the fan is locked at the commanded speed FAN_STATUS_ NOATTAIN if the fan cannot achieve the commanded speed Returns Returns the status of the specified FAN channel September 05 2012 9 2 2 11 9 2 2 12 9 2 2 13 Fan Controller FanlntClear Clears pending FAN module interrupts Prototype void FanIntClear unsigned long ulBase unsigned long ulFlags Parameters ulBase is the base address of the FAN module ulFlags is the logical OR of all the interrupts to be cleared Description This function clears one or more interrupts from the FAN module The ulFlags parameter is the logical OR of all the possible interrupts that can be cleared For a list of possible interrupt flags refer to the documentation for the function FanlntEnable Returns None FanIntDisable Disables FAN module interrupts Prototype void FanIntDisable unsigned long ulBase unsigned long ulFlags Parameters ulBase is the base address of the FAN module ulFlags is the logical OR of all the interrupts to be disabled Description This function disables one or more interrupts from the FAN module The u Flags parameter is the logical OR of all the possible interrupts that can be enabled For a list of possible interrupt flags refer to the documentation for the function FanIntEnable Returns None FanIntEnable Enables FAN module interrupts Prototype void FanIntEnable unsigned long ul
176. OLimitSet Use the function I2STxDataPut to write data to the 12S transmit FIFO This function blocks 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 This function configures both the transmit and receive modules If the internal PLL is used then the master clock rate must be set using SysCtlI2SMClkSet Interrupts for the transmit and receive modules are configured together because there is one in terrupt for both Interrupts are enabled or disabled using 2SIntEnable 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 2SIntClear September 05 2012 15 2 2 15 2 2 1 15 2 2 2 Inter IC Sound 12
177. PERIPH_12C4 SYSCTL_PERIPH_LPCO SYSCTL_PERIPH_ PWM1 SYSCTL_PERIPH_SSIO September 05 2012 SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOK SYSCTL_PERIPH_GPION SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH _12C2 SYSCTL_PERIPH_12C5 SYSCTL_PERIPH_PECIO SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH _12C0 SYSCTL_PERIPH _12C3 SYSCTL_PERIPH _12S0 SYSCTL_PERIPH_PWMO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI2 369 System Control SYSCTL_PERIPH_SSI3 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMERS SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UART5 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_UARTE SYSCTL_PERIPH_USBO SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART4 SYSCTL_PERIPH_UART7 SYSCTL_PERIPH_WDOGO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER2 SYSCTL_PERIPH_WTIMER4 Returns None 24 2 2 37 SysCtlPeripheralSleepEnable Enables a peripheral in sleep mode Prototype void SysCtlPeripheralsSl p or SYSCTL_PERIPH_WTIMERS5 Enable unsigned long ulPeripheral Parameters ulPeripheral is the peripheral t Description o enable in sleep mode This functio
178. PERIPH_ADCO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_ETH September 05 2012 SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOK SYSCTL_PERIPH_GPION SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2C2 SYSCTL_PERIPH_I2C5 SYSCTL_PERIPH_LPCO SYSCTL_PERIPH_PLL SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TEMP SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMERS SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UARTS5 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH_I2Co SYSCTL_PERIPH_I2C3 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_MPU SYSCTL_PERIPH_PWMO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI2 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_UARTE6 SYSCTL_PERIPH_USBO System Control SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOu SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPIOQ SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2C4 SYSCTL_PERIPH_IEEE1588 SYSCTL_PERIPH_PECIO SYSCTL_PERIPH_PWM1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSIS SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART4 SYSCTL_PERIPH_UART7 SYSCTL_PERIPH_WDOGO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER4 or SYSCTL_PERIPH_WTIMERS SYSCTL_PERIPH_WTIMER2 Retu
179. PERIPH_TIMERS SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UART5 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_I2C2 SYSCTL_PERIPH_I2C5 SYSCTL_PERIPH_PECIO SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_UARTE6 SYSCTL_PERIPH_USBO SYSCTL_PERIPH_I2C3 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_PWMO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSI2 SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART4 SYSCTL_PERIPH_UART7 SYSCTL_PERIPH_WDOGO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER4 or SYSCTL_PERIPH_WTIMERS5 SYSCTL_PERIPH_WTIMER2 Note The ability to check for a peripheral being ready varies based on the Stellaris part in use Please consult the data sheet for the part you are using to determine if this feature is available Returns Returns true if the specified peripheral is ready and false if it is not 24 2 2 35 SysCtlPeripheralReset Performs a software reset of a peripheral Prototype void SysCtlPeripheralReset unsigned long ulPeripheral Parameters ulPeripheral is the peripheral to reset Description This function performs a software reset of the specified peripheral An individual peripheral reset signal is asserted for a brief period and then de asserted returning the internal state of the peripheral to its reset con
180. 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 function sets and enables the handler to be called when the 12S controller generates an interrupt 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 September 05 2012 15 2 2 5 15 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 interrupt 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 disables and clears the handler to be called when the 12S
181. 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 if HibernateRequest Need a loop here to wait for the power to be removed Power is removed while executing in this loop for 77 The following example shows how to use the Hibernation module RTC to generate an interrupt at a certain time Handler for hibernate interrupts 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 September 05 2012 199 Hibernation Module Enable the Hibernation module SysCtlPeripheralEnable SYSCTL_PERIPH_HIBERNATE HibernateEnableExpClk SysCt1lClockGet Wait an amount of time for the module to power up Le 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 Set the RTC to an i
182. 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 September 05 2012 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 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 September 05 2012 53 Controller Area Network CAN 5 2 3 24 5 2 3 25 5 2 3 26 5 2 3 27 5 2 3 28 54 MSG
183. R_INT_DATA Data interrupt Note Not all Stellaris devices support all of the listed interrupt sources Please consult the device data sheet to determine if these features are supported Returns None 14 2 2 18 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 masked interrupt status is requested Description This function 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 September 05 2012 211 Inter Integrated Circuit 12C 14 2 2 19 l2CMasterlntStatusEx Gets the current 12C Master interrupt status Prototype unsigned long I2CMasterIntStatusEx 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 masked interrupt status is requested Description This function 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 ret
184. Register Registers an interrupt handler for the CAN controller Prototype void CANIntRegister unsigned long ulBase void x 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 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 See also IntRegister for important information about registering interrupt handlers Returns None September 05 2012 61 Controller Area Network CAN 5 2 5 12 5 2 5 13 62 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 elntSitsReg indicates which interrupt status register to read Description This function returns the value of one of two interrupt status registers The interrupt status register
185. Returns None 28 2 2 17 UARTDisableSIR Disables SIR IrDA mode on the specified UART Prototype void UARTDisableSIR unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function clears the SIREN IrDA and SIRLP Low Power bits This function only has an effect if the UART has not been enabled by a call to UARTEnable The call UARTEnableSIR must be made before a call to UARTConfigSetExpClk because the UART ConfigSetExpClk function calls the UARTEnable function Another option is to call UARTDisable followed by UARTEnableSIR and then enable the UART by calling UARTEnable Note The availability of SIR IrDA operation 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 28 2 2 18 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 function 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 September 05 2012 419 UART m UART_DMA_TX disable DMA for tra
186. S 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 also enables 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 12S module base address ullntFlags is a bit mask of the interrupt sources to be cleared Description This function clears the specified pending I2S interrupts This function must be called in the interrupt handler to keep the interrupt from being triggered again immediately upon exit The ullntFlags 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 M 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 i
187. ST 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 September 05 2012 Inter IC Sound 12S 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 15 2 2 9 l2SRxDataGet Reads data samples from the I2S 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 28 _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
188. SYSCTL_INT_PLL_FAIL 354 September 05 2012 System Control Description The specified system control interrupt sources are cleared so that they no longer assert This function must be called in the interrupt handler to keep it from being called again immediately upon exit Note Because there is a write buffer in the Cortex M 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 The interrupt sources vary based on the Stellaris part in use Please consult the data sheet for the part you are using to determine which interrupt sources are available Returns None 24 2 2 15 SysCtllntDisable Disables individual system control interrupt sources Prototype void SysCtlIntDisable unsigned long ulInts 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 This function disables the indicated system control inte
189. SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP0O SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_EEPROMO SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_ETH SYSCTL_PERIPH_FANO 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_GPIOK SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPION SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH_GPIOQ SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2CO SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2C2 SYSCTL_PERIPH_I2C3 SYSCTL_PERIPH_I2C4 SYSCTL_PERIPH_I2C5 SYSCTL_PERIPH_I2S0 SYSCTL_PERIPH_LPCO SYSCTL_PERIPH_PECIO SYSCTL_PERIPH_PWMO SYSCTL_PERIPH_PWM1 SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_QEI1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_SSI2 SYSCTL_PERIPH_SSIS SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER1 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_TIMER4 SYSCTL_PERIPH_TIMERS SYSCTL_PERIPH_UARTO SYSCTL_PERIPH_UART1 SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UARTS SYSCTL_PERIPH_UART4 SYSCTL_PERIPH_UART5 SYSCTL_PERIPH_UARTE6 SYSCTL_PERIPH_UART7 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER2 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER4 or SYSCTL_PERIPH_WTIMERS5 Returns None 24 2 2 30 SysCtlPeripheralEnable Enables a peripheral Prototype void
190. SYSCTL_PERIPH_GPIOJ Returns None 24 2 2 13 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 value is zero the value is computed from the current PLL configuration ulMCIk is the desired MCLK frequency If this value is zero MCLK output is disabled Description This function configures the dividers to provide MCLK to the 12S module A MCLK divider is chosen 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 is returned It is the responsibility of the application to determine 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 although there is a very small percentage of the population that can discern lower frequency deviations Returns Returns the actual MCLK frequency 24 2 2 14 SysCtllntClear Clears system control interrupt sources Prototype void SysCtlIntClear unsigned long ulInts Parameters 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 SYSCTL_INT_MOSC FAIL SYSCTL_INT_POR SYSCTL_INT_BOR and or
191. Stellaris Peripheral Driver Library USER S GUIDE I TEXAS INSTRUMENTS SW DRL UG 9453 Copyright 2006 2012 Texas Instruments Incorporated Copyright Copyright 2006 2012 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 9453 of this document last updated on September 05 2012 2 September 05 2012 Table of Contents Copynght i s 6 c040805 5 beat ee be wwe ee eee aa Revision Information 0 20002 ee eee eee 1 Hirodu uchon lt s eee we e Sh ecm a ee ay 2 Programming Model 22 eee eee eee 21 lntroduetom oa asda ee aa a a a e a a a 2 2 Direct Register Access Model 2 3 Software Driver Model anaa aaa ee eee 2 4 Combining The Models naaa aaa a 3 Analog Comparator
192. T Start condition detected interrupt m 12C_SLAVE_INT_DATA Data interrupt Note Not all Stellaris devices support the all of the listed interrupts Please consult the device data sheet to determine if these features are supported Returns None 14 2 2 37 2CSlavelntStatus Gets the current 12C Slave interrupt status September 05 2012 219 Inter Integrated Circuit 12C 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 function 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 14 2 2 38 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 I2C Slave module bMasked is false if the raw interrupt status is requested and true if the masked interrupt status is requested Description This function returns the interrupt status for the 12C Slave module Either the raw interrupt status or the status of interrupts that are allowed t
193. TCharPutNonBlocking UARTCharGet and UARTCharGetNonBlocking are used to send and receive data characters in 9 bit mode Note The availability of 9 bit 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 UART9QBitAddrSet Sets the device address es for 9 bit mode Prototype void UART9BitAddrSet unsigned long ulBase unsigned char ucAddr unsigned char ucMask Parameters ulBase is the base address of the UART port ucAddr is the device address ucMask is the device address mask Description This function configures the device address or range of device addresses that respond to requests on the 9 bit UART port The received address is masked with the mask and then compared against the given address allowing either a single address if ucMask is Oxff or a set of addresses to be matched Note The availability of 9 bit 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 UART9BitDisable Disables 9 bit mode on the specified UART Prototype void UART9BitDisable unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function disables the 9 bit operational mode of the UART September 05 2012 28 2 2 4 28 2 2 UART Note The a
194. TER_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 lI2C_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 occurs when the master is no longer busy Slave Operations When using this API to drive the 12C slave module the user must first initialize the 12C slave module with a call to 12CSlavelnit This function enables the I2C slave module and initializes the slave s own address After the initialization is complete the user may poll the slave status using 2CSlaveStatus to determine if a master requested a send or receive operation Depending on the type of operation requested the user can call I2CSlaveDataPut or I2CSlaveDataGet to complete the transaction Alternatively the I2C slave can handle transactions using an interrupt handler registered with 2CIntRegister 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 2CMasterBusBu
195. THER uDMATaskStructEntry Task2Count Saas E Returns Nothing this is not a function 29 2 3 Function Documentation 29 2 3 1 uDMAChannelAssign Assigns a peripheral mapping for a UDMA channel September 05 2012 uDMA Controller Prototype void uDMAChannelAssign unsigned long ulMapping Parameters ulMapping is a macro specifying the peripheral assignment for a channel Description This function assigns a peripheral mapping to a UDMA channel It is used to select which peripheral is used for a uDMA channel The parameter u Mapping should be one of the macros named UDMA_CHn_tttt from the header file udma h For example to assign UDMA channel 0 to the UART2 RX channel the parameter should be the macro UDMA_CHO_UART2RxX Please consult the Stellaris data sheet for a table showing all the possible peripheral assign ments for the UDMA channels for a particular device Note This function is only available on devices that have the DMA Channel Map Select registers DMACHMAP0 3 Please consult the data sheet for your part Returns None 29 2 3 2 uDMAChannelAttributeDisable Disables attributes of a UDMA channel Prototype void uDMAChannelAttributeDisable unsigned long ulChannelNum unsigned long ulAttr Parameters ulChannelNum is the channel to configure ulAtir is a combination of attributes for the channel Description This function is used to disable attributes of a UDMA chan
196. TS 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 IS07816 smart card 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 28 2 2 37 UARTModemStatusGet Gets the states of the RI DCD DSR and CTS modem status signals Prototype unsigned long UARTModemStatusGet unsigned long ulBase 428 September 05 2012 UART Parameters ulBase is the base address of the UART port Description This function returns the current states of each of the four UART modem status signals Rl 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 value is a 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 28 2 2 38 UARTParityModeGet Gets the type of parity currently being used Prototype unsigned long UARTParityModeGet unsigned long ulBase Parameters ulBase is the base
197. 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 September 05 2012 27 Analog to Digital Converter ADC 4 2 2 5 4 2 2 6 4 2 2 1 28 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 function returns the digital comparator interrupt status bits This status is sequence ag nostic 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 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 digit
198. This function should only be called in host mode Returns None 30 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 September 05 2012 481 USB Controller Description This function sets 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 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 USB_EP_MODE CTRL is a control endpoint USB_EP_MODE_ISOC is an isochronous endpoint
199. UDMADisable Once the uDMA controller is enabled you must tell it where to find the channel control structures in system memory by using the function UDMAConirolBaseSet 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 allocate the control structure 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 aligned 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 configured with the function uDMAChannelAttributeEnable and cleared with uUDMAChannelAttributeDisable The setting of the channel attribute flags can be queried using the function UDMAChannelAttributeGet Next the control parameters of the DMA transfer must be configured These parameters control the size and address increment of the data items to be transferred The function uUDMAChannel ControlSet 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 channel and transfer In order to configure the transfer addresses transfer size and transfe
200. US errors caused by devices with high in rush cur rent 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 486 September 05 2012 USB Controller 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 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 30 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 USBnEPEN signal which disables an external power supply in host mode operation Note This function should only be called in host mode Returns None 30 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 USBnEPEN signal which enables an external power supply in host mode operation Note This function should only be called in host mode September 05 2012 487 USB Controller Returns None 30 3 2 38
201. 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 30 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 USBnPFLT pin is not in use this function should not be used Note This function should only be called in host mode Returns None 30 3 2 40 USBHostRequestIN Schedules a request for an IN transaction on an endpoint in host mode 488 September 05 2012 30 3 2 41 USB Controller Prototype void USBHostRequestIN unsigned long ulBase unsigned long ulEndpoint Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access Description This function schedules a request for an IN transaction When the USB device being communi cated with responds with the data the data can be retrieved by calling USBEndpointDataGet or via a DMA transfer Note This function should only be called in host mode and only for IN endpoints Returns None USBHostRequ
202. VerificationSet tBoolean bEnable September 05 2012 24 2 1 System Control void SysCtILDOConfigSet unsigned long ulConfig unsigned long SysCtILDOGet void void SysCtILDOSet unsigned long ulVoltage void SysCtIMOSCConfigSet unsigned long ulConfig void SysCtIMOSCVerificationSet tBoolean bEnable void SysCtlPeripheralClockGating tBoolean bEnable void SysCtlPeripheralDeepSleepDisable unsigned long ulPeripheral void SysCtlPeripheralDeepSleepEnable unsigned long ulPeripheral void SysCtlPeripheralDisable unsigned long ulPeripheral void SysCtlPeripheralEnable unsigned long ulPeripheral void SysCtlPeripheralPowerOff unsigned long ulPeripheral void SysCtlPeripheralPowerOn unsigned long ulPeripheral tBoolean SysCtlPeripheralPresent unsigned long ulPeripheral tBoolean SysCilPeripheralReady unsigned long ulPeripheral void SysCtlPeripheralReset unsigned long ulPeripheral void SysCtlPeripheralSleepDisable unsigned long ulPeripheral void SysCtlPeripheralSleepEnable unsigned long ulPeripheral tBoolean SysCilPinPresent unsigned long ulPin unsigned long SysCtIPIOSCCalibrate unsigned long ulType 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
203. 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 September 05 2012 8 2 2 5 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_CSCFG_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 b
204. ZE_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 function sets the clock divider s that is 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 on 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 yields 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 unsign
205. _BASE 0 Select SDRAM mode EP IModeSet EPIO_BASE EPI_MODE_SDRAM Configure SDRAM mode EPIConfigSDRAMSet EPIO_BASE EPI_SDRAM_CORE_FREQ_50_100 EPI_SDRAM_FULL_POWER EPI_SDRAM_SIZE_64MBIT 1024 Set the address map EPITAddressMapSet EPIO_BASE EPI_ADDR_RAM_SIZE_256MB EPI_ADDR_RAM_BASE_6 Wait for the EPI initialization to complete ff while HWREG EPIO_BASE EPI_O_STAT amp EPI_STAT_INITSEQ Wait for SDRAM initialization to complete At this point the SDRAM is accessible and available for use September 05 2012 121 External Peripheral Interface EP 122 September 05 2012 9 9 1 9 2 Fan Controller Fan Controller OUT aneia aa aa aa inhibited ding Ded adn abide hee dauiben Sad Meee 123 APOPO HONS 6 tancaee ec aah owner cai eca ees bo sane ca ees ea baten nee en lees beaee tore 123 Pregrammmg REIN DIE ccc sannrenaeceiapisdw edd cameagemerentbagenecEsepesarsouqueneckeabedeereesmaadas 133 Introduction The fan controller API provides functions to the use the fan controller peripheral available in the Stellaris microcontroller The fan controller provides multiple channels of fan PWM control Features include automatic or manual speed control filtering of speed readings to smooth fluctuations m speed reading in RPM stall detection m auto restart on stall fast start to bring fan up to speed quickly m interrup
206. _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 _I2SOTX for 12S transmit UDMA_CHANNEL_ SW for the software dedicated uUDMA channel Some Stellaris parts also provide a secondary channel mapping For those parts each channel has a secondary peripheral mapping allowing 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 select 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 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_UART2RX 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 Stella
207. _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 message identifier filtering based on the extended identifier If the extended identifier filtering is used then ID filtering must also be enabled September 05 2012 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 obj
208. a FAN channel when in automatic mode Prototype void FanChannelRPMSet unsigned long ulBase unsigned long ulChannel unsigned long ulRPM Parameters ulBase is the base address of the FAN module ulChannel is the FAN channel to program the RPM ulIRPM is the RPM as a value from 0 8191 Description This function sets the RPM of the fan channel if the fan channel is configured for automatic mode If configured for manual mode then this function has no effect September 05 2012 129 Fan Controller 9 2 2 9 9 2 2 10 130 Returns None FanChannelsGet Gets the number of supported FAN channels Prototype unsigned long FanChannelsGet unsigned long ulBase Parameters ulBase is the base address of the FAN module Description This function gets the number of FAN channels that are supported by the Fan Control periph eral Returns Returns the number of FAN channels FanChannelStatus Gets the status of a FAN channel Prototype unsigned long FanChannelStatus unsigned long ulBase unsigned long ulChannel Parameters ulBase is the base address of the FAN module ulChannel is the FAN channel to query for status Description This function queries and returns the status of the specified channel The returned value is one of FAN_STATUS_ STALLED if the cooling fan is stalled FAN_STATUS_ CHANGING if the fan is changing to the commanded speed FAN_STATUS_L
209. a pulse on the SClIn signal Prototype void LPCSCIAssert unsigned long ulBase unsigned long ulCount Parameters ulBase is the base address of the LPC module ulCount is the number used to generate the pulse width value Description This function generates a pulse on the SCln interrupt pin The width of the pulse is 2 lt lt ulCount LPC Clock Periods where u Count can take on the value of 0 1 2 or 3 So the pulse width is 2 4 8 or 16 clock periods Returns None 17 2 1 35 LPCStatusBlockAddressGet Gets the Status Block Address for the LPC peripheral Prototype unsigned LPCStatusBlockAddressGet unsigned long ulBase Parameters ulBase is the base address of the LPC module September 05 2012 267 Low Pin Count Interface LPC Description This function returns the LPC block address register The LSB is used to indicate whether this feature has been enabled or not Returns None 17 2 1 36 LPCStatusBlockAddressSet Sets the Status Block Address for the LPC peripheral Prototype void LPCStatusBlockAddressSet unsigned long ulBase unsigned long ulAddress tBoolean bEnabled Parameters ulBase is the base address of the LPC module ulAddress is the host address to use for the block status bEnabled indicates whether the block address feature should be enabled Description This function sets the LPC block address register and optionally enables it Returns None 17 2 1 37
210. able unsigned long ulBase Parameters ulBase is the 2S module base address September 05 2012 237 Inter IC Sound 12S 15 3 238 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 are generated on the 12S 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 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 because 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 is 16 but 32 bits are on the wire This I2S TX is the clock master and transmits zeroes if the FIFO is empty I2STxConfigSet I2SO_BASE I2S_CONFIG_FORMAT_I2S I2S_CONFIG_MODE_CO
211. ach 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 Up to four generator blocks each containing e One 16 bit down or up down counter e Two comparators e PWM generator Dead band generator m 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 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 September 05 2012 301 Pulse Width Modulator PWM 21 2 1 302 void PWMGenEnable unsigned long ulBase unsigned long ulGen void PWMGenFaultClear unsigned long ulBase unsigned long ulGen unsigned long ulGroup
212. actor void ADCSoftwareOversampleDataGet unsigned long ulBase unsigned long ulSequen ceNum unsigned long xpulBuffer unsigned long ulCount void ADCSoftwareOversampleStepConfigure unsigned long ulBase unsigned long ulSe quenceNum unsigned long ulStep unsigned long ulConfig September 05 2012 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 sequencers those that deal with the processor trigger and those that deal with interrupt handling The sample sequencers 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 sequencer FIFO overflow and underflow is managed with ADCSequenceOverflow ADCSequenceOverflowClear ADCSequenceUnderflow and ADCSequenceUnderflowClear Hardware oversampling of the ADC is controlled with ADCHardwareOversampleConfigure Soft ware oversampling of the ADC is controlled with ADCSoftwareOversampleConfigure ADCSoft wareOversampleStepConfigure and ADCSoftwareOversampleDataGet The processor trigger is generated with ADCProcessorTrigger The interrupt handler for the ADC sample sequencer interrupts are managed with ADCIntRegister and ADCIntUnregister The sample sequencer i
213. 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 28 2 2 39 UARTParityModeSet Sets the type of parity Prototype 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 September 05 2012 429 UART Description This function configures the type of parity to use for transmitting and expect when receiving The ulParity 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 parameters allow direct control of the parity bit it is always either one or zero based on the mode Returns None 28 2 2 40 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 s
214. aging the UART interrupts is handled by the UARTIntClear UARTIntDisable UARTIntEn able UARTIntRegister UARTIntStatus and UARTIntUnregister functions The 9 bit operation mode is handled by the UART9BitEnable UART9BitDisable UART9BitAddrSet and UART9BitAddrSend 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 UART9BitAddrSend Sends an address character from the specified port when operating in 9 bit mode Prototype void UART9BitAddrSend unsigned long ulBase unsigned char ucAddr Parameters ulBase is the base address of the UART port ucAdadr is the address to be transmitted Description This function waits until all data has been sent from the specified port and then sends the given address as an address byte It then waits until the address byte has been transmitted before returning September 05 2012 411 UART 28 2 2 2 28 2 2 3 412 The normal data functions UARTCharPut UAR
215. al comparator operation is based on three ADC value regions 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 September 05 2012 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 allows 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 oversampling 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 oversampl
216. alfPrecisionModeSet unsigned long ulMode void FPULazyStackingEnable void void FRUNaNModeSet unsigned long ulMode void FPURoundingModeSet unsigned long ulMode void FPUStackingDisable void void FPUStackingEnable void Detailed Description The FPU API provides functions for enabling and disabling the floating point unit FPUEnable and FPUDisable for controlling how the floating point state is stored on the stack when interrupts occur FPUStackingEnable FPULazyStackingEnable and FPUStackingDisable for han dling the floating point interrupt FPUIntRegister FPUIntUnregister FPUIntEnable FPUIntDis able FPUIntStatus and FPUIntClear and for adjusting the operation of the floating point unit FPUHalfPrecisionModeSet FRUNaNModeSet FPUFlushToZeroModeSet and FPURound ingModeSet Function Documentation FPUDisable Disables the floating point unit Prototype void FPUDisable void Description This function disables the floating point unit preventing floating point instructions from execut ing generating a NOCP usage fault instead Returns None FPUEnable Enables the floating point unit September 05 2012 11 2 2 3 11 2 2 4 Floating Point Unit FPU Prototype void FPUEnable void Description This function enables the floating point unit allowing the floating point instructions to be exe cuted This function must be called prior to performing any ha
217. alid interrupt was specified IntPriorityGroupingGet Gets the priority grouping of the interrupt controller Prototype unsigned long IntPriorityGroupingGet void Description This function returns the split between preemptable priority levels and sub priority levels in the interrupt priority specification Returns The number of bits of preemptable priority 16 2 2 10 IntPriorityGroupingSet 246 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 sub priority 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 September 05 2012 Interrupt Controller NVIC 16 2 2 11 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 the priority level such that all interrupts of that and lesser priority are masked A value of 0 means that priority masking is disabled Sma
218. ame type trigger another interrupt Returns None 28 2 2 41 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 previous call to UARTCharGet or UARTCharGetNonBlocking with the exception that the overrun error is set immediately when 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 430 September 05 2012 UART 28 2 2 42 UARTSmartCardDisable Disables ISO7816 smart card mode on the specified UART Prototype void UARTSmartCardDisable unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function clears the SMART 1SO7816 smart card bit in the UART control register Note The availability of IS07816 smart card 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 28 2 2 43 UARTSmartCardEnable Enables 1507816 smart card mode on the specified UART Prototype void UARTSmartCardEnable unsigned
219. ample 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 is identified by SSI_CRO_SCR In the case where the bit field is a single bit there is nothing further for example SSI_CRO_SPH is a single bit in the CRO register If the bit field is more than a single bit there is 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 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
220. an 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 the 12C Master is busy otherwise returns false I2CMasterControl 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 September 05 2012 205 Inter Integrated Circuit 12C 14 2 2 6 14 2 2 7 206 12 _MASTER_CMD_SINGLE_SEND 12 _MASTER_CMD_SINGLE_RECEIVE 12 _MASTER_CMD_BURST_SEND_ START 12 _MASTER_CMD_BURST_SEND CONT 12 _MASTER_CMD_BURST_SEND FINISH 12C_MASTER_CMD_BURST_SEND ERROR STOP 12C_MASTER_CMD_BURST_RECEIVE_START 12 _MASTER_CMD_BURST_RECEIVE_CONT 12C_MASTER_CMD_BURST_RECEIVE_FINISH 12C_MASTER_CMD_BURST_RECEIVE_ERROR_STOP 12C_MASTER_CMD_QUICK_COMMAND 12C_MASTER_CMD_HS MASTER_CODE_SEND Returns None 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
221. an error but instead just returns a zero in the pulSize parameter The only error case occurs when there is no data packet available Returns This call returns 0 or 1 if no packet was received 30 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 pucData 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 puts the data from the pucData parameter into the FIFO for this endpoint If a packet is already pending for transmission then this call does not put any of the data into the FIFO and returns 1 Care should be taken to not write more data than can fit into the FIFO allocated by the call to USBFIFOConfigSet Returns This call returns 0 on success or 1 to indicate that the FIFO is in use and cannot be written 30 3 2 15 USBEndpointDataSend Starts the transfer of data from an endpoint s FIFO Prototype long USBEndpointDataSend unsigned long ulBase September 05 2012 473 USB Controller unsigned long ulEndpoint unsigned long ulTransType Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint t
222. an execute only block It can also generate an interrupt when a program or erase operation has completed The interrupt is 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 September 05 2012 Flash Description This function 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 can be returned Returns The current interrupt status enumerated as a bit field of FLASH_INT_ PROGRAM and FLASH_INT_ACCESS 10 2 2 7 FlashIntUnregister Unregisters the interrupt handler for the flash interrupt Prototype void FlashIntUnregister void Description This function clears the handler to be called when the flash interrupt occurs This function also masks 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 10 2 2 8 FlashProgram Programs flash Prototype long FlashProgram unsigned long xpulData unsigned long ulAddress unsigned
223. annel assignments For those parts us the uUDMAChannelAssign function to configure the channel assignments Define Documentation uDMATaskStructEntry A helper macro for building scatter gather task table entries Definition define uDMATaskStructEntry ulTransferCount lItemSize 1SrcIncrement vSrcAddr 1DstIncrement vDstAddr lArbSize 1Mode ec G OGO a G 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 data ulArbSize is the arbitration size to use for the transfer task September 05 2012 441 uDMA Controller ulMode is the transfer mode for this task Description 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 The ulTransferCount parameter is the number of items that will be transferred by this task It must be in the range 1 1024 The ulltemSiz
224. arameter specifies the LDO voltage and must be one of the following values 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_55vV SYSCTL_LDO_2_ 60V SYSCTL_LDO_2_65V SYSCTL_LDO_2 70V or SYSCTL_LDO_2_75V Note The default LDO voltage and the adjustment range varies with the Stellaris part in use Please consult the data sheet for the part you are using to determine the default voltage and range available Returns None 24 2 2 24 SysCtIMOSCConfigSet Sets the configuration of the main oscillator MOSC control Prototype void SysCt1lMOSCConfigSet unsigned long ulConfig Parameters ulConfig is the required configuration of the MOSC control Description This function configures the control of the main oscillator The u Config is specified as follows SYSCTL_MOSC_VALIDATE enables the MOSC verification circuit that detects a failure of the main oscillator such as a loss of the clock m SYSCTL_MOSC_INTERRUPT indicates that a MOSC failure should generate an interrupt instead of resetting the processor m SYSCTL_MOSC_NO_XTAL indicates that there is no crystal connected to the OSCO0 OSC1 pins allowing power consumption to be reduced Note The availability of MOSC control varies based on the Stellaris part in use Please consult the data sheet for the part you are using to determine whether this support is available In addition the capability o
225. arameters 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 causes the start of a reset condition on the USB bus The caller must then delay at least 20ms before calling this function again with the bStart parameter set to false Note This function must only be called in host mode Returns None 30 3 2 44 USBHostResume Handles the USB bus resume condition Prototype void USBHostResume unsigned long ulBase tBoolean bStart Parameters ulBase specifies the USB module base address bStart specifies if the USB controller is entering or leaving the resume signaling state 490 September 05 2012 USB Controller Description When in device mode this function brings the USB controller out of the suspend state This call must first be made with the bStart parameter set to true to start resume signaling The device application must 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 signals devices to leave the suspend state This call must first be made with the bStart parameter set to true to start resume signaling The host application must then delay at least 20ms before calling this function with the bStart parameter set to false This action causes the controll
226. arity 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 m UART_INT_DSR DSR interrupt UART_INT_DCD DCD interrupt UART_INT_CTS CTS interrupt UART_INT_RI RI interrupt Returns None 28 2 2 31 UARTIntRegister Registers an interrupt handler for a UART interrupt September 05 2012 425 UART Prototype void UARTIntRegister unsigned long ulBase void 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 function enables the global interrupt in the interrupt controller specific UART interrupts must be enabled via UART IntEnable It is the interrupt handler s responsibility to clear the interrupt source See also IntRegister for important information about registering interrupt handlers Returns None 28 2 2 32 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 function returns the interrupt status for the spec
227. ase address of the I2C Slave module ullntFlags is the bit mask of the interrupt sources to be disabled Description This function 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 The ullntFlags parameter has the same definition as the ullntFlags parameter to I2CSlavelntEnableEx Returns None September 05 2012 Inter Integrated Circuit I2C 14 2 2 35 2CSlavelntEnable Enables the I2C Slave interrupt Prototype void I2CSlaveIntEnable unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description This function enables the 12C Slave interrupt source Returns None 14 2 2 36 2CSlavelntEnableEx Enables individual I2C Slave interrupt sources Prototype void I2CSlaveIntEnableEx 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 This function 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_STAR
228. ata sheet for the Stellaris device that you are using to determine if this feature is available Returns Returns the value of the match register 13 2 2 28 HibernateRTCMatch1Set Sets the value of the RTC match 1 register Prototype void HibernateRTCMatch1Set unsigned long ulMatch Parameters ulMatch is the value for the match register Description This function 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 Note The Hibernation RTC Match 1 feature is not available on all Stellaris devices Please consult the data sheet for the Stellaris device that you are using to determine if this feature is available September 05 2012 193 Hibernation Module Returns None 13 2 2 29 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 This function sets the value of the RTC The RTC count seconds if the hardware is config ured correctly The RTC must be enabled by calling HibernateRTCEnable before calling this function Returns None 13 2 2 30 HibernateRTCSSGet Returns the current value of the RTC sub second count Prototype unsigned long HibernateRTCSSGet void Description This function returns the
229. 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 12 _MASTER_CMD_BURST_SEND_ START 12C_MASTER_CMD_BURST_RECEIVE_START Any of those commands results 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 September 05 2012 201 Inter Integrated Circuit 12C 14 1 2 14 2 202 For the single send and receive cases the polling method involves 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 I2CMasterErr If there are no errors then the data has been sent or is ready to be read using 2CMasterDataGet 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_MAS
230. ave Returns None 14 2 2 22 2CMasterTimeoutSet Sets the Master clock timeout value Prototype void I2CMasterTimeoutSet unsigned long ulBase unsigned long ulValue Parameters ulBase is the base address of the I2C Master module ulValue is the number of I2C clocks before the timeout is asserted Description This function enables and configures the clock low timeout feature in the 12C peripheral This feature is implemented as a 12 bit counter with the upper 8 bits being programmable For example to program a timeout of 20ms with a 100kKHz SCL frequency u Value would be 0x7d Note Not all Stellaris devices support this function Please consult the device data sheet to deter mine if this feature is supported Returns None 14 2 2 23 2CSlaveACKOverride Configures ACK override behavior of the 12C Slave Prototype void T2CSlaveACKOverride unsigned long ulBase tBoolean bEnable September 05 2012 213 Inter Integrated Circuit 12C Parameters ulBase is the base address of the I2C Slave module bEnable enables or disables ACK override Description This function enables or disables ACK override allowing the user application to drive the value on SDA during the ACK cycle Note Not all Stellaris devices support this function Please consult the device data sheet to deter mine if this feature is supported Returns None 14 2 2 24 2CSlaveACKValueSet Writes the ACK value Pro
231. bit 0 of the byte represents GPIO port pin 0 bit 1 represents GPIO port pin 1 and so on Note This function cannot be used to turn any pin into a timer pin it only configures a timer pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 37 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 function cannot be used to turn any pin into a UART pin it only configures a UART pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None September 05 2012 173 GPIO 12 2 2 38 GPIOPinTypeUSBAnalog Configures pin s for use by the USB peripheral Prototype void GPIOPinTypeUSBAnalo
232. ble identifier based filtering Set pMsgObject gt ulMsgLen to the number of bytes in the expected data frame The buffer pointed to by pMsgObject gt pucMsgDaita is not used by this call as no data is present at the time of the call Call this function with u ObjID set to one of the 32 object buffers If you specify a message object buffer that already contains a message definition it is overwrit ten Returns None 5 2 5 17 CANRetryGet Returns the current setting for automatic retransmission September 05 2012 65 Controller Area Network CAN 5 2 5 18 5 2 5 19 66 Prototype tBoolean CANRetryGet unsigned long ulBase Parameters ulBase is the base address of the CAN controller Description This function reads the current setting for 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 Parameters ulBase is the base address of the CAN controller bAutoRetry enables automatic retransmission Description This function 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
233. ble in the receive FIFO including the current packet being read and false otherwise EthernetPacketGet 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 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 pucBurf The function waits until a packet is available in the FIFO Then the function reads the entire packet from the receive FIFO If there are more bytes in the packet than can fit into pucBuf as specified by BufLen the function returns the negated length of the packet and the buffer contains BufLen bytes of the packet Otherwise the function returns the length of the packet that was read and pucBuf contains the entire packet excluding the frame check sequence bytes September 05 2012 7 2 2 16 7 2 2 17 Ethernet Controller Note This function is blocking and does 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 Prototype long EthernetPacketGetNonBlocking unsigned long ulBase unsigned char
234. cannot be used to turn any pin into a PWM pin it only configures a PWM pin for proper operation Devices wtih flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 34 GPIOPinTypeQEl Configures pin s for use by the QEI peripheral 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 September 05 2012 171 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 function cannot be used to turn any pin into a QEI pin it only configures a QEI pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 35 GPIOPinTypeSSI 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
235. cation 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 FlashErase 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 calls 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 because it is the application s responsibility to deal with error conditions By setting a breakpoint on the __error___ function the debugger immediately stops 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 pinpoint the function that found an error what it fo
236. cessor When the interrupt occurs if it is enabled via IntEnable the handler function is called in interrupt context Because 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 the NVIC does 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 September 05 2012 Interrupt Controller NVIC Returns None 16 2 2 15 IntUnregister 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 interrupt is asserted to the processor The interrupt source is automatically disabled via IntDisable if necessary See also IntRegister for importan
237. cessor clock rate September 05 2012 349 System Control Prototype unsigned long SysCt1lClockGet void Description This function determines the clock rate of the processor clock which is also the clock rate of the peripheral modules with the exception of PWM which has its own clock divider other peripherals may have different clocking see the device data sheet for details Note This cannot return accurate results if SysCtIClockSet 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 latter case this function should be modified to directly return the correct system clock rate Returns The processor clock rate 24 2 2 6 SysCtlClockSet Sets the clocking of the device Prototype void SysCt1lClockSet unsigned long ulConfig Parameters ulConfig is the required configuration of the device clocking Description 350 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 _
238. char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed representation of the pin s 164 September 05 2012 GPIO 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 function cannot be used to turn any pin into an Ethernet LED pin it only configures an Ethernet LED pin for proper operation Devices with flexible pin muxing also require a GPI OPinConfigure function call Returns None 12 2 2 22 GPlOPinTypeEthernetMIl Configures pin s for use by the Ethernet peripheral as MII signals Prototype void GPIOPinTypeEthernetMII 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 on some parts provides a set of MII signals that are used to connect to an external PHY 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
239. chdog timer has been locked See also WatchdogLock WatchdogUnlock WatchdogReloadGet Returns None 31 2 2 12 WatchdogResetDisable Disables the watchdog timer reset Prototype void WatchdogResetDisable unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description This function disables the capability of the watchdog timer to issue a reset to the processor after a second timeout condition September 05 2012 507 Watchdog Timer Note This function has no effect if the watchdog timer has been locked See also WatchdogLock WatchdogUnlock Returns None 31 2 2 13 WatchdogResetEnable Enables the watchdog timer reset Prototype void WatchdogResetEnable unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description This function enables the capability of the watchdog timer to issue a reset to the processor after a second timeout condition Note This function has no effect if the watchdog timer has been locked See also WatchdogLock WatchdogUnlock Returns None 31 2 2 14 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 Description This function checks to see if the watchdog timer is enabled Returns Returns true if the watchdo
240. cifies the SSI module base address Description This function clears the handler to be called when an SSI interrupt occurs This function also masks 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 23 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 September 05 2012 343 Synchronous Serial Interface SSI char xpcChars SSI Master send data long lIdx ih Configure the SSI SSIConfigSetExpClk SSI_BASE SysCtlClockGet SSI_FRF_MOTO_MODEO SSI_MODE_MASTER 2000000 8 Enable the SSI module SSTEnable SSI_BASE Send some data lIdx 0 while pcChars 1Idx if SSIDataPut SSI_BASE pcChars 1Idx lIdx 344 September 05 2012 24 24 1 System Control System Control UO dcnnieawinit td aa aa a Dhiba adi Ded adih abide hee dauben sah hhewes 345 Pr iPM CHOU aiia EE senet ca eae daha eee enue beaters 346 Programming ERIN DIS ccc sarnrenaeceiapiseweddcamca generar bagenecEsepegarsouquenerkeabedeeaeqnmaedas 376 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
241. ck source are the system clock UART_CLOCK_SYSTEM or the precision internal oscillator UART_CLOCK_PIOSC Changing the baud clock source changes the baud rate generated by the UART Therefore the baud rate should be reconfigured after any change to the baud clock source Note The ability to specify the UART baud clock source 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 28 2 2 14 UARTConfigGetExpClk Gets the current configuration of a UART Prototype void UARTConfigGetExpClk unsigned long ulBase unsigned long ulUARTC1lk unsigned long pulBaud unsigned long xpulConfig 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 This function determines the baud rate and data format for the UART given an explicitly pro vided peripheral 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 is the same as the processor clock The frequency of the system clock is the value returned by SysCtlCl
242. cle 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 EPIl_GPMODE_ASIZE_NONE EPl_GPMODE_ASIZE_4 EPI_GPMODE_ASIZE_12 or EPl_GPMODE_ASIZE_20 to choose no address bus or an address bus size of 4 12 or 20 bits EPl_GPMODE_DSIZE_8 EPI_GPMODE_DSIZE_16 EPI_GPMODE_DSIZE 24 or EPI_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 parameter 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 September 05 2012 8 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 occurs and the transaction aborted Returns None EPIConfigHB16Set Configures the interface for Host bus 1
243. com industrial Interface interface ti com Medical www ti com medical Logic logic ti com Security www ti com security Power Mgmt power ti com Space Avionics and Defense www ti com space avionics defense Microcontrollers microcontroller ti com Video and Imaging www ti com video RFID www ti rfid com OMAP Mobile Processors www ti com omap Wireless Connectivity www ti com wirelessconnectivity TI E2E Community Home Page e2e ti com Mailing Address Texas Instruments Post Office Box 655303 Dallas Texas 75265 Copyright 2006 2012 Texas Instruments Incorporated 518 September 05 2012
244. 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 EthernetInitExpClk unsigned long ulBase unsigned long ulEthClk void EthernetIntClear unsigned long ulBase unsigned long ullntFlags void EthernetlntDisable 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 pucMACAddr void EthernetMACAddrSet unsigned long ulBase unsigned char pucMACAddr tBoolean EthernetPacketAvail unsigned long ulBase long EthernetPacketGet unsigned long ulBase unsigned char pucBuf long BufLen long EthernetPacketGetNonBlocking unsigned long ulBase unsigned char pucBuf long IBu fLen long EthernetPacketPut unsigned
245. 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 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 function cannot be used to turn any pin into a CAN pin it only configures a CAN pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 19 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 September 05 2012 163 GPIO Note This function cannot be used to turn any pin into an analog
246. 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 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 September 05 2012 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 examp
247. cription This function registers the handler to be called when a system control interrupt occurs This function enables 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 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 Note The events that cause system control interrupts vary based on the Stellaris part in use Please consult the data sheet for the part you are using to determine which interrupt sources are available Returns None 356 September 05 2012 System Control 24 2 2 18 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 function 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 Returns The
248. ctions 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 September 05 2012 Controller Area Network CAN void CANMessageGet unsigned long ulBase unsigned 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 o
249. 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 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 September 05 2012 5 2 5 3 5 2 5 4 Controller Area Network CAN 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 CANBitTimingSet Configures the CAN controller bit timing Prototype void CANBitTimingSet unsigned long ulBase tCANBitClkParms xpClkParms Parameters ulBase is the base address of the CAN controller pClkParms 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 pClkParms gt ulSyncPropPhase1Seg parameter Phase Buffer 2 is determined from the pCikParms
250. d long ulBase unsigned Parameters long ulEndpoint ulBase specifies the USB module base address ulEndpoint is the endpoint to access Description This function returns 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 returns the number of bytes available in a given endpoint FIFO 30 3 2 13 USBEndpointDataGet Retrieves data from the given endpoint s FIFO Prototype long USBEndpointDataGet unsigned long ulBase unsigned long ulEndpoint unsigned char xpucData unsigned long xpulSize 472 September 05 2012 USB Controller 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 pucData parameter It is set to the amount of data returned in the buffer Description This function returns the data from the FIFO for the given endpoint The pulSize parameter should indicate the size of the buffer passed in the pu Data parameter The data in the pulSize parameter is changed to match the amount of data returned in the pucData parameter If a zero byte packet is received this call does not return
251. d USB device IN endpoints use transmit UDMA channels When configuring the endpoint there are additional DMA settings required When calling USBDe vEndpointConfigSet for an endpoint that uses UDMA extra flags must be added to the u Flags September 05 2012 459 USB Controller 460 parameter These flags are one of USB_EP_DMA_MODE_0 or USB_EP_DMA_MODE_1 to con trol the mode of the DMA transaction and likely USB_EP_AUTO_SET to allow the data to be transmitted automatically once a packet is ready When using USB_EP_DMA_MODE_0 the USB controller only generates an interrupt when the full transfer is complete As a result the application must know the full transfer size before configuring the DMA transfer In USB_EP_DMA_MODE_1 the USB controller generates DMA requests only when a full packet is transferred and interrupts the processor on any short packet The short packet data remains in the USB FIFO and the application must trigger the last transfer of data from the FIFO The USB_EP_AUTO_SET should be specified when using uDMA to prevent the need for application code to start the actual transfer of data on every full packet 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_0O USB_EP_AUTO_SET Next the application must configure the UDMA contr
252. d above are layered above any protection set on block 0 such that the effective protection on each block is the logical OR of the protection flags set for block 0 and for the target block This protocol allows global protection options to be set for the whole device via block 0 and more restrictive protection settings to be set on a block by block basis The protection flags indicate access permissions as follow EEPROM_PROT_SUPERVISOR_ONLY restricts access to the block to threads running in su pervisor mode If clear both user and supervisor threads can access the block EEPROM_PROT_RW_LRO_URW provides read write access to the block if no password is set or if a password is set and the block is unlocked If the block is locked only read access is permitted EEPROM_PROT_NA_LNA_URW provides neither read nor write access unless a password is set and the block is unlocked If the block is unlocked both read and write access are permitted EEPROM_PROT_RO_LNA_URDO provides read access to the block if no password is set or if a password is set and the block is unlocked If the block is password protected and locked neither read nor write access is permitted Returns Returns a logical OR combination of EEPROM_RC_INVPL EEPROM_RC_WRBUSY EEPROM_RC_NOPERM EEPROM_RC_WKCOPY EEPROM_RC_WKERASE and EEP ROM_RC_WORKING to indicate status and error conditions 82 September 05 2012 EEPROM 6 2 3 7 EEPROMBlockUnlock Unlocks a password protect
253. d be disabled Description This function returns the maximum temperature value for the specified domain The u Domain parameter can be one of the following values PECI_DOMAIN_MODO PECI_DOMAIN_M0D1 PECI_DOMAIN_M1D0 or PECL DOMAIN_M1D1 Returns None 288 September 05 2012 Platform Environment Control Interface PECI 19 2 1 14 PECIDomainValueClear Clears the current temperature value for the specified domain Prototype void PECIDomainValueClear unsigned long ulBase unsigned long ulDomain Parameters ulBase is the base address of the PECI module ulDomain is the PECI domain that should be disabled Description This function clears the current temperature value for the specified domain The u Domain parameter can be one of the following values PECI_DOMAIN_MODO PECI_DOMAIN_M0D1 PECI_DOMAIN_M1D0 or PECL DOMAIN_M1D1 Returns None 19 2 1 15 PECIDomainValueGet Reads the current temperature value for the specified domain Prototype unsigned long PECIDomainValueGet unsigned long ulBase unsigned long ulDomain Parameters ulBase is the base address of the PECI module ulDomain is the PECI domain that should be disabled Description This function returns the most recently read temperature value from the specified domain The u Domain parameter can be one of the following values PECI_DOMAIN_MODO PECI_DOMAIN_M0D1 PECI_DOMAIN_M1D0 or PECL DOMAIN_M1D1 Returns
254. d 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 September 05 2012 23 Analog to Digital Converter ADC 4 2 24 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 unsigned 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 ADCintRegister unsigned long ulBase unsigned long ulSequenceNum void pfnHandler void unsigned long ADCIntStatus unsigned long ulBase unsigned long ulSequenceNum tBoolean bMasked
255. d from the channel pool The u Offset specified must be half word aligned Returns Returns the half word read from the pool memory 17 2 1 22 LPCHalfWordWrite Writes a half word to the LPC channel pool Prototype void LPCHalfWordWrite unsigned long ulBase unsigned long ulOffset unsigned short usData Parameters ulBase specifies the LPC module base address ulOffset specifies the offset from the beginning of the LPC channel pool usData specifies the byte to write September 05 2012 261 Low Pin Count Interface LPC Description This function writes a half word to the channel pool The u Offset specified must be half word aligned Returns None 17 2 1 23 LPClintClear Clears LPC interrupt sources Prototype void LPCIntClear unsigned long ulBase unsigned long ullIntFlags Parameters ulBase specifies the LPC module base address ullntFlags is a bit mask of the interrupt sources to be cleared Description The specified LPC 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 See also The description of the LPCIntEnable function provides detailed information for the bit mapped values in ullntFlags Note Because there is a write buffer in the Cortex M processor it may take several clock cycles before the interrupt source is actually cl
256. d long EEPROMBlockProtectSet unsigned long ulBlock unsigned long ulProtect unsigned long EEPROMBlockUnlock unsigned long ulBlock unsigned long pulPassword unsigned long ulCount unsigned long EEPROMInit void void EEPROMIntClear unsigned long ullntFlags void EEPROMIntDisable unsigned long ullntFlags void EEPROMIntEnable unsigned long ullntFlags unsigned long EEPROMIntStatus tBoolean bMasked unsigned long EEPROMMassErase void unsigned long EEPROMProgram unsigned long xpulData unsigned long ulAddress un signed long ulCount unsigned long EEPROMProgramNonBlocking unsigned long ulData unsigned long ulAd dress void EEPROMRead unsigned long xpulData unsigned long ulAddress unsigned long ul Count unsigned long EEPROMSizeGet void unsigned long EEPROMStatusGet void Detailed Description The EEPROM API is broken into four groups of functions those that deal with reading the EEP ROM those that deal with programming the EEPROM those that deal with EEPROM protection and those that deal with interrupt handling EEPROM reading is managed with EERROMRead EEPROM programming is managed with EEPROMMassErase EEPROMProgram and EEP ROMProgramNonBlocking EEPROM protection is managed with EEPROMBlockProtectGet EEPROMBlockProtectSet EEPROMBlockPasswordSet EEPROMBlockLock EEPROMBlockUnlock and EEPROMBlock Hide September 05 2012 75 EEPROM 6 2 2 6 2 2 1 6 2 2 2
257. d 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 programming 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 erases a 1 kB block of the on chip flash After erasing the block is filled with OxFF bytes Read on
258. d long ulBase unsigned long ulFlags Parameters ulBase specifies the USB module base address ulFlags specifies which control interrupts to enable Description This function enables the control interrupts for the USB controller specified by the u Base pa rameter The u Flags 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 30 3 2 52 USBIntEnableEndpoint Enables endpoint interrupts on a given USB controller Prototype void USBIntEnableEndpoint unsigned long ulBase unsigned long ulFlags Parameters ulBase specifies the USB module base address ulFlags specifies which endpoint interrupts to enable Description This function enables endpoint interrupts for the USB controller specified by the u Base param eter 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 30 3 2 53 USBlIntRegister Registers an interrupt handler for the USB controller Prototype void USBIntRegister unsigned long ulBase void pfnHandler void 494 September 05 2012 USB Controller Parameters ulBase specifies the USB module base address pfnHandler is a pointer to the fu
259. dcoded 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_USBEP2RxX for USB endpoint 2 receive UDMA_CHANNEL_USBEP2TX for USB endpoint 2 transmit UDMA_CHANNEL_USBEPS3RxX for USB endpoint 3 receive UDMA_CHANNEL_USBEP93TX 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 September 05 2012 439 uDMA Controller 440 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 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
260. dding 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 do 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 return immediately if a packet cannot be processed Otherwise the packet is processed normally When developing a mapping layer for a TCP IP stack you may wish to use the interrupt capability of the Ethernet controller The EthernetlIntRegister and EthernetintUnregister functions are used to r
261. ddress 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 This function waits until the transmit FIFO is empty Once space is available the function returns once BufLen bytes of the packet have been placed into the FIFO and the transmitter has been started The function does not wait for the transmission to complete The function returns the negated BufLen if the length is larger than the space available in the transmit FIFO Note This function blocks and waits 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 BufLen 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 spac
262. devices Note Both oscillators main and internal must be enabled for this verification timer to operate as the main oscillator verifies the internal oscillator Returns None 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 24 22 22 SysCtILDOGet 358 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 and is 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 SYSCTL_LDO 2 60V SYSCTL_LDO 2 65V SYSCTL_LDO 2 70V or SYSCTL_LDO_2_75V September 05 2012 System Control 24 2 2 23 SysCtILDOSet Sets the output voltage of the LDO Prototype void SysCt1LDOSet unsigned long ulVoltage Parameters ulVoltage is the required output voltage from the LDO Description This function sets the output voltage of the LDO The ulVoltage p
263. disabled Description This function disables the indicated timer 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 Timer ntEn able Returns None TimerlIntEnable Enables individual timer interrupt sources Prototype void TimerIntEnable 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 enabled Description This function enables the indicated timer 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 must be the logical OR of any combination of the following TIMER_CAPB_EVENT Capture B event interrupt September 05 2012 Timer TIMER_CAPB_MATCH Capture B match interrupt TIMER_TIMB_TIMEOUT Timer B timeout interrupt TIMER_RTC_MATCH RTC interrupt mask TIMER_CAPA_EVENT Capture A event interrupt TIMER_CAPA_MATCH Capture A match interrupt a TIMER_TIMA_TIMEOUT Timer A timeout interrupt Returns None 27 2 2 12 TimerintRegister Registers an interrupt handler for the timer interrupt Prototype void TimerIntRegister unsigned long ulBase unsigned long ulTimer void
264. dition The ulPeripheral ing values SYSCTL_PERIPH_CANO SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_EEPROMO SYSCTL_PERIPH_FANO SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPIOQ SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2C4 SYSCTL_PERIPH_LPCO param 368 eter must be only SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOK SYSCTL_PERIPH_GPION SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2C2 SYSCTL_PERIPH_I2C5 SYSCTL_PERIPH_PECIO one of the follow SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH_12CO SYSCTL_PERIPH_12C3 SYSCTL_PERIPH_12S0 SYSCTL_PERIPH_PWMO September 05 2012 System Control SYSCTL_PERIPH_PWM1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSIS SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMERS SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UART5 SYSCTL_PERIPH_UARTE6 SYSCTL_PERIPH_UART7 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOGO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER2 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER4 or SYSCTL_PERIPH_WTIMERS5 SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UARTO
265. driverlib peci c with driverlib peci h containing the API definitions for use by applications API Functions Functions m void PECIAdvCmdSend unsigned long ulBase unsigned char ucCmd unsigned char ucHidRe unsigned char ucDomain unsigned char ucProcAdd unsigned long ulArg unsigned char ucSize unsigned long ulDataO unsigned long ulData1 m unsigned long PECIAdvCmdSendNonBlocking unsigned long ulBase unsigned char ucCmd unsigned char ucHidRe unsigned char ucDomain unsigned char ucProcAdd unsigned long ulArg unsigned char ucSize unsigned long ulData0 unsigned long ulData1 m unsigned long PECIAdvCmdStatusGet unsigned long ulBase unsigned long pulData0 un signed long xpulData1 void PECIBypassDisable unsigned long ulBase void PECIBypassEnable unsigned long ulBase void PECIConfigGet unsigned long ulBase unsigned long ulPECIClk unsigned long pulBaud unsigned long pulPoll unsigned long xpulOffset unsigned long xpulRetry void PECIConfigSet unsigned long ulBase unsigned long ulPECIClk unsigned long ulBaud unsigned long ulPoll unsigned long ulOffset unsigned long ulRetry void PECIDomainConfigGet unsigned long ulBase unsigned long ulDomain unsigned long pulHigh unsigned long xpulLow void PECIDomainConfigSet unsigned long ulBase unsigned long ulDomain unsigned long ulHigh unsigned long ulLow void PECIDomainDisable unsigned long ulBase unsigned long ulDomain void PECIDomainEnable unsign
266. due to a low battery level being detected Note The HIBERNATE_WAKE_LOW_BAT parameter is only available on some Stellaris devices Returns None 13 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 pulNVData 64 Need to enable the hibernation peripheral after wake reset before using it SysCtlPeripheralEnable SYSCTL_PERIPH_HIBERNATE Determine if the Hibernation module is active if 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 AA Wakeup was due to WAKE pin assertion if ulStatus amp HIBERNATE_INT_RTC_MATCH_0 Wakeup was due to RTC matchO register September 05 2012 197 Hibernation Module 198 Restore program state information that was saved prior to hibernation HibernateDataGet pulNVData 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 The following example shows h
267. e 23 2 2 12 SSIEnable 340 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 September 05 2012 Synchronous Serial Interface SS 23 2 2 13 SSllntClear Clears SSI interrupt sources 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 This function clears the specified SSI interrupt sources so that they no longer assert This function must be called in the interrupt handler to keep the interrupts from being triggered 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 M 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 immediatel
268. e When UDMA_ALT_SELECT is specified what is really happening is that channel index 32 63 is being used 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 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 channel index the primary or alternate control structure must also be selected uDMAChannelControlSet UDMA_CHANNEL_UARTORX UDMA_PRI_SELECT sone 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 har
269. e This func tion can be used to disable this feature if it was enabled via a call to GPIOADCTriggerEnable Note This function is not available on all devices consult the data sheet to ensure that the device you are using supports GPIO ADC Control Returns None GPIOADCTriggerEnable Enables a GPIO pin as a trigger to start an ADC capture September 05 2012 153 GPIO 12 2 2 3 12 2 2 4 154 Prototype void GPIOADCTriggerEnable 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 This function enables a GPIO pin to be used as a trigger to start an ADC sequence Any GPIO pin can be configured to be an external trigger for an ADC sequence The GPIO pin still generates interrupts if the interrupt is enabled for the selected pin To enable the use of a GPIO pin to trigger the ADC module the ADCSequenceConfigure function must be called with the ADC_TRIGGER_EXTERNAL parameter Note This function is not available on all devices consult the data sheet to ensure that the device you are using supports GPIO ADC Control Returns None 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 functio
270. e at a time The ucPins parameter to these functions is used to specify the pins that are affected only the GPIO pins corresponding to the bits in this parameter that are set are affected where pin 0 is bit 0 pin 1 in bit 1 and so on For example if ucPins is 0x09 then pins 0 and 3 are affected by the function This protocol is most useful for the GPIOPinRead and GPIOPinWrite functions a read returns only the values of the requested pins with the other pin values masked out and a write only affects 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 the 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 September 05 2012 151 GPIO 12 2 API Functions 152 Functions void GPIOADCTriggerDisable unsigned long ulPort unsigned char ucPins void GPIOADCTriggerEnable unsigned long ulPort unsigned char
271. e it continues to count until it reaches zero at which point it pauses until the processor is restarted If configured to continue running it Keeps counting as if nothing had happened The ulConfig parameter contains the desired configuration It is the 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 Faults are signaled for at least this time even if the external fault pin deasserts earlier Care should be taken when us
272. e nominal value is Ox7FFF and it can be adjusted up or down in order to fine tune the RTC rate Returns None 13 2 2 35 HibernateWakeGet Gets the currently configured wake conditions for the Hibernation module Prototype unsigned long HibernateWakeGet void Description This function returns the flags representing the wake configuration for the Hibernation module The return value is a combination of the following flags m HIBERNATE_WAKE PIN wake when the external wake pin is asserted HIBERNATE_WAKE_RTC wake when one of the RTC matches occurs a HIBERNATE_WAKE_LOW_BAT wake from hibernate due to a low battery level being detected Note The HIBERNATE_WAKE_LOW_BAT parameter is only available on some Stellaris devices Returns Returns flags indicating the configured wake conditions 13 2 2 36 HibernateWakeSet Configures the wake conditions for the Hibernation module Prototype void HibernateWakeSet unsigned long ulWakeFlags 196 September 05 2012 Hibernation Module Parameters ulWakeFlags specifies which conditions should be used for waking Description This function enables the conditions under which the Hibernation module wakes The u Wake Flags parameter is the logical OR of any combination of the following HIBERNATE_WAKE PIN wake when the external wake pin is asserted HIBERNATE_WAKE_RTC wake when one of the RTC matches occurs HIBERNATE_WAKE_LOW_BAT wake from hibernate
273. e LPC module base address Description This function returns the LPC module s SERIRQ status The value returned is a combination of the following values LPC_IRQ15 LPC_IRQ14 LPC_IRQ13 LPC_IRQ12 LPC_IRQ11 LPC_IRQ10 LPC_IRQ9 LPC_IRQ8 LPC_IRQ7 LPC_IRQ6 LPC_IRQ5 LPC_IRQ4 LPC_IRQ3 LPC_IRQ2 LPC_IRQ1 LPC_IRQO LPC_IRQ_BUSY or LPC_IRQ_ CONT Returns None 17 2 1 32 LPCIRQSend Trigger a manual SIRQ frame Prototype void LPCIRQSend unsigned long ulBase Parameters ulBase specifies the LPC module base address Description This function forces the sending of an SIRQ frame using whatever values are currently set auto and or manual Returns None 17 2 1 33 LPCIRQSet Set the manual LPC IRQ bits 266 September 05 2012 Low Pin Count Interface LPC Prototype void LPCIRQSet unsigned long ulBase unsigned long ulIRQ Parameters ulBase specifies the LPC module base address ullRQ specifies the IRQ bits that should be set Description This function sets the IRQ bits that are sent in the SERIRQ frame The value in the ullRQ register is OR ed into the existing manual IRQ setting The value for the u IRQ parame ter can be any combination of the following values LPC_IRQ15 LPC_IRQ14 LPC_IRQ13 LPC_IRQ12 LPC_IRQ11 LPC_IRQ10 LPC_IRQ9 LPC_IRQ8 LPC_IRQ7 LPC_IRQ6 LPC_IRQ5 LPC_IRQ4 LPC_IRQ3 LPC_IRQ2 LPC_IRQ1 or LPC_IRQO Returns None 17 2 1 34 LPCSClAssert Generates
274. e SysTick counter to re commence counting from its 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 the reload Any write to this register clears the SysTick counter to 0 and causes a reload with the supplied period on the next clock Returns None SysTickIntDisable Disables the SysTick interrupt Prototype void SysTickIntDisable void Description This function disables the SysTick interrupt preventing it from being reflected to the processor Returns None September 05 2012 26 2 2 4 26 2 2 5 26 2 2 6 System Tick SysTick SysTickIntEnable Enables the SysTick interrupt Prototype void SysTickIntEnable void Description This function enables the SysTick interrupt allowing it to be reflected to the processor Note The Sys Tick interrupt handler is not required to clear the SysTick interrupt Source because it is cleared automatically by the 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 function registers the handler to be called when a SysTick in
275. e 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 September 05 2012 4 2 2 27 4 2 2 28 Analog to Digital Converter ADC 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 function determines if a sample sequence overflow has occurred Overflow happens if the captured samples are not read from the FIFO before the next trigger occurs 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 u
276. e 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 unsigned 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 tB
277. e 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 needs to change Example for PWMO pin configuration using PinTypePWM Configure the pin for use as a PWM pin September 05 2012 299 Peripheral Pin Mapping 300 ff PinTypePWM PWMO Example for PWMO pin configuration using GPIOPinTypePWM ifdef LM3S2110 Configure the pin for use as a PWM pin if GPIOPinTypePWM GPIO_PORTF_BASE GPIO_PIN_0O endif ifdef LM3S2620 Configure the pin for use as a PWM pin if GPIOPinTypeTimer GPIO_PORTG_BASE GPIO_PIN_O fendif September 05 2012 21 21 1 21 2 Pulse Width Modulator PWM Pulse Width Modulator PWM MOGUCOM ane iaa aa avon a dot aati Ded adeeb ee hea data hime 301 APOPO ROIS 6 tanec ee ec aah owns aieeca ee ts ounet ca mabe dabei nee e eae bean ona ee 301 Programming Example ccc connrenaeceiapisen edd camtagemeeentGagenecEsepesarsouquenersaebedeeregemaedas 322 Introduction Each instance of a Stellaris PWM module provides up to four 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 E
278. e is available in the FIFO the function returns immediately If space is available the function returns once BufLen bytes of the packet have been placed into the FIFO and the transmitter has been started The function does not wait for the transmission to complete The function returns 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 returns 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 September 05 2012 7 2 2 19 7 2 2 20 7 2 2 21 Ethernet Controller EthernetPHYAddrSet Sets the PHY address Prototype void Ethernet PHYAddrSet unsigned long ulBase unsigned char ucAddr Parameters ulBase is the base address of the controller ucAddr is the address of the PHY Description This function sets the address of the PHY that is accessed via EthernetPHYRead and Eth ernePHYWrite This configuration is only needed when connecting to an external PHY via MII and should not be used on devices that have integrated PHYs Returns None EthernetPHYPowerOff Power
279. e 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 parameter must be PWM_FAULT_GROUP_0 or PWM_FAULT_GROUP_1 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 is the log ical OR of PWM_FAULT_FAULTO PWM_FAULT_FAULT1 PWM_FAULT_FAULT2 or PWM_FAULT_FAULTS3 For PWM_FAULT_GROUP_1 this is the logical 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 September 05 2012 311 Pulse Width Modulator PWM Description This function allows selection of the set of fault inputs that is 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 specified in the ulFaultTriggers parameter after having adjusted the sense of each FAULTn input based on the configuration previously set using a call to PWMGenFaultConfigure Note This function is only available on devices supporting extended PWM fault handling Retu
280. e 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_DST_INC_8 UDMA_DST_INC_16 UDMA_DST_INC_32 or UDMA_DST_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 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_GA
281. e 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 sequencer 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 function only returns the samples that are presently available which may not be the entire sample sequence if it is in the process of being executed September 05 2012 37 Analog to Digital Converter ADC 4 2 2 24 4 2 2 25 4 2 2 26 38 Returns Returns the number of samples copied to the buffer ADCSequenceDisable Disables a sample sequence Prototype void ADCSequenceDisable unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the bas
282. e 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 the NVIC can be configured via software for N M bits of preemptable prioritization and M bits of sub priority In this scheme two interrupts with the same preemptable prioritization but different sub priorities do not cause a preemption tail chaining is used instead to process the two interrupts back to back If two interrupts with the same priority and sub priority if so configured are asserted at the same time the one with the lower interrupt number is processed first The 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
283. e watchdog timer interrupt Note This function has no effect if the watchdog timer has been locked See also WatchdogLock WatchdogUnlock WatchdogEnable Returns None September 05 2012 503 Watchdog Timer 31 2 2 4 31 2 2 5 504 WatchdogIntRegister Registers an interrupt handler for the watchdog timer interrupt Prototype void WatchdogIntRegister unsigned long ulBase void pfnHandler void 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 occurs Description This function does the actual registering of the interrupt handler This function also enables the global interrupt in the interrupt controller the watchdog timer interrupt must be enabled via WatchdogEnable It is the interrupt handler s responsibility to clear the interrupt source via WatchdogintClear See also IntRegister for important information about registering interrupt handlers Note For parts with a watchdog timer module that has the ability to generate an NMI instead of a standard interrupt this function registers the standard watchdog interrupt handler To regis ter the NMI watchdog handler use IntRegister to register the handler for the FAULT_NMI interrupt Returns None WatchdogIntStatus Gets the current watchdog timer interrupt status Prototype unsigned long WatchdogIntStatus unsigned long
284. e 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 21 2 2 31 PWMPulseWidthSet Sets the pulse width for the specified PWM output Prototype void PWMPulseWidthSet unsigned long ulBase unsigned long ulPWMOut unsigned long ulWidth Parameters ulBase is the base address of the PWM module ulPWMoOut is the PWM output to modify This parameter must be one of PWM_OUT_0O 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 320 September 05 2012 Pulse Width Modulator PWM 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 cause the previous values to be overwritten Returns None 21 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 This
285. eClockSelect 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 HibernateGP lORetentionDisable void void HibernateGP ORetentionEnable void tBoolean HibernateGP lORetentionGet void void HibernatelntClear unsigned long ullntFlags void HibernatelntDisable unsigned long ullntFlags September 05 2012 179 Hibernation Module 13 2 1 180 void HibernatelntEnable unsigned long ullntFlags void HibernatelntRegister void pfnHandler void unsigned long HibernatelntStatus tBoolean bMasked void HibernatelntUnregister void unsigned long HibernatelsActive void unsigned long HibernateLowBatGet void void HibernateLowBatSet unsigned long ulLowBatFlags void HibernateRequest void void HibernateRTCDisable void void HibernateRTCEnable void unsigned long HibernateRTCGet void unsigned long HibernateRT CMatch0Get void void HibernateRT CMatch0Set unsigned long ulMatch unsigned long HibernateRT CMatch1 Get void void HibernateRTCMatch1 Set unsigned long ulMatch void HibernateRTCSet unsigned long ulRTCValue unsigned long HibernateRT CSSGet void unsigned long HibernateRT CSSMatchOGet void void HibernateRTCSSMatchOSet unsigned long ulMatch unsigned long HibernateRTCTrimGet void void HibernateRT
286. eadBandEnable Enables the PWM dead band output and sets the dead band delays September 05 2012 303 Pulse Width Modulator PWM 21 2 2 3 304 Prototype void PWMDeadBandEnable unsigned long ulBase unsigned long ulGen unsigned short usRise unsigned short usFall Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to modify This parameter must be one of PWM_GEN_0O 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 This function 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 because it supports all fault interrupts supported on devices with and without extended PWM faul
287. eared 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 17 2 1 24 LPClIntDisable Disables individual LPC interrupt sources Prototype void LPCIntDisable unsigned long ulBase unsigned long ullIntFlags Parameters ulBase specifies the LPC module base address 262 September 05 2012 Low Pin Count Interface LPC ullntFlags is a bit mask of the interrupt sources to be disabled Description This function disables the indicated LPC interrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor See also The description of the LPCIntEnable function provides detailed information for the bit mapped values in ullntFlags Returns None 17 2 1 25 LPClintEnable Enables individual LPC interrupt sources Prototype void LPCIntEnable unsigned long ulBase unsigned long ullIntFlags Parameters ulBase specifies the LPC module base address ullntFlags is a bit mask of the interrupt sources to be enabled Description This function enables the indicated LPC interrupt
288. ecifies 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 330 September 05 2012 Quadrature Encoder QE Description This function configures 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 22 2 2 15 QElVelocityDisable Disables the velocity capture Prototype void QETVelocityDisable unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This function disables operation of the velocity capture in the quadrature encoder module Returns None 22 2 2 16 QElVelocityEnable Enables the velocity capture Prototype void QETVelocityEnable unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This function enables operation of the velocity capture in the quadrature encoder module The module must be configured before velocity capture is enabled See also QEIVelocityCon
289. ectly 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 controllers FIFO memory The ulFlags 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 30 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 Description This function forces the USB 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_DEV_IN September 05 2012 479 USB Controller Returns None 30 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 30 3 2 26 USBHostAddrGet Gets the current functional device address for an endpoint
290. ects 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_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 September 05 2012 55 Controller Area Network CAN 5 2 5 5 2 5 1 5 2 5 2 56 Function Documentation CANBitRateSet Sets the CAN bit timing values to a nomi
291. ed Description The specified 12C Slave interrupt sources are cleared so that they no longer assert This function must be called in the interrupt handler to keep the interrupt from being triggered again immediately upon exit The ullntFlags parameter has the same definition as the ullntFlags parameter to I2CSlavelntEnableEx September 05 2012 217 Inter Integrated Circuit 12C Note Because there is a write buffer in the Cortex M 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 14 2 2 33 2CSlavelntDisable Disables the 12C Slave interrupt Prototype void I2CSlaveIntDisable unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description This function disables the I2C Slave interrupt source Returns None 14 2 2 34 2CSlavelntDisableEx 218 Disables individual 12C Slave interrupt sources Prototype void I2CSlaveIntDisableEx unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the b
292. ed in the u Flags parameters should be the definitions that start with USB_INTEP_ and not any other USB_INT flags Returns None 30 3 2 50 USBIntEnable Enables the sources for USB interrupts Prototype void USBIntEnable unsigned long ulBase unsigned long ulFlags Parameters ulBase specifies the USB module base address ulFlags specifies which interrupts to enable Description This function enables the USB controller s ability to generate 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_STATUS If USB_INT_ALL is specified then all interrupts are 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 in terrupt 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 September 05 2012 493 USB Controller 30 3 2 51 USBIntEnableControl Enables control interrupts on a given USB controller Prototype void USBIntEnableControl unsigne
293. ed EEPROM block Prototype unsigned long EEPROMBlockUnlock unsigned long ulBlock unsigned long pulPassword unsigned long ulCount Parameters ulBlock is the EEPROM block number which is to be unlocked pulPassword points to an array of unsigned long values containing the password for the blockt Each element must match the password originally set via a call to EERPROMBlock PasswordSet ulCount provides the number of unsigned longs in the pulPassword array and must match the value originally passed to EERROMBlockPasswordSet Valid values are 1 2 and 3 Description This function unlocks an EEPROM block that has previously been protected by writing a pass word Access to the block once it is unlocked is determined by the protection settings applied via a previous call to the EERROMBlockProtectSet function To successfully unlock an EEPROM block the password provided must match the password provided on the original call to EEPROMBlockPasswordSet If an incorrect password is pro vided the block remains locked Unlocking block 0 has the effect of making all other blocks in the device accessible according to their own access protection settings When block 0 is locked all other EEPROM blocks are inaccessible Returns Returns the lock state for the block on exit 1 if unlocked or 0 if locked 6 2 3 8 EEPROMInit Performs any necessary recovery in case of power failures during write Prototype u
294. ed long ulBase unsigned long ulDomain September 05 2012 281 Platform Environment Control Interface PECI 19 2 1 19 2 1 1 19 2 1 2 282 void PECIDomainMaxReadClear unsigned long ulBase unsigned long ulDomain unsigned long PECIDomainMaxReadGet unsigned long ulBase unsigned long ulDomain void PECIDomainValueClear unsigned long ulBase unsigned long ulDomain unsigned long PECIDomainValueGet unsigned long ulBase unsigned long ulDomain void PEClIntClear unsigned long ulBase unsigned long ullntFlags void PECIIntDisable unsigned long ulBase unsigned long ullntFlags void PEClIntEnable unsigned long ulBase unsigned long ullntFlags unsigned long ullnt Mode void PEClIntRegister unsigned long ulBase void pfnHandler void unsigned long PEClIntStatus unsigned long ulBase tBoolean bMasked void PEClIntUnregister unsigned long ulBase Function Documentation PECIAdvCmdSend Sends a PECI Advanced Command Prototype void PECIAdvCmdSend unsigned long ulBase nsigned char ucCmd nsigned char ucHidRe nsigned char ucDomain nsigned char ucProcAdd nsigned long ulArg nsigned char ucSize nsigned long ulData0 nsigned long ulDatal CG AGE GS GS GG Parameters ulBase specifies the PECI module base address Description This function sends a PECI Advanced Command If the interface is not IDLE it waits for the interface to become IDLE then sends the command The functio
295. ed long ulConfig September 05 2012 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 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 8 2 2 8 EPIllntDisable 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 Ret
296. ed long ulOffset unsigned char ucData void LPCChannelConfigCOMxSet unsigned long ulBase unsigned long ulChannel unsigned long ulConfig unsigned long ulAddress unsigned long ulOffset unsigned long ulCOMxMode void LPCChannelConfigEPSet unsigned long ulBase unsigned long ulChannel unsigned long ulConfig unsigned long ulAddress unsigned long ulOffset m unsigned long LPCChannelConfigGet unsigned long ulBase unsigned long ulChannel un signed long pulAddress unsigned long xpulOffset unsigned long pulCOMxMode void LPCChannelConfigMBSet unsigned long ulBase unsigned long ulChannel unsigned long ulConfig unsigned long ulAddress unsigned long ulOffset void LPCChannelDisable unsigned long ulBase unsigned long ulChannel unsigned long LPCChannelDMAConfigGet unsigned long ulBase void LPCChannelDMAConfigSet unsigned long ulBase unsigned long ulConfig unsigned long ulMask void LPCChannelEnable unsigned long ulBase unsigned long ulChannel unsigned long LPCChannelPoolAddressGet unsigned long ulBase unsigned long ulChannel void LPCChannelStatusClear unsigned long ulBase unsigned long ulChannel unsigned long ulStatus unsigned long LPCChannelStatusGet unsigned long ulBase unsigned long ulChannel void LPCChannelStatusSet unsigned long ulBase unsigned long ulChannel unsigned long ulStatus September 05 2012 251 Low Pin Count Interface LPC 17 2 1 17 2 1 1 252 void LPCCOMxIntClear unsigned lo
297. ed long ullntFlags void SSlIIntDisable unsigned long ulBase unsigned long ullntFlags void SSlIlntEnable unsigned long ulBase unsigned long ullntFlags void SSllntRegister unsigned long ulBase void pfnHandler void unsigned long SSliIntStatus unsigned long ulBase tBoolean bMasked void SSllntUnregister unsigned long ulBase Detailed Description The SSI API is broken into several groups of functions Each of those groups is addressed below 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 The SSI baud clock is managed by the SSIClockSourceGet and SSIClockSourceSet functions Data handling is performed by the SSIDataPut SSIDataPutNonBlocking SSIDataGet and SSIDataGetNonBlocking functions Interrupts from the SSI module are managed using the SSllntClear SSllntDisable SSIIntEn 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
298. een 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 option is not used this flag must be manually cleared via a call to USBDevEndpointSta tusClear 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 30 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 September 05 2012 469 USB Controller 30 3 2 8 30 3 2 9 Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access blsLastPacket indicates if this packet is the last one Description This function acknowledges that the data was read from the endpoints 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
299. efore the first timeout interrupt is cleared and the reset signal 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 On some parts there are two watchdog timers one that is clocked by the system clock and a second that is clocked by PIOSC On some parts the watchdog timer can be configured to generate an NMI instead of a standard interrupt If the watchdog timer has been configured to generate an NMI the interrupt is still treated the same as if it were a standard interrupt it must be enabled in order to be triggered and it must be cleared inside the NMI handler This driver is contained in driverlib watchdog c with driverlib watchdog h containing the API definitions for use by applications API Functions Functions m void WatchdogEnable unsigned long ulBase m void Watchdog ntClear unsigned long ulBase m void WatchdogIntEnable unsigned long ulBase m void WatchdogIntRegister unsigned long ulBase void xpfnHandler void m unsigned long Watchdog ntStatus unsigned long ulBase tBoolean bMasked September 05 2012 501 Watchdog Timer 31 2 1 31 2
300. egister 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 are used to query the active interrupts to de termine 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 September 05 2012 1 2 2 7 2 2 1 7 2 2 2 Ethernet Controller applications to link and run with the new APIs It is recommended that new applications use the new APIs in rather than the old ones 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 Description This function queries the control registers of the Ethernet controller and returns a bit mapped configuration value
301. elect 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 respectively The peripheral clock is the same as the processor clock The frequency of the system clock is 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 For Stellaris parts that have the ability to specify the UART baud clock source via UARTClock SourceSet the peripheral clock can be changed to PIOSC In this case the peripheral clock should be specified as 16 000 000 the nominal rate of PIOSC 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 28 2 2 16 UARTDisable 418 Disables transmitting and receiving Prototype void UARTDisable unsigned long ulBase Parameters ulBase is the base address of the UART port September 05 2012 UART Description This function clears the UARTEN TXE and RXE bits waits for the end of transmission of the current character and flushes the transmit FIFO
302. ember 05 2012 Analog Comparator 3 2 2 4 3 2 2 5 18 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 enabled comparator interrupts 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 pfnHandler is a pointer to the function to be called when the comparator interrupt occurs Description This function sets the handler to be called when the comparator interrupt occurs and enables the interrupt in the interrupt controller It is the interrupt handler s responsibility to clear the interrupt source via Comparator ntClear See also IntRegister for important information about registering interrupt handlers Returns None September 05 2012 3 2 2 6 3 2 2 7 3 2 2 8 Analog Comparator ComparatorIntStatus Gets the current interrupt status Prototype tBoolean Compara
303. en the duty cycle value is the value that has been calculated by the FAN channel automatic speed control algorithm The fan controller can be configured to notify an application of various events using interrupts The interrupt handler can be registered at run time using the function FanIntRegister The function FanIntUnregister can be used to remove the interrupt handler when it is no longer needed These functions are not needed if static build time interrupt registration is used Specific interrupt events can be enabled for each channel using the FanIntEnable function Sim ilarly interrupts can be disabled with FanIntDisable The interrupt status can be checked with FanIntStatus and any pending interrupts cleared with FanIntClear Fan Channel Configuration Options The fan controller has several options to control the behavior of a FAN channel These options are configured using FanChannelConfigAuto or FanChannelConfigManual The following options are available in automatic mode Automatic restart a FAN channel can be configured to restart automatically if it stalls Use the flags FAN_CONFIG_RESTART or FAN_CONFIG_NORESTART to configure this behav ior Acceleration rate a FAN channel can be configured to change speed using a fast or slow acceleration ramp This ramp is the rate of change that is used when the FAN is hunt ing for the commanded speed The acceleration rate is configured using one of the flags FAN_CONF
304. entation of the pin s Description The PECI transmit pin must be properly configured for the PECI module to function correctly This function provides a typical configuration for that pin The pin is 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 function cannot be used to turn any pin into a PECI transmit pin it only configures a PECI transmit pin for proper operation Devices with flexible pin muxing also require a GPIOPinCon figure function call 170 September 05 2012 GPIO Returns None 12 2 2 33 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 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 function
305. ents the block data from being read or written If a password is set for the block and the block is locked this protection level prevents the block data from being read or written If a password is set for the block and the block is unlocked this protection level allows both read and write access to the block data EEPROM_PROT_RO_LNA_URO If no password is set for the block this protection level allows only read access to the block data If a password is set for the block and the block is locked this protection level prevents the block data from being read or written If a password is set for the block and the block is unlocked this protection level allows only read access to the block data API Functions Defines EEPROM_INIT_ERROR EEPROM_INIT_OK EEPROM_INIT_RETRY EEPROM_INT_PROGRAM EEPROM_PROT_NA_LNA_URW EEPROM_PROT_RO_LNA_URO EEPROM_PROT_RW_LRO_URW EEPROM_PROT_SUPERVISOR_ONLY EEPROM_RC_INVPL September 05 2012 6 2 1 EEPROM EEPROM_RC_NOPERM EEPROM_RC_WKCOPY EEPROM_RC_WKERASE EEPROM_RC_WORKING EEPROM_RC_WRBUSY EEPROMAddrFromBlock ulBlock EEPROMBlockFromAddr ulAddr Functions unsigned long EEPROMBlockCountGet void void EERROMBlockHide unsigned long ulBlock unsigned long EEPROMBlockLock unsigned long ulBlock unsigned long EEPROMBlockPasswordSet unsigned long ulBlock unsigned long pulPassword unsigned long ulCount unsigned long EEPROMBlockProtectGet unsigned long ulBlock unsigne
306. epresents 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 12 2 2 5 GPIODMATriggerDisable Disables a GPIO pin as a trigger to start a DMA transaction Prototype void GPIODMATriggerDisable 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 This function disables a GPIO pin from being used as a trigger to start a UDMA transaction This function can be used to disable this feature if it was enabled via a call to GPIODMATrig gerEnable Note This function is not available on all devices consult the data sheet to ensure that the device you are using supports GPIO DMA Control September 05 2012 155 GPIO 12 2 2 6 12 2 2 7 Returns None GPIODMATriggerEnable Enables a GPIO pin as a trigger to start a DMA transaction Prototype void GPIODMATriggerEnable 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 This function enables a GPIO pin to be used as a trigger to start a uDMA transaction Any GPIO pin can be configured to be an external trigger for the uDMA The GPIO pin still generates in
307. eptember 05 2012 105 External Peripheral Interface EP 8 2 1 106 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 EPINonBlockingReadCount 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 determines the speed of the external bus The external device is mapped into the processor memory or peripheral space using the EPlIAddr
308. er is not attempting to determine its role in the system For Dual Mode controllers The function returns one 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 BSIDE_DEV USB_OTG_MODE_NONE USB_DUAL_MODE_HOST USB_DUAL_MODE_DEVICE or USB_DUAL_MODE_NONE 30 3 2 59 USBNumEndpointsGet Returns the number of USB endpoint pairs on the device Prototype unsigned long USBNumEndpointsGet unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function returns the number of endpoint pairs supported by the USB controller corre sponding to the passed base address The value returned is the number of IN or OUT end points available and does not include endpoint 0 the control endpoint For example if 15 is returned there are 15 IN and 15 OUT endpoints available in addition to endpoint 0 Returns Returns the number of IN or OUT endpoints available 30 3 2 60 USBOTGMode Change the mode of the USB controller to OTG 498 September 05 2012 30 3 2 61 USB Controller Prototype void USBOTGMode unsigned
309. er 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 eh Reset the state of all the message objects and the state of the CAN module to a known state ah CANInit CANO_BASE CANInit CAN1_BASE tf Configure the controller for 1 Mbit operation CANSetBitTiming CAN1_BASE amp CANBitClk Take the CANO device out of INIT state Af CANEnable CANO_BASBE CANEnable CAN1_BASE iif Configure a receive object sMsgObjectRx ulMsgID 0x400 sMsgObjectRx ulMsgIDMask 0x7f8 sMsgObjectRx ulFlags MSG_OBJ_USE_ID_FILTER MSG_OBJ_FIFO The first three message objects have the MSG_OBJ_FIFO set to indicate that they are part of a FIFO September 05 2012 69 Controller Area Network CAN 70 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
310. er to complete the resume signaling on the USB bus Returns None 30 3 2 45 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 returns the current speed of the USB bus Note This function must only be called in host mode Returns Returns either USB_LOW_SPEED USB_FULL_SPEED or USB _UNDEF_SPEED 30 3 2 46 USBHostSuspend Puts the USB bus in a suspended state Prototype void USBHost Suspend unsigned long ulBase Parameters ulBase specifies the USB module base address Description When used in host mode this function puts the USB bus in the suspended state Note This function must only be called in host mode Returns None September 05 2012 491 USB Controller 30 3 2 47 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 disables 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
311. er to storage for the offset pulRetry is a pointer to storage for the retry count Description The baud rate and poll rate for the PECI module are determined given an explicitly provided peripheral clock The returned rates are the actual rates being used they may not be the same as the requested rates due to rounding in the calculations September 05 2012 19 2 1 7 Platform Environment Control Interface PECI The peripheral clock is the same as the processor clock This value is returned by SysCtIClock Get or it can be explicitly hard coded if it is constant and known to save the code execution overhead of a call to SysCtlClockGet The baud rate returned in xpu Baud represents the rate at which the peripheral starts PECI transactions Due to client clock stretching and delays associated with external components the actual baud rate observed will always be lower than this value Returns None PECIConfigSet Sets the configuration of the PECI module Prototype void PECIConfigSet unsigned long ulBase unsigned long ulPECIC1k unsigned long ulBaud unsigned long ulPoll unsigned long ulOffset unsigned long ulRetry Parameters ulBase is the base address of the PECI module ulPECICIk is the rate of the clock supplied to the PECI module ulBaud is the bit rate that should be used for the PECI transfers ulPoll is the polling rate in ms that should be used for the time between
312. eral 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 below is in the list passed to this function then the default peripheral marked as _DEF_ is 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 448 September 05 2012 uDMA Controller 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_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 29 2 3 138 uDMAChannelSelectSecondary Selects the secondary peripheral for a set of UDMA channels Prototype void uDMAChannelSelectSecondary unsigned lo
313. eralDeepSleepEnable unsigned long ulPeripheral 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 Because 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 do 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 ing values SYSCTL_PERIPH_CANO SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_EEPROMO SYSCTL_PERIPH_FANO SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPIOQ SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2C4 SYSCTL_PERIPH_LPCO SYSCTL_PERIPH_PWM1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI3 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMERS SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UART5 param eter must be only SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOK SYSCTL_PERIPH_GPION SYSCTL_PERIPH_HIBERN
314. erence 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 20 September 05 2012 3 2 2 9 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 Analog Comparator Returns true if the comparator output is high and false if the comparator output is low 3 3 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 September 05 2012
315. eriod 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 cause the previous values to be overwritten Returns None 21 2 2 23 PWMIntDisable 316 Disables generator and fault interrupts fora PWM module Prototype void PWMIntDisable unsigned long ulBase unsigned long ulGenFault Parameters ulBase is the base address of the PWM module ulGenFault contains the interrupts to be disabled This parameter must be a logical OR of any 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 or PWM_INT_FAULT3 Description This function masks the specified interrupt s by clearing the specified bits of the interrupt enable register for the selected PWM module Returns None September 05 2012 Pulse Width Modulator PWM 21 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 This parameter must be a logical OR of any 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 or PWM_INT_FAULT3 Description This function unmasks the specified interrupt
316. erlntEnable and 2CSlavelntEnable If necessary it is the interrupt handler s responsibility to clear the interrupt source via 2CMasterIntClear and I2CSlavelntClear See also IntRegister for important information about registering interrupt handlers Returns None I2CIntUnregister Unregisters an interrupt handler for the 12C module Prototype void T2CIntUnregister unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This function clears the handler to be called when an 12C interrupt occurs This function also masks off the interrupt in the interrupt r controlle so that the interrupt handler no longer is called See also IntRegister for important information about registering interrupt handlers Returns None September 05 2012 14 2 2 3 14 2 2 4 14 2 2 5 Inter Integrated Circuit 12C 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 Returns Returns true if the 12C bus is busy otherwise returns false I2CMasterBusy Indicates whether or not the I2C Master is busy Prototype tBoole
317. errupt has oc curred This register can be read using the EthernetPHYRead API function ETH_INT_MDIO 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 m ETH_INT_TX This interrupt indicates that the packet stored in the TX FIFO has been successfully transmitted m 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 7 2 2 9 EthernetiIntRegister 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 function enables the global inte
318. errupt 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 September 05 2012 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 Returns 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
319. errupts that are allowed to reflect to the processor can be returned The interpretation of the PECI_DOMAIN_MnDm fields vary based on the mode value programed using the PEClIntEnable function for the field Each field may take on one of the following values PECILMnDm_MODE1_HIGH PECILMnDm_MODE2_MID PECL MnDm_MODE2_HIGH PECL MnDm_MODE3_LOW PECI_MnDm_MODE3_MID or PECILMnDm_MODE3_HIGH Returns The current interrupt status enumerated as a bit field of PECI_ READ PECI_ERR PECI_AC PECI_MODO PECI_MOD1 PECI_M1D0 or PECI_M1D1 19 2 1 21 PEClIntUnregister Unregisters an interrupt handler for the PECI module Prototype void PECIIntUnregister unsigned long ulBase Parameters ulBase specifies the PECI module base address Description This function unregisters the handler to be called when a PECI interrupt occurs This function also masks 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 292 September 05 2012 20 20 1 20 2 Peripheral Pin Mapping Peripheral Pin Mapping ROUT SO aneia aa a hdd bean Deed aden hee here e 293 PP iPM CMON 6 aca ee ec aah elena cain ts Ch sunt ca mae oe daha aed enue edie ona 293 Pregrammmg ERIN DIE ccc sornrenaeceiapisen a A EE E 299 Introduction The peripheral pin mapping functions provide an easy method of configuring a
320. es 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 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 API Functions Functions m void EPlAddressMapSet unsigned long ulBase unsigned long ulMap 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 S
321. es a code snippet showing how it is 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 uUDMA API functions require a channel number as a parameter There are two different uses of the channel number In some cases it is the number of the uUDMA channel and is used to read or write registers within the uDMA 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 September 05 2012 uDMA Controller the UDMA channel control structure Because every UDMA channel has a primary and an alternate channel control structure this index must also be specified as part of the channel number The index is specified 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 the primary channel control structure is used which is the right thing in most cases Not
322. escription This function enables write access to the watchdog timer configuration registers Returns None 31 2 2 18 WatchdogValueGet 31 3 510 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 WatchdogReloadSet WATCHDOGO_BASE OxFEEFEE Enable the reset WatchdogResetEnable WATCHDOGO_BASE Enable the watchdog timer WatchdogEnable WATCHDOGO_BASE Wait for the reset to occur while 1 September 05 2012 Watchdog Timer September 05 2012 511 Watchdog Timer 512 September 05 2012 32 32 1 32 2 Using the ROM Using the ROM IPRS OUICHINY 2 icisizatadsise ttl exdosd aa atenin dbishindehdubddran nas cea phate eddie pamimds adiiah ad deca Wane E Khicdus 513 Drect PAC Ae codis aa alonetes ohhen eee ORaepue lesan ned e ep eueen atta aa 513 Mapper
323. ese calls are the only ones required to start a new transfer because normally the previous UDMA configuration can remain the same Example Start requesting data on endpoint 1 Configure the address and size of the data to transfer The transfer is from the USB FIFO for endpoint 0 to g_DataBufferIn DMAChannelTransferSet DMA_CHANNEL_USBEP1RX DMA_MODE_BASIC USBFIFOAddr USBO_BASE USB_EP_1 g_DataBuffertn 64 Enable the uDMA channel and wait for data DMAChannelEnable DMA_CHANNEL_USBEP1RX The uDMA interrupt occurs on the same interrupt vector as any other USB interrupt which means that the application must determine what the actual source of the interrupt was It is possible that the USB interrupt does not indicate that the USB transfer was complete The interrupt could also have 462 September 05 2012 USB Controller been caused by a short packet error or even a transmit complete As a result the application must check both receive cases to determine if the interrupt 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 Get the current interrupt status ulStatus USBIntStatusEndpoint USBO_BASE if ulStatus amp USB_INTEP_DEV_OUT_1 Handle a short packet else i
324. esigned 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 products 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 Tl 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 Audio www ti com audio Automotive and Transportation www ti com automotive Amplifiers amplifier ti com Communications and Telecom www ti com communications Data Converters dataconverter ti com Computers and Peripherals www ti com computers DLP Products www dlp com Consumer Electronics www ti com consumer apps DSP dsp ti com Energy and Lighting www ti com energy Clocks and Timers www ti com clocks Industrial www ti
325. ess UDMA API provides functions to configure the Stellaris UDMA controller The uUDMA controller is designed to work with the ARM Cortex M 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 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 M 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 a request is asserted by a device This mode is appropriate to use with peripherals where the peripheral asserts the request signal whenever data should be transferred The transfer pauses if the 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 always com pletes the entire transfer even if the request is de
326. essMapSet function Once the mode is selected the interface is configured with one of the configuration functions If SDRAM mode is chosen then the function EPIConfigSDRAMSet is used to configure the SDRAM interface If Host Bus 8 mode is chosen then EP ConfigHB8Set is used If Host Bus 16 mode is chosen then EP IConfigHB16Set is used If General Purpose mode is chosen then EPIConfig GPMode is 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 ways to use the read write interface When an application is writing to the mapped memory or peripheral space the writes 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 returns the number of non blocking writes that can be made For efficient reads from the external device the EPI contains a programmable read FIFO After setting a starting address and a count data from sequential reads from the device can be stored in the FIFO The application can then periodically drain the FIFO by polling or
327. essor executes an in terrupt handler it can do nothing with the floating point context it can always save the floating point context or it can perform a lazy save restore of the floating point context If nothing is done with the floating point context the interrupt stack frame is identical to a Cortex M processor that does not have a floating point unit containing only the volatile registers of the integer unit This method is useful for applications where the floating point unit is used by the main thread of execution but not in any of the interrupt handlers By not saving the floating point context stack usage is reduced and interrupt latency is kept to a minimum Alternatively the floating point context can always be saved onto the stack This method allows floating point operations to be performed inside interrupt handlers without any special precautions at the expense of increased stack usage for the floating point context and increased interrupt latency due to the additional writes to the stack The advantage to this method is that the stack frame always contains the floating point context when inside an interrupt handler The default handling of the floating point context is to perform a lazy save restore When an in terrupt is taken space is reserved on the stack for the floating point context but the context is not written This method keeps the interrupt latency to a minimum because only the integer state is written to the stack
328. estINClear Clears a scheduled IN transaction for an endpoint in host mode Prototype void USBHostRequestINClear unsigned long ulBase unsigned long ulEndpoint Parameters ulBase specifies the USB module base address ulEndpoint is the endpoint to access Description This function clears a previously scheduled IN transaction if it is still pending This function should be used to safely disable any scheduled IN transactions if the endpoint specified by ulEndpoint is reconfigured for communications with other devices Note This function should only be called in host mode and only for IN endpoints Returns None 30 3 2 42 USBHostRequestStatus Issues a request for a status IN transaction on endpoint zero Prototype void USBHostRequestStatus unsigned long ulBase September 05 2012 489 USB Controller Parameters ulBase specifies the USB module base address Description This function is used to cause a request for a 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 function is used to complete the last phase of a control transaction to a device and an interrupt is signaled when the status packet has been received Returns None 30 3 2 438 USBHostReset Handles the USB bus reset condition Prototype void USBHostReset unsigned long ulBase tBoolean bStart P
329. et 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 24 2 2 45 SysCtlResetCauseGet Gets the reason for a reset Prototype unsigned long SysCt1lResetCauseGet void Description This function returns the reason s for a reset Because the reset reasons are sticky until either cleared by software or an external reset for Sandstorm class devices or a power on reset for all other classes multiple reset reasons may be returned if multiple resets have occurred The reset reason is a log ical 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 24 2 2 46 SysCtlSleep 374 Puts the processor into sleep mode Prototype void SysCt1Sleep void September 05 2012 System Control Description This function places the processor into sleep mode it does not return until the processor returns to run mode The peripherals that are enabled via SysCtlPeripheralSleepEnable con tinue to operate and can wake up the processor if automatic clock gating is enabled with SysCtlPeripheralClockGating otherwise all peripherals continue to operate Returns None 24 2 2 47 SysCtISRAMSizeGet Gets the size of the SRAM Prototype
330. eturns None 27 2 2 19 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 full width operation Description This function gets the match value for the specified timer Note This function can be used for both full and half width modes of 16 32 bit timers and for half width modes of 32 64 bit timers Use TimerMatchGet64 for full width modes of 32 64 bit timers Returns Returns the match value for the timer 27 2 2 20 TimerMatchGet64 Gets the timer match value for a 64 bit timer Prototype unsigned long long TimerMatchGet 64 unsigned long ulBase 400 September 05 2012 27 2 2 21 Timer Parameters ulBase is the base address of the timer module Description This function gets the match value for the specified timer Returns Returns the match value for the timer 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 full wid
331. evel trigger values HIBERNATE_LOW_BAT_1_9V voltage low level is 1 9V HIBERNATE_LOW_BAT_2_1V voltage low level is 2 1V a HIBERNATE_LOW_BAT_2 _8V voltage low level is 2 3V HIBERNATE_LOW_BAT_2_5V voltage low level is 2 5V Example Abort hibernate if the voltage level is below 2 1V HibernateLowBatSet HIBERNATE_LOW_BAT_ABORT HIBERNATE_LOW_BAT_2_1V j Note The parameters with the specific voltage levels are only available on some Stellaris devices 190 September 05 2012 Hibernation Module Returns None 13 2 2 21 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 remains powered from the battery or auxiliary power supply The Hibernation module re enables the external regulator when one of the configured wake conditions occurs such as RTC match or external WAKE pin When the power is restored the processor goes through a power on reset although the Hibernation module is not 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 HibernateWakeSet function Note that this function may return because some time may elapse before the power i
332. external reset a software reset request a watchdog timeout and a main oscillator failure The properties of some of these events can be configured and the reason for a reset can be determined from system September 05 2012 345 System Control 24 2 control Not all of these reset causes are on all devices see the device data sheet for more details 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 because 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 cannot 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 Some devices provide the option to clock some peripherals with the PIOSC even while in deep sleep mode so the peripheral clocking does not have to be reconfigured upon entry and exit There are various system events that when detected cause system control to generate a pro cessor interrupt These events are the PLL achieving lock the internal LDO current limit being exceeded the internal oscillator failing the main oscilla
333. f 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 30 3 API Functions Functions unsigned long USBDevAdadrGet unsigned long ulBase void USBDevAddrSet unsigned long ulBase unsigned long ulAddress void USBDevConnect unsigned long ulBase void USBDevDisconnect unsigned long ulBase void USBDevEndpointConfigGet unsigned long ulBase unsigned long ulEndpoint unsigned long xpulMaxPacketSize unsigned long pulFlags void USBDevEndpointConfigSet 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 September 05 2012 463 USB Controller 464 unsigned long USBEndpointDataAvail unsigned long ulBase unsigned long ulEndpoint long USBEndpointDataGet unsigned long ulBase unsigned long ulEndpoint unsigned char pucData unsigned long pulSize long USBEndpointDataPut unsigned long ulBase u
334. f MOSC control varies based on the Stellaris part in use September 05 2012 359 System Control Returns None 24 2 2 25 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 is 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 verifies the main oscillator Returns None 24 2 2 26 SysCtlPeripheralClockGating 360 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 SysCt
335. f the RTC counter is the same as the match combined with the sub second match register Note The Hibernation sub second RTC Match 0 feature is not available on all Stellaris devices Please consult the data sheet for the Stellaris device that you are using to determine if this feature is available Returns None 13 2 2 33 HibernateRTCTrimGet Gets the value of the RTC pre divider trim register Prototype unsigned long HibernateRTCTrimGet void Description This function gets the value of the pre divider trim register This function can be used to get the current value of the trim register prior to making an adjustment by using the HibernateRT CTrim Set function Returns None September 05 2012 195 Hibernation Module 13 2 2 34 HibernateRTCTrimSet Sets the value of the RTC pre divider trim register Prototype void HibernateRTCTrimSet unsigned long ulTrim Parameters ulTrim is the new value for the pre divider trim register Description This function 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 pre divider to allow fine tuning of the RTC rate in order to make corrections to the rate The software application can make adjustments to the pre divider trim register to account for variations in the accuracy of the input time source Th
336. f the following options m 12S CONFIG_FORMAT_ 12S for standard 12S format 12S 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 I2S 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 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 number 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 15 2 2 25 I2STxRxDisable 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 are generated on the I2S signals Returns None 15 2 2 26 I2STxRxEnable Enables the I2S transmit and receive modules for operation Prototype void I2STxRxEn
337. f 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 can 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
338. fault configuration is being set This function 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_HIGH and PWM_FAULTn_SENSE_LOW Description This function configures 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 as serted the minimum fault period timer ensures that it remains asserted for at least the number of clock cycles specified September 05 2012 309 Pulse Width Modulator PWM Note This function is only available on devices supporting extended PWM fault handling Returns None 21 2 2 12 PWMGenFaultStatus 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 for which fault trigger states are being queried This parameter must be one of PWM_GEN_0 PWM_GEN_1 PWM_GEN_ 2 or PWM_
339. ffer to make room for a newly written value It is provided as a status indicator and does not indicate an error EEPROM_RC_WKERASE Definition define EEPROM RC_WKERASE Description This return code bit indicates that the EEPROM programming state machine is currently eras ing the internal copy buffer It is provided as a status indicator and does not indicate an error EEPROM_RC_WORKING Definition define EEPROM _RC_WORKING Description This return code bit indicates that the EEPROM programming state machine is currently work ing No new write operations should be attempted until this bit is clear September 05 2012 6 2 2 14 6 2 2 15 6 2 2 16 6 2 3 6 2 3 1 EEPROM EEPROM_RC_WRBUSY Definition define EEPROM _RC_WRBUSY Description This return code bit indicates that an attempt was made to read from the EEPROM while a write operation was in progress EEPROMAddrFromBlock Returns the offset address of the first word in an EEPROM block Definition define EEPROMAddrFromBlock ulBlock Parameters ulBlock is the index of the EEPROM block whose first word address is to be returned Description This macro may be used to determine the address of the first word in a given EEPROM block The address returned is expressed as a byte offset from the base of EEPROM storage Returns Returns the address of the first word in the given EEPROM block
340. figure and QEIEnable Returns None September 05 2012 331 Quadrature Encoder QE 22 2 2 17 QElVelocityGet 22 3 332 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 function 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 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 as 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 Tf QETEnable QEI_BASE Delay for some time Read the encoder position QETPosit
341. fore using any of the RTC features of the Hibernation module Returns None 13 2 2 24 HibernateRTCGet Gets the value of the real time clock RTC counter Prototype unsigned long HibernateRTCGet void Description This function gets the value of the RTC and returns it to the caller Returns Returns the value of the RTC counter in seconds 13 2 2 25 HibernateRTCMatchOGet Gets the value of the RTC match 0 register Prototype unsigned long HibernateRTCMat ch0Get void Description This function gets the value of the match 0 register for the RTC Returns Returns the value of the match register 13 2 2 26 HibernateRTCMatchOSet Sets the value of the RTC match 0 register 192 September 05 2012 Hibernation Module Prototype void HibernateRTCMatch0OSet unsigned long ulMatch Parameters ulMatch is the value for the match register Description This function sets the match 0 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 Returns None 13 2 2 27 HibernateRTCMatch1 Get Gets the value of the RTC match 1 register Prototype unsigned long HibernateRTCMatch1Get void Description This function gets the value of the match 1 register for the RTC Note The Hibernation RTC Match 1 feature is not available on all Stellaris devices Please consult the d
342. functions Status and initialization functions for the lI2C modules are l2CMasterlnitExpClk I2CMasterEnable 12CMasterDisable 2CMasterBusBusy 12CMasterBusy 2CMasterErr I2CSlavelnit 2CSlaveEnable 2CSlaveDisable and I2CSlaveStatus Sending and receiving data from the I2C 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 I2CMasterInitExpClk 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 September 05 2012 203 Inter Integrated Circuit 12C 14 2 2 14 2 2 1 14 2 2 2 204 Function Documentation I2CIntRegister Registers an interrupt handler for the 12C module Prototype void I2CIntRegister unsigned long ulBase void pfnHandler void 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 function sets the handler to be called when an 12C interrupt occurs This function en ables the global interrupt in the interrupt controller specific 12C interrupts must be enabled via 12CMast
343. g timer is enabled and false if it is not 508 September 05 2012 Watchdog Timer 31 2 2 15 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 31 2 2 16 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 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 instead expires 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 31 2 2 17 WatchdogUnlock Disables the watchdog timer lock mechanism Prototype void WatchdogUnlock unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module September 05 2012 509 Watchdog Timer D
344. g ulPWMOutBits tBoolean bFault Suppress void PWMOuitputFaultLevel unsigned long ulBase unsigned long ulPWMOutBits tBoolean bDriveHigh void PWMOuiputlnvert unsigned long ulBase unsigned long ulPWMOutBits tBoolean bln vert void PWMOuitputState unsigned long ulBase unsigned long ulPWMOutBits tBoolean bEn able unsigned long PWMPulseWidthGet 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 functions perform high level operations on 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 pulse width and controlling interrupts triggers and output characteristics However the PWM module is very versatile and can be configured in a number of different ways many of which are September 05 2012 21 2 2 21 2 2 1 21 2 2 2 Pulse Width Modulator PWM 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 a
345. g 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 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 function cannot be used to turn any pin into a USB pin it only configures a USB pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 39 GPIOPinTypeUSBDigital 174 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 c
346. ge 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 structure is selected This function looks for the UDMA_PRI_SELECT and UDMA_ALT_SELECT flag along with the channel number and sets 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 does not begin until the channel has been configured and enabled Note that the channel is automatically disabled after the transfer is completed meaning that UDMAChanne IEnable 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 are unpredictable including the possibility of undesired data transfers to or from mem ory or peripherals For BASIC and AUTO modes it is safe to make changes when the channel is disabled or the uUDMAChannelModeGet returns UDMA_MODE_STOP For PINGPONG 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 returns UDMA_MODE_STOP when a channel control structure is inactive and safe to modify Returns None 29 2 3 16 uDMAControlA
347. ght sample with the upper 16 bits unused If there is no room in the transmit FIFO then this function waits in a polling loop until the data can be written Returns None September 05 2012 233 Inter IC Sound 12S 15 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 I2S 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 128 MODE_DUAL_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 126 MODE_COMPACT_STEREO_16 or I28_ MODE_COMPACT_STEREO_8 then the ulData parameter contains both the left and right samples If the transmit mode is 12S 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
348. ging m FAN_CONFIG_AVG_4 to select 4 pulses for speed averaging FAN_CONFIG_AVG_8 to select 8 pulses for speed averaging One of the following to select the tachometer pulses per revolution FAN_CONFIG_TACH_1 to select 1 pulse per revolution FAN_CONFIG_TACH_2 to select 2 pulses per revolution FAN_CONFIG_TACH_4 to select 4 pulses per revolution FAN_CONFIG_TACH_8 to select 8 pulses per revolution Returns None FanChannelDisable Disables a FAN channel Prototype void FanChannelDisable unsigned long ulBase unsigned long ulChannel Parameters ulBase is the base address of the FAN module ulChannel is the FAN channel to disable Description This function disables the specified FAN channel for operation Returns None September 05 2012 127 Fan Controller 9 2 2 4 9 2 2 5 9 2 2 6 128 FanChannelDutyGet Reads the duty cycle of a FAN channel Prototype unsigned long FanChannelDutyGet unsigned long ulBase unsigned long ulChannel Parameters ulBase is the base address of the FAN module ulChannel is the FAN channel to query for duty cycle Description This function reads the duty cycle of a FAN channel If the channel is in manual mode then this is the value that was programmed If the FAN channel is configured for automatic mode then this is the value that is calculated by the Fan Control peripheral Returns Returns the FAN channel duty cycle as a number of clocks fr
349. gned char ucAddrNum unsigned char ucSlaveAddr unsigned long 2CSlaveDataGet unsigned long ulBase void I2CSlaveDataPut unsigned long ulBase unsigned char ucData void I2CSlaveDisable unsigned long ulBase void 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 2CSlavelntStatus unsigned long ulBase tBoolean bMasked unsigned long 2CSlavelntStatusEx unsigned long ulBase tBoolean bMasked unsigned long I 2CSlaveStatus unsigned long ulBase 14 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 l2CIntUnregister I2CMasterIntEnable 2CMasterIntDisable l12CMasterlntClear l2CMasterlIntStatus I2CSlavelntEnable I2CSlavelntDisable I2CSlavelntClear I2CSlavelntStatus I2CSlavelntEnableEx 12CSlavelntDisableEx 12CSlavelntClearEx and I2CSlavelntStatusEx
350. gs parameter has the same definition as in the CANIntEnable function Returns None CANIntEnable Enables individual CAN controller interrupt sources Prototype void CANIntEnable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base address of the CAN controller September 05 2012 Controller Area Network CAN ullntFlags is the bit mask of the interrupt sources to be enabled Description This function enables specific interrupt sources of the CAN controller Only enabled sources 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 object 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 generates an interrupt under quite a few status conditions and may pro vide more interrupts than the application needs to handle When an interrupt occurs use CANIntStatus to determine the cause Returns None 5 2 5 11 CANInt
351. h 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 TimerControlEvent Controls the event type Prototype void TimerControlEvent unsigned long ulBase unsigned long ulTimer unsigned long ulEvent 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 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 configures the signal edge s that triggers the timer when in capture mode Returns None TimerControlLevel Controls the output level Prototype void TimerControlLevel unsigned long ulBase unsigned long ulTimer tBoolean biInvert September 05 2012 27 2 2 4 27 2 2 5 Timer 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 configures the PWM output level for the specified timer If the binvert parameter is true then the timer s output is made active low otherwise it is made active high Returns None TimerControlStall Controls the stall handling Prototy
352. hdog Timer TOUS aneia aa aa Eaa nbd dba ding Sed adin abide here dauiben cad eheaee 501 Pr PMC HONS 6 tancaee ec aah owas caiman es CS sent ca eas oe eda been aed en ues beaen et Oreer ee 501 Programming ERIN DIE ccc sarnrenaeceiapisen edd camcagemerertGagenecEsepesarsouquenecseabedeoreennacden 510 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 A watchdog timer module s function is to prevent system hangs The watchdog timer module con sists 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 after its first timeout and to generate a reset signal after its second timeout The watchdog timer module generates the first timeout signal when the 32 bit counter reaches the zero state after being enabled enabling 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 counting down from that value If the timer counts down to its zero state again b
353. he always trigger if their priority is too high it is possible to starve the lower priority sequencers Hardware oversampling of the ADC data is available for improved accuracy An oversampling factor of 2x 4x 8x 16x 32x or 64x is supported but reduces the throughput of the ADC by a corre sponding factor Hardware oversampling is applied uniformly across all sample sequencers Software oversampling of the ADC data is also available even when hardware oversampling is available An oversampling factor of 2x 4x or 8x is supported but reduces the depth of the sample sequencers by a corresponding amount For example the first sample sequencer captures eight samples in 4x oversampling mode it can only capture two samples because the first four samples are used for 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 sequencer basis A more sophisticated software oversampling can be used to eliminate the reduction of the sample sequencer 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 sequencer capability In this case an increase in the number of ADC triggers and presumably ADC interrupts is the conse quence Because this method requires adjustments outside of the ADC driver itself it is not directly supporte
354. he 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 IntlsEnabled Returns if a peripheral interrupt is enabled Prototype unsigned long IntIsEnabled unsigned long ulInterrupt September 05 2012 243 Interrupt Controller NVIC 16 2 2 4 16 2 2 5 244 Parameters ullnterrupt specifies the interrupt to check Description This function checks if the specified interrupt is enabled in the interrupt controller Returns A non zero value if the interrupt is enabled IntMasterDisable Disables the processor interrupt Prototype tBoolean IntMasterDisable void Description This function prevents the processor from receiving interrupts This function does not affect the set of interrupts enabled in t
355. he 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 occurs in this case The solution is to include hw_t ypes 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 This function allows the processor to respond to interrupts This function 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 occurs in this case The solution is to include hw_t ypes h before including interrupt h September 05 2012 16 2 2 6 16 2 2 7 16 2 2 8 Interrupt Controller NVIC Returns Returns true if interrupts were disabled when the function was called or false if they were initially enabled IntPendClear Un pends an interrupt Prototype void IntPendClear unsig
356. he 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 PinTypeUART Configures the specified UART pin to function as a UART pin Prototype void PinTypeUART unsigned long ulName September 05 2012 Peripheral Pin Mapping 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 20 2 2 12 PinTypeUSBDigital 20 3 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 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 Programming Example This example shows the difference in code when configuring a PWM pin on two different parts in the sam
357. he 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 automati cally transmits any pending frames and processes 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 xpulRxCount unsigned long xpulTxCount Parameters 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 This function 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 September 05 2012 5 2 5 7 5 2 5 8 Controller Area Network CAN passive limit The values of the receive and transmit erro
358. he 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 Because the FIFO always deals with sample pairs normally the level is 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 is 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 is normally an even number 15 2 2 22 I2STxFIFOLimitGet Gets the current setting of the FIFO service request level Prototype unsigned long I2STxFIFOLimitGet unsigned long ulBase Parameters ulBase is the 2S module base address September 05 2012 235 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 15 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 2S module base address ulLevel is the FIFO service request limit Description Th
359. he ulFlags parameter can take the value returned from the USBEndpointStatus call Note This function should only be called in host mode Returns None 30 3 2 32 USBHostHubAddrGet 484 Gets 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 returns 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 September 05 2012 USB Controller 30 3 2 33 USBHostHubAddrSet Sets the hub address for the device that is connected to an endpoint 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 ulAdar is the hub address and port for the device using this endpoint The hub address must be defined in bits 8 through 15 with the port number in bits 0 through 6 ulFlags deter
360. hen only when the hibernation module has been enabled The precision internal oscillator can be powered down in deep sleep mode by specifying SYSCTL_DSLP_PIOSC_PD The precision internal oscillator is not powered down if it is re quired for operation while in deep sleep based on other configuration settings Note The availability of deep sleep clocking configuration varies with the Stellaris part in use Please consult the data sheet for the part you are using to determine whether this support is available Returns None SysCtIDelay 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 September 05 2012 System Control 24 2 2 10 SysCtlFlashSizeGet 24 2 2 11 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 SysCtIGPIOAHBDisable Disables a GPIO peripheral for access from the AHB Prototype void SysCt1GPIOAHBDisable unsigned long ulGPIOPeripheral Parameters ulGP IOPe
361. hernetMACAddrSet function this API function can be called to enable the controller for normal operation September 05 2012 7 2 2 5 7 2 2 6 Ethernet Controller This function enables the controller s transmitter and receiver and resets the receive FIFO Returns None EthernetInitExpClk Initializes the Ethernet controller for operation Prototype void Ethernet InitExpClk unsigned long ulBase unsigned long ulEthClk Parameters ulBase is the base address of the controller ulEthClk is the rate of the clock supplied to the Ethernet module Description This function prepares 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 is the same as the processor clock This value is returned by SysCtIClock Get 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 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 be reinitialized by calling the Ether
362. hip pull ups This function should only be used with EPEN and PFAULT pins as all other USB pins are analog in nature or are not used in devices without OTG functionality 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 September 05 2012 GPIO Note This function cannot be used to turn any pin into a USB pin it only configures a USB pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 40 GPIOPinWrite 12 2 2 41 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 GPIOPortIntRegis
363. ib systick h void SetupSysTick void SysTickPeriodSet 0x1000 SysTickEnable When built for a device that has a ROM however this example is equivalent to include driverlib rom h include driverlib systick h void SetupSysTick void ROM_SysTickPeriodSet 0x1000 ROM_SysTickEnable 32 4 Firmware Update Functions m void ROM_Updatel2C void void ROM_UpdateSSI void m void ROM_UpdateUART void 32 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 because 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 the specific device for details of the firmware update APIs in the ROM September 05 2012 515 Using the ROM 32 4 2 32 4 2 1 32 4 2 2 32 4 2 3 Function Documentation 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 I2CO 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
364. icate 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 September 05 2012 71 Controller Area Network CAN 72 September 05 2012 6 6 1 6 1 1 EEPROM EEPROM MOGUCOM aeania aa a aa aa a a hata aenesae eE PP M A ETE iss coh E EE E E AN EA EA E E T oe E A E A L AE ANNT T 74 Pregramnimng Exame sorreta enrere E E E R 88 Introduction The EEPROM API provides a set of functions for interacting with the on chip EEPROM providing easy to use non volatile data storage Functions are provided to program and erase the EEPROM configure the EEPROM protection and handle the EEPROM interrupt The EEPROM can be programmed on a word by word basis and unlike flash the application need not explicitly erase a word or page before writing a new value to it The EEPROM controller has the ability to generate an interrupt when an invalid access is attempted such as reading from a protected block This interrupt can be used to validate the operation of a program the interrupt prevents invalid accesses from being silently ignored hidi
365. ies the PECI module base address ullntFlags is a bit mask of the interrupt sources to be disabled Description This function disables the indicated PECI 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 following values PECI_READ PECI_ERR PECI_AC PECI_MODO PECI_MO0D1 PECI_M1D0 or PECI_M1D1 Returns None 19 2 1 18 PEClIntEnable Enables individual PECI interrupt sources Prototype void PECIIntEnable unsigned long ulBase 290 September 05 2012 Platform Environment Control Interface PECI unsigned long ulIntFlags unsigned long ulIntMode Parameters ulBase specifies the PECI module base address ullntFlags is a bit mask of the interrupt sources to be enabled ullntMode is the mode for the PECI domain interrupts Description This function enables the indicated PECI 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 following values PECI_READ PECI_ERR PECI_AC PECI_MODO PECI_M0D1 PECI_M1D0 or PECI_M1D1 The ullntMode parameter is used to configure the interrupt mode for the corresponding PECI_DOMAIN_MnDm field and can be any of the following values PECILMODO_MODE1 PECI_MODO_MODE2 PECI_MOD0_MODE3 PECI_M0D1_MODE
366. ified 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 28 2 2 33 UARTIntUnregister 426 Unregisters an interrupt handler for a UART interrupt Prototype void UARTIntUnregister unsigned long ulBase September 05 2012 UART Parameters ulBase is the base address of the UART port Description This function does the actual unregistering of the interrupt handler It clears the handler to be called when a UART interrupt occurs This function also masks 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 28 2 2 34 UARTModemControlClear Clears the states of the DTR and or RTS modem control signals Prototype void UARTModemControlClear unsigned long ulBase unsigned long ulControl 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 This function 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 m UART_OUTPUT_RTS The Mode
367. igned 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 September 05 2012 115 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 8 2 2 14 EPllntUnregister Unregisters an interrupt handler for the EPI module Prototype void EPIIntUnregister unsigned long ulBase Parameters ulBase is the EPI module base address Description This function disables and clears the handler to be called when the EPI interrupt occurs See also IntRegister for important information about registering interrupt handlers Returns None 8 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 EPl_MODE_GENERAL use for general purpose mode operation EPl_MODE_SDRANM use with SDRAM device EPl_MODE_
368. imer 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 func tion must be called in the interrupt handler to keep the interrupt from being triggered again immediately upon exit The ullntFlags parameter has the same definition as the ullntFlags parameter to Timer ntEn able Note Because there is a write buffer in the Cortex M processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt September 05 2012 395 Timer 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 2 7 2 2 10 TimerlntDisable 27 2 2 11 396 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
369. in two different modes count down mode or count up down mode In count down mode it counts from a value down to zero and then resets to the preset value producing left aligned PWM signals that is the rising edge of the two PWM signals produced by the generator occur at the same time In count up down mode it counts up from zero to the preset value counts back down to zero and then repeats the process producing center aligned PWM signals that is the middle of the high low period of the PWM signals produced by the generator occurs at the same time When the PWM generator parameters period and pulse width are modified their effect on the output PWM signals can be delayed In synchronous mode the parameter updates are not applied until a synchronization event occurs This mode allows multiple parameters to be modified and take effect 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 paus
370. inEnable Enables a domain within the PECI module Prototype void PECIDomainEnable unsigned long ulBase unsigned long ulDomain Parameters ulBase is the base address of the PECI module ulDomain is the PECI domain that should be enabled September 05 2012 287 Platform Environment Control Interface PECI Description This function enables the specified PECI domain for temperature monitoring operations The u Domain parameter can be one of the following values PECI_DOMAIN_MODO PECI_DOMAIN_M0D1 PECI_DOMAIN_M1D0 or PECL DOMAIN_M1D1 Returns None 19 2 1 12 PECIDomainMaxReadClear Clears the maximum error value for the specified domain Prototype void PECIDomainMaxReadClear unsigned long ulBase unsigned long ulDomain Parameters ulBase is the base address of the PECI module ulDomain is the PECI domain that should be disabled Description This function clears the maximum temperature measurement value for the specified domain The u Domain parameter can be one of the following values PECI_DOMAIN_MODO PECI_DOMAIN_M0D1 PECI_DOMAIN_M1D0 or PECL DOMAIN_M1D1 Returns None 19 2 1 13 PECIDomainMaxReadGet Reads the maximum error value for the specified domain Prototype unsigned long PECIDomainMaxReadGet unsigned long ulBase unsigned long ulDomain Parameters ulBase is the base address of the PECI module ulDomain is the PECI domain that shoul
371. inTypeGPlOOutputOD 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 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 12 2 2 27 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 September 05 2012 167 GPIO 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 bit 1 represents GPIO port pin 1 and
372. inanesanmmpinereniea ors separ aA E EEE 13 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 direct 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 a
373. 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 September 05 2012 323 Quadrature Encoder QE 22 2 22 2 1 22 2 2 22 2 2 1 324 API Functions Functions void QElIConfigure unsigned long ulBase unsigned long ulConfig unsigned long ulMaxPosi tion long QEI DirectionGet unsigned long 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 u
374. ing 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 disables hardware oversam pling 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 sequencer 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 K samples second ADC to 62 5 K samples second Returns None September 05 2012 29 Analog to Digital Converter ADC 4 2 2 9 4 2 2 10 30 ADClIntClear Clears sample sequence interrupt source Prototype void ADCIntClear unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base 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 func tion must be called in the interrupt handler to keep the interrupt from being triggered again immediately upon exit Note Because there is a write buffer in the Cortex M processor it may take several cloc
375. ing the 12C Slave block The parameter ucSlaveAdar is the value that is compared against the slave address sent by an I2C master 216 September 05 2012 Inter Integrated Circuit 12C Returns None 14 2 2 31 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 function must be called in the interrupt handler to keep the interrupt from being triggered again immediately upon exit Note Because there is a write buffer in the Cortex M 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 14 2 2 32 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 clear
376. ing this mode because during the fault signal period the fault interrupt from the PWM generator remains asserted The fault interrupt handler may therefore reenter immediately if it exits prior to expiration of the fault timer Note Changes to the counter mode affect the period of the PWM signals produced PWMGenPeri odSet and PWMPulseWidthSet should be called after any changes to the counter mode of a generator September 05 2012 307 Pulse Width Modulator PWM 21 2 2 8 21 2 2 9 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 This parameter must be one of PWM_GEN_0O 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 This parameter must be one of PWM_GEN_0O 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 21 2 2 1
377. input clock prescaler The prescaler is only operational when in half width mode and is used to extend the range of the half width timer modes The prescaler provides the least significant bits when counting down in periodic and one shot modes in all other modes the prescaler provides the most significant bits Note The availability of the prescaler varies with the Stellaris part and timer mode in use Please consult the datasheet for the part you are using to determine whether this support is available Returns The value of the timer prescaler 27 2 2 24 TimerPrescaleMatchGet Get the timer prescale match value Prototype unsigned long TimerPrescaleMatchGet 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 402 September 05 2012 Timer Description This function gets the value of the input clock prescaler match value When in a half width mode that uses the counter match and prescaler the prescale match effectively extends the range of the match The prescaler provides the least significant bits when counting down in periodic and one shot modes in all other modes the prescaler provides the most significant bits Note The availability of the prescaler match varies with the Stellaris part and timer mode in use Please consult the datasheet for the part you are using to determine whether thi
378. interrupt occurs See also IntRegister for important information about registering interrupt handlers Returns None September 05 2012 227 Inter IC Sound 12S 15 2 2 7 15 2 2 8 228 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 12S master clock The transmit and receive modules can be configured independently The u MClock parameter 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 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_JU
379. ion 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 September 05 2012 8 2 2 12 8 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 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 uns
380. ion 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 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 ref
381. ion 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 September 05 2012 45 Controller Area Network CAN 46 CAN_STATUS_LEC_FORM CAN_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 Fun
382. ion should only be called in device mode Returns The current device address USBDevAdadrSet Sets the address in device mode September 05 2012 30 3 2 3 30 3 2 4 USB Controller 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 configures 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 causes the soft connect feature of the USB controller to be enabled Call USB DevDisconnect to remove the USB device from the bus Note This function should only be called in device mode Returns None 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 September 05 2012 467 USB Controller 30 3 2 5 30 3 2 6 468 Description This function causes the soft connect feature of the USB controller to remove the device from the USB bus A call
383. ionGet QEI_BASE September 05 2012 23 23 1 23 2 Synchronous Serial Interface SS Synchronous Serial Interface SSI POCUT anea aaa a debeh aad ine De adh abe bene D aoe APIF ROIS 6 tanec ee ec aek oleate aieca te bh sunt ca aes a beeen eee eal eue edie eens 333 Programming Example ccc sonnrenaegeiapisenedd camtagemeegntbagennecEsepesarsouquaneceeabedsqnememadaas 343 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 size 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 m
384. is defined The valid names for the pins are as follows LEDO or LED1 sa GPIOPinTypeEthernetLED in order to configure multiple Ethernet LED pins at once Returns None PinTypel2C Configures the specified 12C pin to function as an I2C pin Prototype void PinTypel2C 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 September 05 2012 20 2 2 7 20 2 2 8 20 2 2 9 Peripheral Pin Mapping 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 PinTypeQEI Configures the specified QEI pin to function as a QEI pin Prototype void PinTypeQEI unsigned long u
385. is function is used to set the transmit FIFO fullness level at which a service request occurs The service request is used to generate an interrupt or a DMA transfer request The transmit FIFO generates a service request when the number of items in the FIFO is less than the level specified in the ulLevel parameter For example if u Level is 8 then a service request is 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 Because the FIFO always deals with sample pairs the level must be an even number from 0 to 16 The maximum value is 16 which causes a service request when there is any room in the FIFO The minimum value is 0 which disables the service request Returns None 15 2 2 24 I2STxRxConfigSet 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 236 September 05 2012 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 o
386. is or made active high Returns None 21 2 2 29 PWMOutputState Enables or disables PWM outputs 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 This parameter 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 bEnable determines if the signal is enabled or disabled September 05 2012 319 Pulse Width Modulator PWM Description This function enables or disables the selected PWM outputs The outputs are selected using the parameter u PWMOutBits The parameter bEnable determines the state of the selected 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 21 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 This parameter must be one of PWM_OUT_0O 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 puls
387. is 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 to send the ADC sample to the selected comparator using ADC_CTL_CMP0O through ADC_CTL_CMP7 The configuration is used by the ADC at the appropriate time when the trigger for this sequence occurs Note If the Digital Comparator is present and enabled using the ADC_CTL_CMPO through ADC_CTL_CMP7 selects the ADC sample is NOT 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 sequencer from zero to three for the second and third sample sequencer and can only be zero for the fourth sample sequencer Differential mode only works with adjacent channel pairs for example 0 and 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 are returned by the ADC Additionally if differential mode is selected when the temperature sensor is being sampled undefined results are 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
388. it 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 September 05 2012 49 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 50 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 Description 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 September 05 2012 5 2 3 6 5 2 3 7 5 2 3 8 5 2 3 9 5 2 3 10 5 2 3 11
389. its resets 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 can run on more than one member of the Stellaris family The device can be clocked from several sources an external oscillator the main oscillator the internal oscillator the precision internal oscillator PIOSC or the PLL The PIOSC is not available on all Stellaris devices The PLL can use any of the oscillators as its input Because 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 that are specified in the device data sheet 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 frequency of the internal oscillator varies by device with voltage and with temperature The internal oscillator provides no
390. k 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 ADClntDisable 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 September 05 2012 42201 4 2 2 12 Analog to Digital Converter ADC ADClIntEnable Enables a sample sequence interrupt Prototype void ADCIntEnable 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 interrupt Any outstanding interrupts are cleared before enabling the sample sequence interrupt Returns None ADCIntRegister Registers an interrupt handler for an ADC interrupt Prototype void ADCIntRegister unsigned long ulBase un
391. l ing The default setting is the IEEE format Note Unless this function is called prior to executing any floating point instructions the default mode is used Returns None FPULazyStackingEnable Enables the lazy stacking of floating point registers Prototype void FPULazyStackingEnable void Description This function enables the lazy stacking of floating point registers sO s15 when an interrupt is handled When lazy stacking is enabled space is reserved on the stack for the floating point context but the floating point state is not saved If a floating point instruction is executed from within the interrupt context the floating point context is first saved into the space reserved on the stack On completion of the interrupt handler the floating point context is only restored if it was saved as the result of executing a floating point instruction This method provides a compromise between fast interrupt response because the floating point state is not saved on interrupt entry and the ability to use floating point in interrupt han dlers because the floating point state is saved if floating point instructions are used Returns None FPUNaNModeSet Selects the NaN mode Prototype void FPUNaNModeSet unsigned long ulMode Parameters ulMode is the mode for NaN results which is either FPULNAN PROPAGATE or FPU_NAN_DEFAULT Description This function selects the handling of NaN results during floa
392. l 2CMasterInit API and performs the same actions A macro is provided in i2c h to map the original API to this API Returns None 14 2 2 12 2CMasterlntClear 208 Clears 12C 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 function must be called in the interrupt handler to keep the interrupt from being triggered again immediately upon exit Note Because there is a write buffer in the Cortex M processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt September 05 2012 Inter Integrated Circuit 12C 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 14 2 2 13 2CMasterlIntClearEx Clears 12C Master interrupt sources Prototype void I2CMasterIntClearEx unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the base address of the I2C Master module ullntFlags is a bit mask of the interrupt sources
393. lBase 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 QE 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 September 05 2012 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 function configures the operation of the quadrature encoder The u
394. lGen unsigned long ulGroup Parameters ulBase is the base address of the PWM module ulGen is the PWM generator for which fault triggers are being queried This parameter 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 parameter must be PWM_FAULT_GROUP_0 or PWM_FAULT_GROUP_1 Description This function allows an application to query the current set of inputs that contribute to 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_0 the returned value is 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 is the logical OR of PWM_FAULT_DCMPO PWM_FAULT_DCMP1 PWM_FAULT_DCMP2 PWM_FAULT_DCMP3 PWM_FAULT_DCMP4 PWM_FAULT_DCMP5 PWM_FAULT_DCMP6 or PWM_FAULT_DCMP7 21 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 for which fault triggers are being set This parameter must be on
395. lLDOGet 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 The brown out reset is configured with SysCtlIBrownOutConfigSet The clock verification timers are managed with SysCtllOSCVerificationSet SysCtIMOSCVerifica tionSet SysCtIPLLVerificationSet and SysCtlClkVerificationClear Function Documentation SysCtIADCSpeedGet Gets the sample rate 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 is one of SYSCTL_ADCSPEED_1MSPS SYSCTL_ADCSPEED_500KSPS SYSCTL_ADCSPEED_250KSPS or SYSCTL_ADCSPEED_125KSPS SysCtIADCSpeedSet 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 configures 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 SysCtLADCSpeedGet returns the actual speed in use Returns None September 05 2012 24 2 2 3 24 2 2 4 24 2 2
396. lName 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 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 September 05 2012 297 Peripheral Pin Mapping 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 20 2 2 10 PinTypeTimer 20 2 2 11 298 Configures the specified Timer pin to function as a Timer pin 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 t
397. lPeripheralSleepDisable SysCtlPeripheralDeepSleepEnable and SysCtlPeripheralDeepSleepDisable Returns None September 05 2012 24 2 2 27 SysCtlPeripheralDeepSleepDisable Disables a peripheral in deep sleep mode Prototype void System Control SysCtlPeripheralDeepSleepDisable unsigned long u Parameters ulPeripheral is the peripheral to disable in deep sleep mode Description This function causes a peripheral to stop operating when the pro mode Disabling peripherals while in deep sleep mode helps to 1Peripheral cessor goes into deep sleep ower 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 SysCtlPeripheralEn able the peripheral automatically resumes 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 follow ing values SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_CANO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP0 SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_EEPROMO SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_FANO SYSCTL_PERIPH_GPIOA SYS
398. lUser1 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 reads the contents of user registers 0 and 1 and stores them in the specified locations Returns Returns 0 on success or 1 if a hardware error is encountered 10 2 2 15 FlashUserSave Saves the user registers Prototype long FlashUserSave void Description This function makes the currently programmed user register settings permanent On some devices this operation is non reversible a chip reset or power cycle does not change this setting This function does not return until the protection has been saved Returns Returns 0 on success or 1 if a hardware error is encountered 10 2 2 16 FlashUserSet Sets the user registers Prototype long FlashUserSet unsigned long ulUser0O unsigned long ulUserl1 142 September 05 2012 10 3 Flash Parameters ulUser0 is the value to store in USER Register 0 ulUser7 is the value to store in USER Register 1 Description This function sets the contents of the user registers 0 and 1 to the specified values Returns Returns 0 on success or 1 if a hardware error is encountered Programming Example The following example shows how to use the flash API to erase a block of the flash and program a few words unsigned long pulData 2 Set the uSec value to 2
399. le 13 Hibernation Module IUCN E e ATEETAN P pid ET A E adn h A S balsas Lh keane 179 AP PONCHO chceccc daa vencranietneheal welt ewsriaekdd gual aaa A SSe 179 Pregrammmg REIN DIE ccc sannreaeceinpiseaaddcamtagemerertbagenecEsepesarsouquenecseebedeeieaemaddas 197 13 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 remove power from the microcontroller and then be powered on later based on specific time or when the external WAKE pin is asserted 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 with 15 bit subseconds counter on some devices Trim register for fine tuning the RTC rate One or two RTC match registers for generating RTC events External WAKE pin to initiate a wake up Low battery detection m 16 or 64 32 bit words of battery backed 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 13 2 API Functions Functions unsigned long HibernateBatCheckDone void void HibernateBatCheckStart void void HibernateClockConfig unsigned long ulConfig void Hibernat
400. le 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 I28_ MODE_COMPACT_STEREO 8 then the received data contains both the left and right samples If the receive mode is 128 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 returns immediately without reading any data from the FIFO Returns The number of elements read from the 12S receive FIFO 1 or 0 15 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 is clocked in regardless of the signals on the 12S interface Returns None 15 2 2 12 2SRxEnable 230 Enables the I2S receive module for operation Prototype void I2SRxEnable
401. le 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 such as the ADC module used to capture real time analog data September 05 2012 13 Programming Model 14 September 05 2012 3 1 3 2 3 2 1 Analog Comparator Analog Comparator DRT HON wack calico tdatanse a daa paliniddebadan age aces Gdbeiebi aa a daa eect sanaanee 15 a M A E E A E E A EE ANE AT E A E N A EN A EE A EEE AES T E a AT 15 Pregramnimmng ExamMPS sorrerari onrera E E Rai 2j Introduction The comparator API provides a set of functions for programming and using the analog comparators A comparator can compare a test voltag
402. le ee ee Ew ER eS 301 Programming Example s esasa RES Se i PE See EEE Ee we eS 322 Quadrature Encoder QEl 0000 eee eee ee ee ee ee 323 IMROOMCHON e Gao ee BRR Ree ee GS SEER ELE ESR REERGEH EER R ROG EATERS 323 AP PUGS 6864 a eta oO 4 AM ee RR Oe ah ee a A 324 Programming Example vb PAAR OED REE REESE ERE ES RH HAE BR REY 332 Synchronous Serial Interface SSI 2 0 0 2 000 eee es 333 WI OMBNON Gia a Bd en oe oe ee SORE Eee eda ha ane Dee eed SSS eR E 333 APU PUGS a ele ee ee ee OD RN AD ee ee ea a oe ee 333 Programming Example gt kb ee oe Ee Re ee Se eee REE BREE a eR OS 343 SysleMm GNON o ee ee re eee el ee ee ene ee eee E 345 IM OUO MOR a ae eRe eae e CE Oe ee ee eee a ee Sw ER Oe eee eee EE es 345 September 05 2012 Table of Contents 24 2 API FUNCIONS 4 44428 28 60nd b Hee ee ae be Shea ee ee bk ea amp 346 24 3 Frogramming Example oo pe de Se ee a ed One Dobe eee Me eee 376 25 System Exception Module 0 0 00 ce es 377 oc UPOOURWON da oe eee ee Ra Oe RR RE a ee eee dha ae See es 377 25 2 API FURCIONS o oe ca 622 2 a ee Gas Se Saba eae eos ee eh ged He a aa 377 25 3 Frogramming Example in kk a er em Re ae Gel ol ae 380 26 System Tick SysTlek lt sec oeae a a we ee eee 383 Soc WOOUCION 2b ee hha aa Sk ea RR RRA we ee hak eR aes amp bee ece 4 383 20 2 API FUNCIONS 4 4 4 4 dee es ede chk Hien iwi ala aga chao b hod eee dG wae wo 383 26 0 Programming Example lt isss esa waea a a ee ee
403. led by the hard ware 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 September 05 2012 423 UART Note The 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 None 28 2 2 28 UARTIntClear Clears UART interrupt sources Prototype void UARTIntClear unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base address of the UART port 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 triggered 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 M 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 immediate
404. ling 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 writes 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 is not be affected if an interrupt occurs while the region attributes are being changed The attributes of a region that have 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 takes effect when the region is reloaded When one or more regions are defined the MPU can be enabled by calling MPUEnable This function turns on the MPU and also defines the behavior in privileged mode and in the
405. ll Stellaris devices Please consult the data sheet to determine if the device you are using supports this feature in the Hibernation module Returns None HibernateGPlORetentionGet Returns the current setting for GPIO retention Prototype tBoolean HibernateGPIORetentionGet void Description This function returns the current setting for GPIO retention in the hibernate module Note The hibernation GPIO retention setting is not available on all Stellaris devices Please consult the data sheet to determine if the device you are using supports this feature in the Hibernation module Returns Returns true if GPIO retention is enabled and false if GPIO retention is disabled 13 2 2 12 HibernatelntClear 186 Clears pending interrupts from the Hibernation module Prototype void HibernateIntClear unsigned long ulIntFlags September 05 2012 Hibernation Module Parameters ullntFlags is the bit mask of the interrupts to be cleared Description This function clears the specified interrupt sources This function must be called within the interrupt handler or else the handler is called again upon exit The ul ntFlags parameter has the same definition as the ullntFlags parameter to the Hiber nateIntEnable function Note Because there is a write buffer in the Cortex M processor it may take several clock cycles before the interrupt source is actually cleared Therefore it is recommended that the interrupt
406. ll 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 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 September 05 2012 11 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 ex
407. ller numbers correspond to higher interrupt priorities So for example a priority level mask of 4 allows interrupts of priority level 0 3 and interrupts with a numerical priority of 4 and greater are blocked The hardware priority mechanism only looks 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 16 2 2 12 IntPriorityMaskSet Sets the priority masking level Prototype void IntPriorityMaskSet unsigned long ulPriorityMask Parameters ulPriorityMask is the priority level that is masked Description This function sets the interrupt priority masking level so that all interrupts at the specified or lesser priority level are masked Masking interrupts 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 allows interrupts of priority level 0 3 and interrupts with a numerical priority of 4 and greater are blocked The hardware priority mechanism only looks 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 None 16 2 2 13 IntPrioritySet Sets the priority of an interrupt September 05 2012 247
408. long ulBase Parameters ulBase is the base address of the UART port Description This function enables the SMART control bit for the ISO7816 smart card mode on the UART This call also sets 8 bit word length and even parity as required by SO7816 Note The availability of SIR IrDA operation 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 28 2 2 44 UARTSpaceAvail Determines if there is any space in the transmit FIFO Prototype tBoolean UARTSpaceAvail unsigned long ulBase September 05 2012 431 UART 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 28 2 2 45 UART TxintModeGet 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 is UART_TXINT_MODE_EOT if the transmit interrupt is currently configured to be as serted once the transmitter is completely idle the transmit FIFO is empty and all
409. long ulBase unsigned char pucBuf long IBufLen m long EthernetPacketPutNonBlocking unsigned long ulBase unsigned char pucBuf long IBu fLen September 05 2012 89 Ethernet Controller 7 2 1 90 void EthernetPHYAddrSet unsigned long ulBase unsigned char ucAddr void EthernetPHYPowerOff unsigned long ulBase void EthernetPHYPowerOn unsigned long ulBase unsigned long EthernetPHYRead unsigned long ulBase unsigned char ucRegAddr 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 configures 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 auto negotiates the line speed and duplex modes For most applications this configuration is 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 function allow the configuration of options such as Promiscuous Mode Multicast Reception Transmit Data Length Pa
410. 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 programs a sequence of words into the on chip flash Each word in a page of flash can only be programmed one time between an erase of that page programming a word multiple times results in an unpredictable value in that word of flash Because 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 This function does not return until the data has been programmed September 05 2012 139 Flash Returns Returns 0 on success or 1 if a programming error is encountered 10 2 2 9 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 gets 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 debugge
411. long ulEndpoint unsigned long ulMaxPayload unsigned long ulNAKPolllnterval unsigned long ulTargetEndpoint un signed long ulFlags void USBHostEndpointDataAck unsigned long ulBase unsigned long ulEndpoint void USBHosiEndpointData Toggle unsigned long ulBase unsigned long ulEndpoint tBoolean bDataToggle unsigned long ulFlags void USBHostEndpointStatusClear unsigned long ulBase unsigned long ulEndpoint un signed long ulFlags unsigned long USBHostHubAddrGet unsigned long ulBase unsigned long ulEndpoint un signed long ulFlags void USBHostHubAddrSet unsigned long ulBase unsigned 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 USBHostRequestINClear unsigned long ulBase unsigned long ulEndpoint void USBHostRequestStatus unsigned long ulBase September 05 2012 30 3 1 USB Controller 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
412. lows the DMA controller to begin requesting data to fill the FIFO Example Start the transfer of data on endpoint 1 September 05 2012 USB Controller Configure the address and size of the data to transfer DMAChannelTransferSet DMA_CHANNEL_USBEPI1TX DMA_MODE_BASIC pData USBFIFOAddr USBO_BASE USB_EP_1 64 Start the transfer ff DMAChannelEnable DMA_CHANNEL_USBEPI1TX Because the uDMA interrupt occurs on the same interrupt vector as any other USB interrupt the application must perform an extra check to determine the actual source of the interrupt It is impor tant to note that the DMA interrupt does not mean that the USB transfer is complete but only that the data has been transferred to the USB controller s FIFO There is also an interrupt indicating that the USB transfer is complete However both events must be handled in the same interrupt routine 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 D
413. lternateBaseGet 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 control table that holds the alternate control structures for each channel Returns Returns a pointer to the base address of the second half of the channel control table 29 2 3 17 uDMAControlBaseGet Gets the base address for the channel control table Prototype 452 void gt uDMAControlBaseGet void September 05 2012 uDMA Controller 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 29 2 3 18 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 con trol table Description This function configures 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 configured before any of the channel functions can be used The size of the channel control table depends
414. lue bf Enable the first sample sequencer to capture the value of channel 0 when the processor trigger occurs if 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 ff ADCProcessorTrigger ADCO_BASE 0 Wait until the sample sequence has completed while ADCIntStatus ADCO_BASE 0 false ff Read the value from the ADC ADCSequenceDataGet ADCO_BASE 0 amp ulValue September 05 2012 43 Analog to Digital Converter ADC 44 September 05 2012 5 1 Controller Area Network CAN Controller Area Network CAN ul erot e o IE EE EEE E A TTT E E A A A E A E ETS 45 APIPOMCRONS corrandatda reread o Aa eA aa eeedwess 45 CAN MeSS30e ODECIE soscreruboritipi nt raa O OEE 67 Programming Example coiccranivientccnnnanrrndiennew oni E NEET EE OPEN NRE ER EEE 69 Introduction The Controller Area Network 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 applicat
415. lure codes are logical OR combi nations of EEPROM_RC_INVPL EEPROM_RC_WRBUSY EEPROM_RC_NOPERM EEP ROM_RC_WKCOPY EEPROM_RC_WKERASE and EEPROM_RC_WORKING EEPROMProgramNonBlocking Writes a word to the EEPROM September 05 2012 6 2 3 16 EEPROM Prototype unsigned long EEPROMProgramNonBlocking unsigned long ulData unsigned long ulAddress Parameters ulData is the word to write to the EEPROM ulAddress defines the byte address within the EEPROM to which the data is to be written This value must be a multiple of 4 Description This function is intended to allow EEPROM programming under interrupt control It may be called to start the process of writing a single word of data into the EEPROM at a given word aligned address The call is asynchronous and returna immediately without waiting for the write to complete Completion of the operation is signaled by means of an interrupt from the EEPROM module The EEPROM peripheral shares a single interrupt vector with the flash memory subsystem INT_FLASH Returns Returns status and error information in the form of a logical OR combinations of EEPROM_RC_INVPL EEPROM_RC_WRBUSY EEPROM_RC_NOPERM EEP ROM_RC_WKCOPY EEPROM_RC_WKERASE and EEPROM_RC_WORKING Flags EEPROM_RC_WKCOPY EEPROM_RC_WKERASE and EEPROM_RC_WORKING are expected in normal operation and do not indicate an error EEPROMRead Reads data from the EEPROM Prototype void EEPROMRead unsigned lo
416. ly and execute only blocks cannot be erased This function does 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 September 05 2012 10 2 2 2 10 2 2 3 Flash FlashIntClear Clears flash controller interrupt Sources Prototype void FlashIntClear unsigned long ullIntFlags 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 function must be called in the interrupt handler to keep the interrupt from being triggered again immediately upon exit Note Because there is a write buffer in the Cortex M 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
417. ly reentered because the interrupt controller still sees the interrupt source asserted Returns None 28 2 2 29 UARTIntDisable Disables individual UART interrupt sources Prototype void UARTIntDisable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base address of the UART port ullntFlags is the bit mask of the interrupt sources to be disabled 424 September 05 2012 UART Description This function 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 28 2 2 30 UARTIntEnable Enables individual UART interrupt sources Prototype void UARTIntEnable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase is the base address of the UART port ullntFlags is the bit mask of the interrupt sources to be enabled Description This function 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 ullntFlags parameter is the logical OR of any of the following m UART_INT_9BIT 9 bit Address Match interrupt UART_INT_OE Overrun Error interrupt m UART_INT_BE Break Error interrupt m UART_INT_PE P
418. m 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 28 2 2 35 UARTModemControlGet Gets the states of the DTR and RTS modem control signals Prototype unsigned long UARTModemControlGet unsigned long ulBase September 05 2012 427 UART Parameters ulBase is the base address of the UART port Description This function 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 value is a logical OR combination of values UART_OUTPUT_RTS and UART_OUTPUT_DTR where the presence of each flag indicates that the associated signal is asserted 28 2 2 36 UARTModemControlSet Sets the states of the DTR and or RTS modem control signals Prototype void UARTModemControlSet unsigned long ulBase unsigned long ulControl 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 This function configures the states of the DTR or R
419. mber 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 September 05 2012 41 Analog to Digital Converter ADC 4 2 2 32 4 2 2 33 42 Returns None ADCSoftwareOversampleDataGet Gets the captured data for a sample sequence using software oversampling Prototype void ADCSoftwareOversampleDataGet 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 soft
420. mer lock mechanism Prototype tBoolean WatchdogLockState unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description This function 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 31 2 2 10 WatchdogReloadGet 506 Gets the watchdog timer reload value Prototype unsigned long WatchdogReloadGet unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module September 05 2012 31 2 2 11 Watchdog Timer 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 None WatchdogReloadSet 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 configures 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 is immediately loaded into the watchdog timer counter If the u LoadVal parameter is 0 then an interrupt is immediately generated Note This function has no effect if the wat
421. merB to count both edges TimerControlEvent TIMERO_BASE TIMER_B TIMER_EVENT_BOTH_EDGES Enable the timers TimerEnable TIMERO_BASE TIMER_BOTH September 05 2012 407 Timer 408 September 05 2012 28 28 1 28 2 UART UART WAGON 2232 E E taba nkes iu deceacniieeeenianbelaemias dba ea a aw bonnes T EA E EEA ET 409 APURO HONS saae naaa hed Gl dod Se alae gad ehh due waighilala didn oO ba tabs 409 Programing Example nce cious icaeiin othaenedu Se tacedsus deena ia bee hes Gieie Mie eotyenes eases 433 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 functionality 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 Automatic generation and stripping of start stop and parity bits Line break generation and detection 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
422. merRTCDisable Timer content is managed with TimerLoadSet TimerLoadGet TimerLoadSet64 TimerLoad Get64 TimerPrescaleSet TimerPrescaleGet TimerMatchSet TimerMatchGet Timer MatchSet64 TimerMatchGet64 TimerPrescaleMatchSet TimerPrescaleMatchGet Timer ValueGet TimerValueGet64 and TimerSynchronize The interrupt handler for the Timer interrupt is managed with TimerlntRegister and TimerlIntUnreg ister The individual interrupt sources within the timer module are managed with TimerlntEnable Timer ntDisable TimerIntStatus and TimerIntClear 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 Function Documentation 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 timer can be configured to be a single full width timer by using the TIMER_CFG_ values or a pair of half width timers using the TIMER_CFG_A_ and TIMER_CFG_B_ values passed in the u Config parameter The configuration is specified in
423. meter bDriveHigh determines the output level for the pins identified by ulPWMOutBits If bDriveHigh is true then the selected outputs are driven high when a fault is detected If it is false the pins are 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 318 September 05 2012 Pulse Width Modulator PWM Note This function is available only on devices which support extended PWM fault handling Returns None 21 2 2 28 PWMOutputlnvert Selects the inversion mode for PWM outputs Prototype void PWMOutputiInvert unsigned long ulBase unsigned long ulPWMOutBits tBoolean bInvert Parameters ulBase is the base address of the PWM module ulPWMOutBits are the PWM outputs to be modified This parameter 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 binvert determines the inver sion mode for the selected outputs If b nvert is true this function causes the specified PWM output signals to be inverted or made active low If binvert is false the specified outputs are passed through as
424. meter is USB_EP_DEV_OUT then the stall is cleared on the OUT portion of this endpoint Note This function should only be called in device mode Returns None 30 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 should be cleared Description This function clears 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 device mode Returns None September 05 2012 471 USB Controller 30 3 2 11 USBDevMode Change the mode of the USB controller to device Prototype void USBDevMode unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function changes the mode of the USB controller to device mode Note This function should only be called on microcontrollers that support OTG operation and have the DEVMODOTG bit in the USBGPCS register Returns None 30 3 2 12 USBEndpointDataAvail Determine the number of bytes of data available in a given endpoint s FIFO Prototype unsigned long USBEndpointDataAvail unsigne
425. mines if there are any characters in the receive FIFO Prototype tBoolean UARTCharsAvail 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 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 28 2 2 12 UARTClockSourceGet Gets the baud clock source for the specified UART Prototype unsigned long UARTClockSourceGet unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function returns the baud clock source for the specified UART The possible baud clock source are the system clock UART_CLOCK_SYSTEM or the precision internal oscillator UART_CLOCK_PIOSC Note The ability to specify the UART baud clock source 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 28 2 2 13 UARTClockSourceSet Sets the baud clock source for the specified UART Prototype void UARTClockSourceSet unsigned long ulBase unsigned long ulSource Parameters ulBase is the base address of the UART port September 05 2012 UART ulSource is the baud clock source for the UART Description This function allows the baud clock source for the UART to be selected The possible clo
426. mines if this is an IN or an OUT endpoint Description This function configures the hub address for a device that is using this endpoint for communi cation The u Flags parameter determines if the device address for the IN or the OUT endpoint is configured by this call and sets the speed of the downstream device Valid values are one of USB_EP_HOST_OUT or USB_EP_HOST_IN optionally ORed with USB_EP_SPEED_LOW Note This function should only be called in host mode Returns None 30 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 Note This function should only be called on microcontrollers that support OTG operation and have the DEVMODOTG bit in the USBGPCS register Returns None September 05 2012 485 USB Controller 30 3 2 35 USBHostPwrConfig Sets the configuration for USB power fault 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 its external power control pins USBnPFLT and USBnEPEN The flags specify the power fault level sensitivity the power fault action and the powe
427. ms 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 supplied buffer The function reads and stores 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 is 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 September 05 2012 119 External Peripheral Interface EP 8 2 2 23 8 2 2 24 120 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 begins read ing data from the external device into the read FIFO The EPI
428. 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 ulBase Parameters ulBase is the base address of the PWM module Description This function removes the interrupt handler for a PWM fault interrupt from the selected PWM module This function also disables 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 This parameter must be one of PWM_GEN_0O PWM_GEN_1 PWM_GEN_ 2 or PWM_GEN_3 ulConfig is the configuration for the PWM generator Description 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 September 05 2012 Pulse Width Modulator PWM A PWM generator can count
429. n about registering interrupt handlers Returns None Programming Example The following example shows how to use the system exception module API to register an interrupt handler and enable an interrupt September 05 2012 System Exception Module The interrupt handler function extern void SysExcIntHandler void Register the interrupt handler function for the system exception interrupt SysExcIntRegister SysExcIntHandler Enable the Floating point overflow exception SysExcIntEnable SYSEXC_INT_FP_OFC September 05 2012 381 System Exception Module 382 September 05 2012 26 26 1 26 2 26 2 1 26 2 2 26 2 2 1 System Tick SysTick System Tick SysTick PRET SOUT anena a behaved Ea dobeh ak ing De adeeb he aw dante 383 APIP MOUS 6 tarca ee cae ornate cas bh ssn ca as oe dae ede ea eed een 383 Protea Example ccc sarnrenaeceiapisdw edd cameagemereniGagenecEsepesarsouqueneerseabedeorememaadas 387 Introduction SysTick is a simple timer that is part of the NVIC controller in the Cortex M microprocessor Its intended purpose is to provide a periodic interrupt for an RTOS but it can be used for other simple timing purposes The SysTick interrupt handler does not need to clear the SysTick interrupt source as it is cleared automatically by the NVIC when the SysTick interrupt handler is called This driver is contained in driverlib systick c with driverlib
430. n allows a peripheral to continue operating when the processor goes into sleep mode Because 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 ing values SYSCTL_PERIPH_CANO SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_EEPROMO SYSCTL_PERIPH_FANO SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPIOQ SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2C4 SYSCTL_PERIPH_LPCO SYSCTL_PERIPH_PWM1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI3 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMERS param 370 eter must be only SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOK SYSCTL_PERIPH_GPION SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_I2C2 SYSCTL_PERIPH_I2C5 SYSCTL_PERIPH_PECIO SYSCTL_PERIPH_QEIO SYSCTL_PERIPH_SSI1 SYSCTL_PERIPH_TIMERO SYSCTL_PERIPH_TIMER3 SYSCTL_PERIPH_UARTO one of the follow SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYS
431. n 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 September 05 2012 GPIO 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 Description This function configures the specified pin s on the selected GPIO port as either input or output under software control or it configures 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_MODE_IN GPIO_DIR_MODE_OUT GPIO_DIR_MODE_HW where GPIO_DIR_MODE_IN specifies that the pin is programmed as a software controlled input GPIO_DIR_MODE_OUT specifies that the pin is programmed as a software controlled output and GPIO_DIR_MODE_HW specifies that the pin is 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 r
432. n parameters are used to populate the message control fields before activating the command Returns None PECIAdvCmdSendNonBlocking Sends a PECI Advanced Command non blocking Prototype unsigned long PECIAdvCmdSendNonBlocking unsigned long ulBase unsigned char ucCmd September 05 2012 19 2 1 3 19 2 1 4 Platform Environment Control Interface PECI nsigned char ucHidRe nsigned char ucDomain nsigned char ucProcAdd nsigned long ulArg nsigned char u nsigned long u nsigned long u cSize DataO Datal Cie Ge Cas Ga T AG ye Is Parameters ulBase specifies the PECI module base address Description This function sends a PECI Advanced Command If the interface is not IDLE it returns imme diately Otherwise it sends the the command The function parameters are used to populate the message control fields before activating the command Returns None PECIAdvCmdStatusGet Obtains status of previous PECI Advanced Command Prototype unsigned long PECIAdvCmdStatusGet unsigned long ulBase unsigned long xpulData0 unsigned long xpulDatal Parameters ulBase specifies the PECI module base address Description This function gets the status of a previously issued PECI Advanced Command If the command has completed and the data pointers are non zero the data registers are read and saved Returns 1 if command has not yet been completed otherwise
433. n revision AO ARGET_IS_TEMPEST_RB1 The application is being built to run on a Tempest class device silicon revision B1 ARGET_IS_TEMPEST_RC1 The application is being built to run on a Tempest class device silicon revision C1 ARGET_IS_TEMPEST_RC3 The application is being built to run on a Tempest class device silicon revision C3 ARGET_IS_TEMPEST_RC5 The application is being built to run on a Tempest class device silicon revision C5 September 05 2012 513 Using the ROM 32 3 514 ARGET_IS_FIRESTORM_RA2 The application is being built to run on a Firestorm class de vice silicon revision A2 ARGET_IS_BLIZZARD_RA1 The application is being built to run on a Blizzard class device silicon revision A1 By using ROM_Function the ROM is explicitly called If the function in question is not available in the ROM a compiler error is produced See the Stellaris ROM User s Guide for the specific device 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 include driverlib rom h include driverlib systick h int main void ROM_SysTickPeriodSet 0x1000 ROM_SysTickEnable BEEE Mapped ROM Calls When code is intended to be shared between projects and
434. n used to configure a CAN message object is contained in the tCANMs gObject structure which is used when calling CANMessageSet or is 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 ulMsglDMask is the mask that 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 ob ject The ulMsglDMask 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 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 CANMes sageSet function forces this flag to be set if the length of the identifier is greater than an 11 bit identifier can hold The MSG_OBJ_USE_ID_FILTER is used to enable filtering based on the mes sage identifiers as message are seen by the CAN controller The combination of ulMsgID and ulMsglDMask determines 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
435. nal 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 sets the CAN bit timing for the bit rate passed in the u BitRate parameter based on the u SourceClock parameter Because 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 SysCtlClock Get or using a specific value in Hz The CAN bit timing is calculated assuming a minimal amount of propagation delay which works 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 Because not all bit rates can be matched 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
436. naling 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 USB_INTCTRL_POWER_FAULT Power Fault detected Host Only Note This call clears the source of all of the control status interrupts Returns Returns the status of the control interrupts for a USB controller 30 3 2 56 USBIntStatusEndpoint 496 Returns the endpoint interrupt status on a given USB controller Prototype unsigned long USBIntStatusEndpoint unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function reads endpoint interrupt status for a USB controller This call returns the current status for endpoint interrupts only the control interrupt status is retrieved by calling USBIntSta tusControl The bit values returned should be compared against the USB_INTEP_ values These values are grouped into classes for USB_INTEP_HOST_ and USB_INTEP_DEV_ values to handle both host and device modes with all endpoints September 05 2012 USB Controller Note This call clears the source of all of the endpoint interrupts Returns Returns the status of the endpoint interrupts for a USB controller 30 3 2 57 USBIntUnregister Unregisters an interrupt handler for the USB controller Prototype void USBIntUnregister
437. nction to be called when a USB interrupt occurs Description This function registers the handler to be called when a USB interrupt occurs and enables 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 calls to USBIntStatusControl and USBIntStatusEndpoint See also IntRegister for important information about registering interrupt handlers Returns None 30 3 2 54 USBIntStatus Returns the status of the USB interrupts Prototype unsigned long USBIntStatus unsigned long ulBase Parameters ulBase specifies the USB module base address Description This function reads 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 returns 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_EP0 USB_DEV_IN USB_DEV_OUT and USB_DEV_EP0 values Note This call clears 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 30 3 2 55 US
438. ned long ulInterrupt Parameters ullnterrupt specifies the interrupt to be un pended Description The specified interrupt is un pended 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 Returns None 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 Pending an interrupt causes the interrupt controller 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 is not called until after the current interrupt handler has completed execution The interrupt must have been enabled for it to be called Returns None IntPriorityGet Gets the priority of an interrupt September 05 2012 245 Interrupt Controller NVIC 16 2 2 9 Prototype long IntPriorityGet unsigned long ulInterrupt Parameters ullnterrupt specifies the interrupt in question Description This function gets the priority of an interrupt See IntPrioritySet for a definition of the priority value Returns Returns the interrupt priority or 1 if an inv
439. nel The ulAttr parameter is the logical OR of any of the following UDMA_ATTR_USEBURST is used to restrict transfers to use only 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 Returns None September 05 2012 443 uDMA Controller 29 2 3 3 29 2 3 4 444 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 This function is used to enable 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 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 uDMAChannelAttributeGet Gets the enabled attributes of a UDMA channel Prototype unsigned lo
440. nes m uDMATaskSiructEntry ulTransferCount ulltemSize ulSrclncrement pvSrcAddr ulDstlncre ment pvDstAddr ulArbSize ulMode Functions m void UDMAChannelAssign unsigned long ulMapping m void UDMAChannelAtiributeDisable unsigned long ulChannelNum unsigned long ulAttr m void UDMAChannelAttributeEnable unsigned long ulChannelNum unsigned long ulAttr m unsigned long UDMAChannelAttributeGet unsigned long ulChannelNum m void UDMAChannelControlSet unsigned long ulChannelStructIndex unsigned long ulControl m void UDMAChannelDisable unsigned long ulChannelNum void UDMAChannelEnable unsigned long ulChannelNum tBoolean uUDMAChannellsEnabled unsigned long ulChannelNum m unsigned long UDMAChannelModeGet unsigned long ulChannelStructIndex a void UDMAChannelRequest unsigned long ulChannelNum H void UDMAChannelScatterGatherSet unsigned long ulChannelNum unsigned ulTaskCount void pvTaskList unsigned long ullsPeriphSG void UDMAChannelSelectDefault unsigned long ulDefPeriphs void uUDMAChannelSelectSecondary unsigned long ulSecPeriphs unsigned long UDMAChannelSizeGet unsigned long ulChannelStructlndex void uUDMAChannelTransferSet unsigned long ulChannelStructIndex unsigned long ulMode void xpvSrcAddr void xpvDstAddr unsigned long ulTransferSize void x uUDMAControlAlternateBaseGet void void x UDMAControlBaseGet void void uDMAControlBaseSet void pControlTable void UDMADisable void void u
441. netlnitExpClk 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 September 05 2012 93 Ethernet Controller 1 2 2 1 7 2 2 8 94 Description The specified Ethernet 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 triggered again immediately upon exit The ullntFlags parameter has the same definition as the ullntFlags parameter to Ethernet IntEnable Note Because there is a write buffer in the Cortex M 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 individ
442. 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 This function allows the caller to determine whether all transmitted bytes have cleared the transmitter hardware If 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 September 05 2012 23 2 2 2 23 2 2 3 Synchronous Serial Interface SS SSIClockSourceGet Gets the data clock source for the specified SSI peripheral Prototype unsigned long SSIClockSourceGet unsigned long ulBase Parameters ulBase is the base address of the SSI port Description This function returns the data clock source for the specified SSI The possible data clock source are the system clock SSI_CLOCK_SYSTEM or the precision internal oscillator SSI_CLOCK_PIOSC Note The ability to specify the SSI data clock source varies with the Stellaris part and SSI in use Please consult the data sheet for the part in use to determine whether this support is available Returns None SSIClockSourceSet Sets the data clock source for the specified SSI peripheral
443. ng pulData unsigned long ulAddress unsigned long ulCount Parameters pulDaita is a pointer to storage for the data read from the EEPROM This pointer must point to at least u Count bytes of available memory ulAddress is the byte address within the EEPROM from which data is to be read This value must be a multiple of 4 ulCount is the number of bytes of data to read from the EEPROM This value must be a multiple of 4 Description This function may be called to read a number of words of data from a word aligned address within the EEPROM Data read is copied into the buffer pointed to by the pu Data parameter Returns None September 05 2012 87 EEPROM 6 2 3 17 6 2 3 18 6 3 88 EEPROMSizeGet Determines the size of the EEPROM Prototype unsigned long EEPROMSizeGet void Description This function returns the size of the EEPROM in bytes Returns Returns the total number of bytes in the EEPROM EEPROMStatusGet Returns status on the last EEPROM program or erase operation Prototype unsigned long EEPROMStatusGet void Description This function returns the current status of the last program or erase operation performed by the EEPROM It is intended to provide error information to applications programming or setting EEPROM protection options under interrupt control Returns Returns 0 if the last program or erase operation completed without any erro
444. ng uDMAChannelAttributeGet unsigned long ulChannelNum Parameters ulChannelNum is the channel to configure 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 UDMA channel which can be any of the following UDMA_ATTR_USEBURST is used to restrict transfers to use only 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 September 05 2012 uDMA Controller 29 2 3 5 uDMAChannelControlSet 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 parameters are typically 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 str
445. ng potential bugs An interrupt can also be generated when an erase or programming operation has completed The size of the available EEPROM and the number of blocks it contains varies between different members of the Stellaris family API functions EEPROMSizeGet and EEPROMBIockCountGet are provided to allow this information to be determined at runtime Data protection is supported at both the device and block levels with configurable passwords used to control read and write access Additionally blocks may be configured to allow access only while the CPU is running in supervisor mode A second protection mechanism allows one or more EEPROM blocks to be made completely inaccessible to software until the next system reset This driver is contained in driverlib eeprom c with driverlib eeprom h containing the API definitions for use by applications EEPROM Protection The EEPROM device is organized into a number of blocks each of which may be configured with various protection options to control an application s ability to read and or write data Additionally protection options set on the first block of the device block 0 affect access to the EEPROM as a whole allowing global options to be set on block 0 and individual block protection to be layered on top of this Each block may be configured for two protection states one which is in effect when the block is locked and a second which applies when the block is unlocked Unlocking is perfo
446. ng 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 September 05 2012 231 Inter IC Sound 12S 15 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 occurs The service request is used to generate an interrupt or a DMA transfer request The receive FIFO generates a service request when the number of items in the FIFO is greater than the level specified in the ulLevel parameter For example if u Level is 4 then a service request is 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 Because the FIFO always deals with sample pairs the level must be an even number from 0 to 16 The minimum value is 0 which cau
447. ng 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 September 05 2012 33 Analog to Digital Converter ADC 4 2 2 17 4 2 2 18 4 2 2 19 34 ADCProcessorTrigger Causes a processor trigger for a sample sequence Prototype void ADCProcessorTrigger unsigned long ulBase unsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number with ADC_TRIGGER_WAIT or
448. ng ulBase unsigned long ullntFlags void LPCCOMxIntDisable unsigned long ulBase unsigned long ullntFlags void LPCCOMxIntEnable unsigned long ulBase unsigned long ullntFlags unsigned long LPCCOMxIntStatus unsigned long ulBase tBoolean bMasked unsigned long LPCConfigGet unsigned long ulBase void LPCConfigSet unsigned long ulBase unsigned long ulConfig unsigned short LPCHalfWordRead unsigned long ulBase unsigned long ulOffset void LPCHalfWordWrite unsigned long ulBase unsigned long ulOffset unsigned short us Data void LPCIntClear unsigned long ulBase unsigned long ullntFlags void LPCIntDisable unsigned long ulBase unsigned long ullntFlags void LPCIntEnable unsigned long ulBase unsigned long ullntFlags void LPCIntRegister unsigned long ulBase void pfnHandler void unsigned long LPCIntStatus unsigned long ulBase tBoolean bMasked void LPCIntUnregister unsigned long ulBase void LPCIRQClear unsigned long ulBase unsigned long ullRQ void LPCIRQConfig unsigned long ulBase tBoolean bIRQPulse tBoolean bIRQOnChange unsigned long LPCIRQGet unsigned long ulBase void LPCIRQSend unsigned long ulBase void LPCIRQSet unsigned long ulBase unsigned long ullRQ void LPCSClAssert unsigned long ulBase unsigned long ulCount unsigned LPCStatusBlockAddressGet unsigned long ulBase void LPCStatusBlockAddressSet unsigned long ulBase unsigned long ulAddress tBoolean bEnabled unsigned long LPCStatu
449. ng 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 the 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_ is selected September 05 2012 449 uDMA Controller 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
450. nit 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 privileged 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 allowing 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
451. nitial value HibernateRTCSet 0 Set Match 0 for 30 seconds from now HibernateRTCMatch0Set 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 is invoked in 30 seconds 200 September 05 2012 14 14 1 14 1 1 Inter Integrated Circuit I2C Inter Integrated Circuit 12C RTOS maneiana aa bade mn nea inhi bbe ant Detain abe e here dautboaahies 201 PP iPM CHOU 6 tanec ee ec aah owns EE sunet ca aoe eda heten nee e enue eden et enaew ees 202 Programming ERIN DIS ccc sornreaeceiapisew edd cameagemeeentbagenecEsepesersouquenerseebedeereeenandas 221 Introduction The Inter Integrated Circuit I2C 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
452. nnel parameter should be one of UDMA_INT_SW or UDMA_INT_ERR as documented for the function UDMAIntRegister See also IntRegister for important information about registering interrupt handlers Returns None 29 3 Programming Example The following example sets up the uDMA controller to perform a software initiated memory to memory transfer hf 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 456 September 05 2012 uDMA Controller Source and destination buffers used for the DMA transfer I 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 must be set for a software based transfer The attributes are 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 for 8 bit data size with source and destination increments in bytes and 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 UDM
453. ns None September 05 2012 107 External Peripheral Interface EP 8 2 2 2 108 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 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_FRAME50 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 cy
454. nsigned long EEPROMInit void Description This function must be called after SysCtlPeripheralEnable and before the EEPROM is ac cessed to check for errors resulting from power failure during a previous write operation The function detects these errors and performs as much recovery as possible before returning in formation to the caller on whether or not a previous data write was lost and must be retried In cases where EEPROM_INIT_RETRY is returned the application is responsible for deter mining which data write may have been lost and rewriting this data If EEPROM_INIT_ERROR is returned the EEPROM was unable to recover its state This condition may or may not be resolved on future resets depending upon the cause of the fault For example if the supply voltage is unstable retrying the operation once the voltage is stabilized may clear the error September 05 2012 83 EEPROM 6 2 3 9 6 2 3 10 84 Failure to call this function after a reset may lead to permanent data loss if the EEPROM is later written Returns Returns EEPROM_INIT_OK if no errors were detected EEPROM_INIT_RETRY if a pre vious write operation may have been interrupted by a power or reset event or EEP ROM_INIT_ERROR if the EEPROM peripheral cannot currently recover from an interrupted write or erase operation EEPROMIntClear Clears the EEPROM interrupt Prototype void EFEPROMIntClear unsigned long ulIntFlags Parameters ullntFlag
455. nsigned 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 ulEndpoint unsigned long USBFIFOAddrGet unsigned long ulBase unsigned long ulEndpoint void USBFIFOConfigGet unsigned long ulBase unsigned long ulEndpoint unsigned long pulFIFOAddress unsigned long xpulFIFOSize 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
456. nsigned long ulSequenceNum Parameters ulBase is the base address of the ADC module ulSequenceNum is the sample sequence number Description This function clears 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 September 05 2012 39 Analog to Digital Converter ADC 4 2 2 29 40 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 one of the input channel selects ADC_CTL_CHO through ADC_CTL_CH23 and one of the digital comparator selects ADC_CTL_CMPO0 through ADC_CTL_CMP7 Description This function configures 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 differen tial operation when set the channel to be sampled can be chosen the ADC_CTL_CHO through ADC_CTL_CH23 values and the internal temperature sensor can be selected the ADC_CTL_TS bit Additionally th
457. nsmit m UART_DMA_ERR_RXSTOP do not disable DMA receive on UART error Returns None 28 2 2 19 UARTDMAEnable Enable UART DMA operation Prototype void UARTDMAEnable 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 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 u DMAFlags parameter is the logical OR of any of the following values m UART_DMA_RX 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 28 2 2 20 UARTEnable Enables transmitting and receiving Prototype void UARTEnable unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function sets the UARTEN TXE and RXE bits and enables the transmit and receive FIFOs Returns None 420 September 05 2012 UART 28 2 2 21 UARTEnableSIR 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 Descrip
458. nt 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 if Endpoint 1 is a device mode BULK OUT endpoint using DMA USBDevEndpointConfigSet USBO_BASE USB_EP_1l 64 USB_EP_DEV_OUT USB_EP_MODE_BULK USB_EP_DMA_MODE_1 USB_EP_AUTO_CLEAR Next the application is required to configure the uDMA controller to match the desired trans fer Like the transmit case the first call to DMAChannelAttributeClear is made to clear any previous settings This function is followed by a call to DMAChannelAttributeSet with the DMA_CONFIG_USEBURST value Note All uDMA transfers used by the USB controller must use burst mode The final call configures 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 the receive side can be set up right away to wait for incoming data Like the transmit case th
459. nt information about registering interrupt handlers Returns None 22 2 2 12 QE PositionGet Gets the current encoder position Prototype unsigned long QEIPositionGet unsigned long ulBase September 05 2012 329 Quadrature Encoder QE Parameters ulBase is the base address of the quadrature encoder module Description This function 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 is not yet aligned with the index pulse Returns The current position of the encoder 22 2 2 13 QE lPositionSet Sets the current encoder position 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 function sets the current position of the encoder the encoder position is then measured relative to this value Returns None 22 2 2 14 QElVelocityConfigure 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 sp
460. ntEnable 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 September 05 2012 Quadrature Encoder QE 22 2 2 10 QEllntStatus 22 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 function returns the interrupt status for the quadrature encoder 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 QEILINTERROR QEI_INTDIR QEI_INTTIMER and QEL_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 unregisters the handler to be called when a quadrature encoder interrupt occurs This function also masks off the interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for importa
461. nter to storage for the output drive strength 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 12 2 2 10 GPlIOPadConfigSet 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 158 September 05 2012 GPIO where GPIO_STRENGTH_xMA specifies either 2 4 or 8 mA outp
462. nterrupt controller still sees the interrupt source asserted 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 September 05 2012 225 Inter IC Sound 12S 15 2 2 3 15 2 2 4 226 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 None I2SIntEnable Enables 12S interrupt sources Prototype void T2SIntEnable unsigned long ulBase unsigned long ulIntFlags Parameters ulBase 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 None I2SIntRegister Registers an interrupt handler for the 12S controller Prototype void I2SIntRegister unsigned long ulBase void pfnHandler void
463. nterrupt handling The timer module provides two half width timers counters that can be configured to operate inde pendently as timers or event counters or to operate as a combined full width timer or Real Time Clock RTC Some timers provide 16 bit half width timers and a 32 bit full width timer while oth ers provide 32 bit half width timers and a 64 bit full width timer For the purposes of this API the two half width timers provided by a timer module are referred to as TimerA and TimerB and the full width timer is referred to as TimerA When configured as either a full width or half width timer a timer can be set up to run as a one shot timer or a continuous timer If configured in one shot mode the timer ceases counting when it reaches zero when counting down or the load value when counting up If configured in continuous mode the timer counts to zero counting down or the load value counting up then reloads and continues counting When configured as a full width timer the timer can also be configured to operate as an RTC In this mode 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 half width 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 the events themselves The type of e
464. nterrupt 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 configures 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 last trigger output September 05 2012 25 Analog to Digital Converter ADC 4 2 2 2 26 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 alway
465. nto the CANMessageSet API These are the tCANMsgObject 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 September 05 2012 67 Controller Area Network CAN 68 Message objects can be defined as one of five types based on the needs of the application They are defined in the tMsgObjType 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 they 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 receives remote requests for data and generates an interrupt to let the application 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 informatio
466. number which is to be hidden Description This function hides an EEPROM block other than block 0 Once hidden a block is completely inaccessible until the next reset This mechanism allows initialization code to have access to data which is to be hidden from the rest of the application Unlike applications using passwords an application making using of block hiding need not contain any embedded passwords which could be found through disassembly Returns None EEPROMBlockLock Locks a password protected EEPROM block Prototype unsigned long EEPROMBlockLock unsigned long ulBlock Parameters ulBlock is the EEPROM block number which is to be locked Description This function locks an EEPROM block that has previously been protected by writing a pass word Access to the block once it is locked is determined by the protection settings applied via a previous call to the EEPROMBlockProtectSet function If no password has previously been set for the block this function has no effect Locking block 0 has the effect of making all other blocks in the EEPROM inaccessible September 05 2012 Returns Returns the lock state for the block on exit 1 if unlocked as would be the case if no password was Set or 0 if locked 6 2 3 4 EEPROMBlockPasswordSet Sets the password used to protect an EEPROM block Prototype u nsigned long EEPROMBlockPasswordsSet unsigned EEPROM long
467. o access ulTransType is set to indicate what type of data is being sent Description This function starts the transfer of data from the FIFO for a given endpoint This function should be called if the USB_EP_AUTO_SET bit was not enabled for the endpoint Setting the u TransType parameter allows 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 USB_TRANGS_IN for IN transaction on any endpoint in device mode USB_TRANS_IN_LAST for the last IN transaction on endpoint zero in a sequence of IN transactions USB_TRANS_SETUP for setup transactions on endpoint zero USB_TRANS_STATUS for status results on endpoint zero Returns This call returns 0 on success or 1 if a transmission is already in progress 30 3 2 16 USBEndpointDataToggleClear Sets the data toggle on an endpoint to zero Prototype void USBEndpointDataToggleClear 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 causes the USB 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 cont
468. o reflect to the processor can be returned Returns Returns the current interrupt status enumerated as a bit field of values described in I2CSlavelntEnableEx 14 2 2 39 2CSlaveStatus Gets the 12C Slave module status Prototype unsigned long I2CSlaveStatus unsigned long ulBase Parameters ulBase is the base address of the I2C Slave module Description This function returns the action requested from a master if any Possible values are 220 September 05 2012 Inter Integrated Circuit I2C 12C_SLAVE_ACT_NONE 12C_SLAVE_ACT_RREQ 12C_SLAVE_ACT_TREQ 12C_SLAVE_ACT_RREQ FBR 12C_SLAVE_ACT_OWN2SEL 12C_SLAVE_ACT_QCMD 12C_SLAVE_ACT_QCMD_DATA Note Not all Stellaris devices support the second I2C slave s own address or the quick command function Please consult the device data sheet to determine if these features are supported 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 12C master has sent data to the I2C Slave module I2C_SLAVE_ACT_TREQ to indicate that an I2C master has requested that the 12C Slave module send data 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 I2C_SLAVE_ACT_OWN2SEL to indicate that the second I2C slave address was matched I2C_SLAVE_ACT_QCMD to indicate that a quick command was received and
469. o 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 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 condition
470. ock 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 configures 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 24 2 2 43 SysCtlReset Resets the device Prototype void SysCt1lReset void Description This function performs a software reset of the entire device The processor and all peripherals are reset and all device registers are returned to their default values with the exception of the reset cause register which maintains its current value but has the software reset bit set as well Returns This function does not return September 05 2012 373 System Control 24 2 2 44 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 res
471. ockGet or it can be explicitly hard coded if it is constant and known to save the code execution overhead of a call to SysCtIClockGet For Stellaris parts that have the ability to specify the UART baud clock source via UARTClock SourceSet the peripheral clock can be changed to PIOSC In this case the peripheral clock should be specified as 16 000 000 the nominal rate of PIOSC 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 September 05 2012 417 UART 28 2 2 15 UARTConfigSetExpClk Sets the configuration of a UART Prototype void UARTConfigSetExpClk unsigned long ulBase unsigned long ulUARTCLk unsigned long ulBaud unsigned long ulConfig Parameters ulBase is the base address of the UART port ulUARTCIk 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 s
472. odule s input clock Some Stellaris devices can use the PIOSC as the serial bit 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 API Functions Functions m tBoolean SSIBusy unsigned long ulBase m unsigned long SSIClockSourceGet unsigned long ulBase m void SSIClockSourceSet unsigned long ulBase unsigned long ulSource m void SSIConfigSetExpClk unsigned long ulBase unsigned long ulSSICIk unsigned long ul Protocol unsigned long ulMode unsigned long ulBitRate unsigned long ulDataWidth void SSIDataGet unsigned long ulBase unsigned long pulData long SSIDataGetNonBlocking 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 September 05 2012 333 Synchronous Serial Interface SSI 23 2 1 23 2 2 23 2 2 1 334 void SSIDMAEnable unsigned long ulBase unsigned long ulDMAFlags void SSIEnable unsigned long ulBase void SSllntClear unsigned long ulBase unsign
473. of the PinTypex functions although this re quires explicit knowledge of the GPIO pin s to be used For example it requires four PinTypeSSI calls to configure the four pins on the SSI peripheral but this could be done with a single call to GPIOPinTypeSSI if the pins are all in the same GPIO module But using GPIOPinTypex instead of PinTypex results in the code no longer being automatically reconfigured without the use of explicit conditionals in the code of course This driver is contained in driverlib pin_map h API Functions Functions m void PeripheralEnable unsigned long ulName m void PinTypeADC unsigned long ulName m void PinTypeCAN unsigned long ulName m void PinlypeComparator unsigned long ulName m void PinTypeEthernetLED unsigned long ulName m void PinTypel2C unsigned long ulName m void Pin TypePWM unsigned long ulName m void PinTypeQEI unsigned long ulName September 05 2012 293 Peripheral Pin Mapping 20 2 1 20 2 2 20 2 2 1 20 2 2 2 294 m void PinTypeSSI unsigned long ulName m void PinTypeTimer unsigned long ulName m void PinTypeUART unsigned long ulName a 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
474. oller Area Network CAN values All but the last of the message objects in a FIFO should have the MSG_OBJ_FIFO flag set and the last message object in the FIFO should not have the MSG_OBJ_FIFO flag set indicating that it 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 is 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 CANMessageGet The pucMsgData variable in tCANMsgObject is the pointer to the data to send ulMsgLen bytes or the pointer to the buffer to read ulMsgLen bytes into Programming Examples This example code sends out data from CAN controller 0 to be received by CAN controller 1 In ord
475. oller for the desired DMA transfer to the FIFO 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 also provides the size of each DMA transaction combined with the source and destination increments and the arbitration level for the UDMA controller Example Configure endpoint 1 transmit channel Set up the DMA for USB transmit lel 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 must make to start a new transfer For most cases the previous uDMA configuration remains the same The call to DMAChanneltransferSet resets the source and destination addresses for the DMA transfer and specifies how much data to send The call to DMAChannelEnable actually al
476. om 0 511 out of a 512 clock PWM period FanChannelDutySet Sets the duty cycle of a FAN channel when in manual mode Prototype void FanChannelDutySet unsigned long ulBase unsigned long ulChannel unsigned long ulDuty Parameters ulBase is the base address of the FAN module ulChannel is the FAN channel to program the duty cycle ulDuty is the duty cycle in clocks from 0 511 Description This function sets the duty cycle of a FAN channel if the channel is configured for manual mode The duty cycle is specified in clocks from 0 511 out of a 512 clock PWM period Returns None FanChannelEnable Enables a FAN channel for operation September 05 2012 9 2 2 7 9 2 2 8 Fan Controller Prototype void FanChannelEnable unsigned long ulBase unsigned long ulChannel Parameters ulBase is the base address of the FAN module ulChannel is the FAN channel to enable Description This function enables the specified FAN channel for operation Returns None FanChannelRPMGet Reads the RPM of a FAN channel Prototype unsigned long FanChannelRPMGet unsigned long ulBase unsigned long ulChannel Parameters ulBase is the base address of the FAN module ulChannel is the FAN channel to query for RPM Description This function reads the RPM of a FAN channel Returns Returns the FAN channel RPM as a number from 0 4095 FanChannelRPMSet Sets the RPM of
477. on 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 Programming Example Initialize the UART Set the baud rate number of data bits parity number of stop bits and stick mode ff UARTConfigSetExpClk UARTO_BASE SysCtlClockGet 38400 UART_CONFIG_WLEN_8 UART_CONFIG_STOP_ONE UART_CONFIG_PAR_NONE if Enable the UART iif UARTEnable UARTO_BASE Check for characters 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 if Put a character in the output buffer UARTCharPut UARTO_BASE c Disable the UART UARTDisable UARTO_BASE September 05 2012 turn off The following example shows how to use the UART API to initialize the UART transmit characters and receive characters 433 UART 434 September 05 2012 29 29 1 uDMA Controller uDMA Controller DRT maneia was aa Ea dbe aad hing Dedede bee hea daiabheem 435 Pr VPM MOUS 6 tance ec aah oleate aaa bo a ene ca ae oe daha ede eae beaie eet eenew ees 436 Pregrammmg Example ccc sannrenaeceispisen edd camtagemeeentGagenecEsepesarsouquanereeabedeareeemantan 456 Introduction The Micro Direct Memory Acc
478. on of the polling rate the u PECICI k is pre divided by 4096 A value of 0 disables the September 05 2012 285 Platform Environment Control Interface PECI 19 2 1 8 19 2 1 9 286 polling feature If the exact polling rate cannot be achieved due to rounding the polling rate is programmed to the nearest value that is greater than the specified value The ulRetry parameter defines the number of PECI transactions that are attempted before indicating an error condition Returns None PECIDomainConfigGet Gets the configuration of the specified PECI domain Prototype void PECIDomainConfigGet unsigned long ulBase unsigned long ulDomain unsigned long xpulHigh unsigned long xpulLow Parameters ulBase is the base address of the PECI module ulDomain is the PECI domain that should be configured pulHigh is a pointer to storage for the high threshold pulLow is a pointer to storage for the low threshold Description This function configures the specified PECI domain for temperature monitoring operations The values for u High and ulLow can be specified as values relative to the maximum temperature allowed or they can be specified as absolute temperatures if an offset was programmed in the PECI ConfigSet function The u Domain parameter can be one of the following values PECI_DOMAIN_MODO PECI_DOMAIN_M0D1 PECI_DOMAIN_M1D0 or PECL DOMAIN_M1D1 Returns None PECIDomainConfigSet Sets the c
479. on the number of UDMA channels and the transfer modes that are used Refer to the introductory text and the microcontroller datasheet for more information about the channel control table Returns None 29 2 3 19 UDMADisable Disables the UDMA controller for use Prototype void uDMADisable void Description This function disables the UDMA controller Once disabled the UDMA controller cannot operate until re enabled with uUDMAEnable Returns None 29 2 3 20 UDMAEnable Enables the uUDMA controller for use September 05 2012 453 uDMA Controller 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 29 2 3 21 uDMAErrorStatusClear Clears the uDMA error interrupt Prototype void uDMAErrorStatusClear void Description This function clears a pending UDMA error interrupt This function should be called from within the uDMA error interrupt handler to clear the interrupt Returns None 29 2 3 22 uDMAErrorStatusGet 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 29 2 3 23 uDMAIntClear Clears uDMA interrupt s
480. onfiguration of the specified PECI domain Prototype void PECIDomainConfigSet unsigned long ulBase unsigned long ulDomain unsigned long ulHigh unsigned long ulLow Parameters ulBase is the base address of the PECI module September 05 2012 Platform Environment Control Interface PECI ulDomain is the PECI domain that should be configured ulHigh is the high temperature threshold value ulLow is the low temperature threshold value Description This function configures the specified PECI domain for temperature monitoring operations The values for u High and ulLow can be specified as values relative to the maximum temperature allowed or they can be specified as absolute temperatures if an offset was programmed in the PECIConfigSet function The u Domain parameter can be one of the following values PECI_DOMAIN_MODO PECI_DOMAIN_M0D1 PECI_DOMAIN_M1D0 or PECL DOMAIN_M1D1 Returns None 19 2 1 10 PECIDomainDisable 19 2 1 11 Disables a domain within the PECI module Prototype void PECIDomainDisable unsigned long ulBase unsigned long ulDomain Parameters ulBase is the base address of the PECI module ulDomain is the PECI domain that should be disabled Description This function disables the specified PECI domain The u Domain parameter can be one of the following values PECI_DOMAIN_MODO PECI_DOMAIN_M0D1 PECI_DOMAIN_M1D0 or PECL DOMAIN_M1D1 Returns None PECIDoma
481. ontroller Area Network CAN 5 2 2 5 2 2 1 48 at the same time the one with the highest priority message object occurs first And second when multiple message objects have interrupts pending the highest priority is presented first when read ing 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 m 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 function places the vector in a RAM based vector table However if the application 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 must 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
482. ool 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 m 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 code can be used as a reference upon which to add support for the additional capabilities m 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 Driver Library includes drivers for all classes of Stellaris microcontrollers Some drivers and parameters are only valid for certain classes See the application report entitled Differences Among Stellaris Product Classes for more information
483. oolean 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 September 05 2012 15 Analog Comparator 3 2 2 3 2 2 1 16 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 of 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
484. ow to set up the Hibernation module and initiate a hibernation with wake up at a future time unsigned long ulStatus unsigned long pulNVData 64 Need to enable the hibernation peripheral before using it SysCtlPeripheralEnable SYSCTL_PERIPH_HIBERNATE Enable clocking to the Hibernation module HibernateEnableExpClk SysCt1lClockGet 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 Lf HibernateClockSelect HIBERNATE_CLOCK_SEL_DIV128 HibernateRTCEnable j 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 for 30 seconds from now HibernateRTCMatchO0Set HibernateRTCGet 30 Clear any pending status September 05 2012 Hibernation Module ulStatus HibernateIntStatus 0 HibernateIntClear ulStatus Save the program state information The state information is stored in the pulNVData array It is not necessary to save the full 64 words of data only as much as is actually needed by the program HibernateDataSet pulNVData 64 Configure to wake on
485. ows the caller to determine whether all transmitted bytes have cleared the transmitter hardware If false is returned the transmit FIFO is empty and all bits of the last transmitted character 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 This function gets a character from the receive FIFO for the specified port If there are no characters available 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 This function 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 September 05 2012 28 2 2 9 UART 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 UARTChars
486. parameter 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 21 2 2 33 PWMSyncUpdate Synchronizes all pending updates Prototype void PWMSyncUpdate unsigned long ulBase unsigned long ulGenBits Parameters ulBase is the base address of the PWM module ulGenBits are the PWM generator blocks to be updated This parameter must be the logical OR of any of PWM_GEN_O 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 September 05 2012 321 Pulse Width Modulator PWM 21 3 322 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 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
487. pe unsigned long HibernateBatCheckDone void Description This function returns if the forced battery check initiated by a call to the HibernateBatCheck Start function has completed This function returns a non zero value until the battery level check has completed Once this function returns a value of zero the hibernation module has completed the battery check and the HibernatelntStatus function can be used to check if the battery was low by checking if the value returned has the HIBERNATE_INT_LOW_BAT set Note This function is only available on some Stellaris devices Returns The value is zero when the battery level check has completed or non zero if the check is still in process September 05 2012 181 Hibernation Module 13 2 2 2 13 2 2 3 182 HibernateBatCheckStart Forces the Hibernation module to initiate a check of the battery voltage Prototype void HibernateBatCheckStart void Description This function forces the Hibernation module to initiate a check of the battery voltage imme diately rather than waiting for the next check interval to pass After calling this function the application should call the function and wait for the function to return a zero value before call ing the HibernatelntStatus to check if the return code has the HIBERNATE_INT_LOW_BAT set If HIBERNATE_INT_LOW_BAT is set the battery level is low The application can also enable the HIBERNATE_INT_LOW_BAT interrupt and wai
488. pe 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 timer If the bStall parameter is true then the timer stops counting if the processor enters debug mode otherwise the timer keeps running while in debug mode Returns None TimerControlTrigger Enables or disables the ADC 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 September 05 2012 393 Timer 27 2 2 6 27 2 2 394 bEnable specifies the desired ADC trigger state Description This function controls the ADC trigger output for the specified timer If the bEnable parameter is true then the timer s ADC 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 Parameters ulBase is the base address of the timer module
489. perate in automatic mode The ulConfig parameter is the logical OR of several choices of configuration flags as follows One of the following to select the automatic restart mode a FAN_CONFIG_RESTART to enable automatic restart after stall m FAN_CONFIG_NORESTART to disable automatic restart after stall One of the following to select the acceleration rate when changing speed FAN_CONFIG_ACCEL FAST to select fast acceleration m FAN_CONFIG_ACCEL_SLOW to select slow acceleration One of the following to select the number of tachometer pulses to use for the hystere sis count FAN _CONFIG_HYST_1 FAN_CONFIG_HYST_2 FAN_CONFIG_HYST_4 FAN_CONFIG_HYST_8 FAN_CONFIG_HYST_16 FAN_CONFIG_HYST_32 FAN_CONFIG_HYST_64 or FAN_CONFIG_HYST_128 One of the following to select the start period as the number of tachometer pulses The start period is the amount of time that a starting PWM duty cycle is used after the FAN channel is commended to a certain speed FAN_CONFIG_START_2 FAN_CONFIG_START_4 FAN_CONFIG_START_8 FAN_CONFIG_START_16 FAN_CONFIG_START_32 FAN_CONFIG_START_64 FAN_CONFIG_START_128 or FAN_CONFIG_START_256 One of the following to specify the duty cycle that is used when the FAN channel is starting during the starting period above FAN_CONFIG_START_DUTY_OFF to disable the use of startup duty cycle FAN_CONFIG_START_DUTY_50 to select 50 startup duty cycle FAN_CONFIG_START_DUTY_75 to select 75 startup duty cycle FAN_CONFIG_START_DUTY_
490. pplication must check the validity of data it has written and retry any writes as required EEPROM_INT_PROGRAM Definition define EEPROM_INT_PROGRAM Description This value may be passed to EEPROMIntEnable and EEPROMIntDisable and is returned by EEPROMIntStatus if an EEPROM interrupt is currently being signaled September 05 2012 6 2 2 5 6 2 2 6 6 2 2 7 6 2 2 8 6 2 2 9 EEPROM EEPROM_PROT_NA_LNA_URW Definition define EEPROM_PROT_NA_LNA_URW Description This value may be passed to EEPROMBlockProtectSet or returned from EEPROMBlockPro tectGet It indicates that the block should offer neither read nor write access unless it is protected by a password and unlocked EEPROM_PROT_RO_LNA_URO Definition define EEPROM PROT _RO_LNA_URO Description This value may be passed to EEPROMBlockProtectSet or returned from EEPROMBlockPro tectGet It indicates that the block should offer read only access when no password is set or when a password is set and the block is unlocked When a password is set and the block is locked neither read nor write access is permitted EEPROM PROT _RW_LRO_URW Definition define EEPROM _PROT_RW_LRO_URW Description This value may be passed to EEPROMBlockProtectSet or returned from EEPROMBlockPro tectGet It indicates that the block should offer read write access when no password is set or when a password is
491. pt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor September 05 2012 327 Quadrature Encoder QE 22 2 2 8 22 2 2 9 328 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 This function enables 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 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 function registers the handler to be called when a quadrature encoder interrupt occurs This function enables the global interrupt in the interrupt controller specific quadrature encoder interrupts must be enabled via QElI
492. r 29 2 3 9 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_SELECT or UDMA_ALT_SELECT Description This function is used to get the transfer mode for the UDMA channel and to query the status of a transfer on a channel When the transfer is complete the mode is UDMA_MODE_STOP Returns Returns the transfer mode of the specified channel and control structure which is 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 29 2 3 10 uDMAChannelRequest 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 Description This function allows software to request a UDMA channel to begin a transfer This function 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 is sig naled on the uUDMA dedicated interrupt If a peripheral channel is used then the completion is
493. r counters are returned through the pointers provided as parameters After this call xpu RxCount holds the current receive error count and xpu TxCount holds 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 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 CANIntClear Clears a CAN interrupt source Prototype void CANIntClear 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 Description This function can be used to clear a specific interrupt source The ul intCir 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 September 05
494. r data reads are not allowed Returns Returns the protection setting for this block See FlashProtectSet for possible values 10 2 2 10 FlashProtectSave Saves the flash protection settings Prototype long FlashProtectSave void Description This function makes the currently programmed flash protection settings permanent On some devices this operation is non reversible a chip reset or power cycle does not change the flash protection This function does not return until the protection has been saved Returns Returns 0 on success or 1 if a hardware error is encountered 10 2 2 11 FlashProtectSet Sets the protection setting for a block of flash Prototype long FlashProtectSet unsigned long ulAddress tFlashProtection eProtect 140 September 05 2012 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 sets the protection for the specified 2 kB block of flash Blocks that are read write can be made read only or execute only Blocks that are read only can be made execute only Blocks that are execute only cannot have their protection modified Attempts to make the block protection less stringent that is read only to read write result in a failure and are prevented by the hardware Changes to the flash protection are main
495. r 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 USBnEPEN is driven low by the USB controller when USBHostPwrEnable is called USB_HOST_PWREN_MAN_HIGH USBnEPEN is driven high by the USB controller when USBHosiPwrEnable is called USB_HOST_PWREN_AUTOLOW USBnEPEN is driven low by the USB controller auto matically if USBOTGSessionRequest has enabled a session USB_HOST_PWREN_AUTOHIGH USBnEPEN is driven high by the USB controller au tomatically if USBOTGSessionRequest has enabled a session On devices that support the VBUS glitch filter the USB_HOST_PWREN_FILTER can be added to ignore small short drops in VBUS level caused by high power consumption This feature is mainly used to avoid causing VB
496. r in the Cortex M 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 SysExclintDisable Disables individual system exception interrupt sources Prototype void SysExcIntDisable unsigned long ulIntFlags Parameters ullntFlags is the bit mask of the interrupt sources to be disabled Description This function disables the indicated system exception interrupt sources Only 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 SYSEXC_INT_FP_IXC Floating point inexact exception interrupt m SYSEXC_INT_FP_OFC Floating point overflow exception interrupt SYSEXC_INT_FP_UFC Floating point underflow exception interrupt SYSEXC_INT_FP_IOC Floating point invalid operation interrupt SYSEXC_INT_FP_DZC Floating point divide by zero exception interrupt m SYSEXC_INT_FP_IDC Floating point input denormal exception interrupt September 05 2012 25 2
497. r 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 uUDMAChannelEnable which must be done September 05 2012 437 uDMA Controller 438 before each new transfer The uUDMA controller automatically disables the channel at the completion of a transfer A channel can be manually disabled by using UDMAChannelDisable 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 UDMAChannelSizeGet is used to find the amount of data remaining to transfer on a channel This value is zero when a transfer is complete The function UDMAChannelModeGeti can be used to find the transfer mode of a UDMA channel This function is usually used to see if the mode indicates stopped meaning that a transfer has completed 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 also enables 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 in
498. r 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 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 12 2 2 25 GPIOPinTypeGPlOOutput Configures pin s for use as GPIO outputs Prototype void GPIOPinTypeGPlOOutput unsigned long ulPort unsigned char ucPins September 05 2012 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 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 12 2 2 26 GPIOP
499. rdware floating point operations failure to do so results in a NOCP usage fault Returns None FPUFlushToZeroModeSet Selects the flush to zero mode Prototype void FPUFlushToZeroModeSet unsigned long ulMode Parameters ulMode is the flush to zero mode which is either FPU_FLUSH_TO_ ZERO DIS or FPU_FLUSH_TO_ZERO EN Description This function enables or disables the flush to zero mode of the floating point unit When dis abled the default the floating point unit is fully IEEE compliant When enabled values close to zero are treated as zero greatly improving the execution speed at the expense of some accuracy as well as IEEE compliance Note Unless this function is called prior to executing any floating point instructions the default mode is used Returns None FPUHalfPrecisionModeSet Selects the format of half precision floating point values Prototype void FPUHalfPrecisionModeSet unsigned long ulMode Parameters ulMode is the format for half precision floating point value which is either FPU_HALF_IEEE or FPU_HALF_ALTERNATE Description This function selects between the IEEE half precision floating point representation and the Cortex M processor alternative representation The alternative representation has a larger September 05 2012 147 Floating Point Unit FPU 11 2 2 5 11 2 2 6 148 range but does not have a way to encode infinity positive or negative or NaN quiet or signa
500. re 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 EPINBCONFIG_SIZE_32 for 8 bit 16 bit or 32 bit sized data transfers The parameter u 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 function multiple times Until it is changed the EPI module stores the last address that was used for a non blocking read per channel Returns None September 05 2012 117 External Peripheral Interface EP 8 2 2 18 8 2 2 19 8 2 2 20 118 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 EPINon
501. re 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 associated with Gen0 PWM2 and PWM3 are associated with Gen1 PWM4 and PWM5 are associated with Gen2 and PWM6 and PWM7 are associated with Gens 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 1 or 2 modules with 3 or 4 generators each and 6 or 8 outputs each Function Documentation 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 This parameter must be one of PWM_GEN_0O 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 PWMD
502. 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 causes a memory management fault and the fault handler is activated This driver is contained in driverlib mpu c with driverlib mpu h containing the API defi nitions for use by applications 18 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 unsigned long ulRegion unsigned long ulAddr unsigned long ulFlags September 05 2012 271 Memory Protection Unit MPU 18 2 1 18 2 2 18 2 2 1 272 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 cal
503. resents GPIO port pin 1 and so on Note This function cannot be used to turn any pin into an LPC pin it only configures an LPC pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None September 05 2012 169 GPIO 12 2 2 31 GPIOPinTypePECIRx Configures a pin for receive use by the PECI module Prototype void GPIOPinTypePECIRx 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 PECI receive pin must be properly configured for the PECI module to function correctly This function provides a typical configuration for that pin The pin is 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 function cannot be used to turn any pin into a PECI receive pin it only configures a PECI receive pin for proper operation Devices with flexible pin muxing also require a GPIOPinCon figure function call Returns None 12 2 2 32 GPIOPinTypePECITx Configures a pin for transmit use by the PECI module Prototype void GPIOPinTypePECITx unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed repres
504. reverse direction September 05 2012 325 Quadrature Encoder QE 22 2 2 3 22 2 2 4 22 2 2 5 QEIDisable Disables the quadrature encoder Prototype void QETIDisable unsigned long ulBase Parameters ulBase is the base address of the quadrature encoder module Description This function disables 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 function enables operation of the quadrature encoder module The module must be con figured 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 function 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 September 05 2012 22 2 2 6 22 2 2 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 ba
505. ripheral 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 APB The ulGPIOPeripheral 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 SYSCTL_PERIPH_GPIOH or SYSCTL_PERIPH_GPIOJ Returns None 24 2 2 12 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 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 September 05 2012 353 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 SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOH or
506. ription 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 encode 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 T SSI_FRF_MOTO_MODE_3 The ulMode parameter defines the operating mode of the SSI module The SSI module can op erate as a master or slave if it is 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 SSL MODE_SLAVE_OD The u BitRate parameter defines the bit rate for the SSI This bit rate must satisfy the following clock ratio criteria FSSI gt 2 x bit rate master mode this speed cannot exceed 25 MHz m FSSI gt 12 x bit rate or 6 bit rate slave modes depending on the capability of the specific microcontroller where FSSI is the frequency of the clock supplied to the SSI module The u DataWidth parameter defines the width of the data transfers and can be a value between 4 and 16 inclusive September 05 2012 23 2 2 5 23 2 2 6
507. ris 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 September 05 2012 29 2 2 29 2 2 1 uDMA Controller UDMA_SEC_CHANNEL_UART1RX for UART1 receive UDMA_SEC_CHANNEL_UART1TX for UART1 transmit UDMA_SEC_CHANNEL_SSI1RX for SSI1 receive UDMA_SEC_CHANNEL_SSI1TX for SSI1 transmit UDMA_SEC_CHANNEL_UART2RX_12 for UART2 receive using UDMA channel 12 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_TMRY1A 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 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 Further some Stellaris parts provide up to five possible ch
508. rmed by writing a 32 to 96 bit password which has previously been set and committed by the user If a password is set on block 0 all other blocks in the device and the registers which control them are inaccessible until block 0 is unlocked At this point the protection set on each individual block applies with those blocks being individually lockable via their own passwords The EEPROM driver allows three specific protection modes to be set on each block These modes are defined by the following labels from eeprom h which define the protection provided if the block has no password set if it has a password set and is not unlocked and if it has a password set and is unlocked Additionally EEPROM_PROT_SUPERVISOR_ONLY may be ORed with each of these September 05 2012 73 EEPROM 6 1 1 1 6 1 1 2 6 1 1 3 6 2 74 labels when calling EERPROMBlockProtectSet to prevent all accesses to the block when the CPU is executing in user mode EEPROM PROT _RW_LRO_URW If no password is set for the block this protection level allows both read and write access to the block data If a password is set for the block and the block is locked this protection level allows only read access to the block data If a password is set for the block and the block is unlocked this protection level allows both read and write access to the block data EEPROM_PROT_NA_LNA_URW If no password is set for the block this protection level prev
509. rns Returns true if the specified peripheral is present and false if it is not 24 2 2 34 SysCtlPeripheralReady Determines if a peripheral is ready Prototype tBoolean SysCtlPeripheralReady unsigned long ulPeripheral Parameters ulPeripheral is the peripheral in question Description This function determines if a particular peripheral is ready to be accessed The peripheral may be in a non ready state if it is not enabled is being held in reset or is in the process of becoming ready after being enabled or taken out of reset The ulPeripheral ing values SYSCTL_PERIPH_CANO SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_EEPROMO SYSCTL_PERIPH_FANO SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOJ SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPIOQ param September 05 2012 eter must be only SYSCTL_PERIPH_ADCO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOK SYSCTL_PERIPH_GPION SYSCTL_PERIPH_HIBERNATE one of the follow SYSCTL_PERIPH_ADC1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_ETH SYSCTL_PERIPH_GPIOB SYSCTL_PERIPH_GPIOE SYSCTL_PERIPH_GPIOH SYSCTL_PERIPH_GPIOL SYSCTL_PERIPH_GPIOP SYSCTL_PERIPH_12CO 367 System Control SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2C4 SYSCTL_PERIPH_LPCO SYSCTL_PERIPH_PWM1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSIS SYSCTL_PERIPH_TIMER2 SYSCTL_
510. rns None 21 2 2 15 PWMGenlIntClear 312 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 This parameter must be one of PWM_GEN_0O PWM_GEN_1 PWM_GEN_2 or PWM_GEN_3 ullnts specifies the interrupts to be cleared Description This funciton clears the specified interrupt s by writing a 1 to the specified bits of the interrupt status register for the specified PWM generator The ullnts parameter 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 or PWM_INT_CNT_BD Note Because there is a write buffer in the Cortex M 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 September 05 2012 Pulse Width Modulator PWM 21 2 2 16 PWMGenIntRegister Registers an interrupt handler for the specified PWM generator block
511. rollers The u Flags parameter should be one of USB_EP_HOST_OUT USB_EP_HOST_IN USB_EP_ DEV_OUT or USB _EP_DEV IN Returns None 474 September 05 2012 USB Controller 30 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 As a result the 3 receive and 3 transmit DMA channels can 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 udma 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 has no effect Returns None 30 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
512. rotectGet Returns the current protection level for an EEPROM block Prototype u nsigned long EEPROMBlockProtectGet unsigned long ulBlock Parameters ulBlock is the block number for which the protection level is to be queried September 05 2012 81 EEPROM Description This function returns the current protection settings for a given EEPROM block If block 0 is currently locked it must be unlocked prior to calling this function to query the protection setting for other blocks Returns Returns one of EEPROM_PROT_RW_LRO_ URW EEPROM PROT _NA_LNA_URW or EEP ROM_PROT_RO_LNA_URO optionally OR ed with EEPROM_PROT_SUPERVISOR_ONLY 6 2 3 6 EEPROMBlockProtectSet Set the current protection options for an EEPROM block Prototype unsigned long EFEPROMBlockProtectSet unsigned long ulBlock unsigned long ulProtect Parameters ulBlock is the block number for which the protection options are to be set ulProtect consists of one of the values EEPROM_PROT_RW_LRO_URW EEP ROM_PROT_NA_LNA_URW or EEPROM_PROT_RO_LNA_URO optionally ORed with EEPROM_PROT_SUPERVISOR_ONLY Description This function sets the protection settings for a given EEPROM block assuming no protection settings have previously been written Note that protection settings applied to block 0 have special meaning and control access to the EEPROM peripheral as a whole Protection settings applied to blocks numbered 1 an
513. rototype 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 remains 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 configured with the MPURegionSet function Once enabled the memory protection rules of the region are applied and access violations cause a memory management fault 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 September 05 2012 275 Memory Protection Unit MPU 18 2 2 9 276 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 sa
514. rred in the fixed format part of a message CAN_STATUS LEC ACK a transmitted message was not acknowledged m CAN_STATUS LEC BIT1 dominant level detected when trying to send in recessive mode CAN_STATUS LEC BITO recessive level detected when trying to send in dominant mode CAN_STATUS_ LEC CRC CRC error in received message The remaining status registers consist of 32 bit wide 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 TXRQST bit is set a transmission is pending on that object The application can use this information to determine which objects are still waiting to send a message CAN_STS_NEWDAT if a message objects NEWDAT bit is set 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 objects MSGVAL bit is set the object has a valid configuration programmed The host application can use this information to determine which message objects are empty unused Returns Returns the value of the status register CAN Message Objects This section explains how to configure the CAN message objects in various modes using the CAN MessageSet and CANMessageGet APIs The configuration of a message object is determined by two parameters that are passed i
515. rrupt in the interrupt controller specific Ethernet interrupts must be enabled via EthernetintEnable It is the interrupt handler s responsibility to clear the interrupt source September 05 2012 95 Ethernet Controller 7 2 2 10 7 2 2 11 96 See also IntRegister for important information about registering interrupt handlers Returns None EthernetintStatus Gets the current Ethernet interrupt status 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 function 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 function disables the global interrupt in the interrupt controller so that the interrupt handler no longer is called See also IntRegister for importan
516. rrupt sources Only the sources that are enabled can be reflected to the processor interrupt disabled sources have no effect on the processor Note The interrupt sources vary based on the Stellaris part in use Please consult the data sheet for the part you are using to determine which interrupt sources are available Returns None 24 2 2 16 SysCtllntEnable Enables individual system control interrupt sources Prototype void SysCtlIntEnable unsigned long ullInts September 05 2012 355 System Control 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 Description This function 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 Note The interrupt sources vary based on the Stellaris part in use Please consult the data sheet for the part you are using to determine which interrupt sources are available Returns None 24 2 2 17 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 Des
517. rs If an operation is ongoing or an error occurred the return value is a logical OR combi nation of EEPROM_RC_INVPL EEPROM_RC_WRBUSY EEPROM_RC_NOPER M EEP ROM_RC_WKCOPY EEPROM_RC_WKERASE and EEPROM_RC_WORKING Programming Example The following example shows how to use the EEPROM API to write a block of data and read it back unsigned long pulData 2 unsigned long pulRead 2 Program some data into the EEPROM at address 0x400 pulData 0 0x12345678 pulData 1 0x56789abc EEPROMProgram pulData 0x400 sizeof pulData Read it back EEPROMRead pulRead 0x400 sizeof pulRead September 05 2012 7 7 1 7 2 Ethernet Controller Ethernet Controller MPOC HON wack asics teach aaa a a a a a a E ANAA 89 PAPUE ROG ann A NE AUR eR CEN cP RE CE 89 Programming Example ccucarreeckgompiseaweareeagonsens E aden reaenaenas 103 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 1OBASE T and 100BASE TX standards Some devices do not have an integrated PHY and can be used with an external PHY or multiple PHYs See the device data sheet for details The Ethernet API provides the set of functions required to implement an interrupt driven Ethernet driver for this Ethernet controller Functions are provided to
518. rupt on receipt e Set MSG_OBJ_USE_ID_FILTER flag to enable filtering based on the identifier mask specified by u MsgiDMask ulMsgLen the number of bytes in the message data This parameter should be non zero even for a remote frame it should match the expected bytes of data in the 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 7 Set eMsgObjType to MSG_OBJ_TYPE_ RX Set pMsgObject gt ulMsgID to the full message ID or a partial mask to use partial ID match ing Set pMsgObject gt ulMsgiDMask bits that should be used for masking during comparison 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 ena
519. s 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 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 September 05 2012 295 Peripheral Pin Mapping 20 2 2 5 20 2 2 6 296 See also GPIOPinTypeComparator in order to configure multiple comparator pins at once Returns None PinTypeEthernetLED Configures the specified Ethernet LED to function as an Ethernet LED pin Prototype void PinTypeEthernetLED unsigned long ulName Parameters ulName is one of the valid names for the Ethernet LED pins Description This function takes one of the valid names for an Ethernet LED pin and configures the pin for its Ethernet LED functionality depending on the part that
520. s by setting the specified bits of the interrupt enable register for the selected PWM module Returns None 21 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 is returned 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 21 2 2 26 PWMOutputFault Specifies the state of PWM outputs in response to a fault condition Prototype void PWMOutputFault unsigned long ulBase September 05 2012 317 Pulse Width Modulator PWM unsigned long ulPWMOutBits tBoolean bFaultSuppress Parameters ulBase is the base address of the PWM module ulPWMOutBits are the PWM outputs to be modified This parameter 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
521. s 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 Information 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 d
522. s actually removed or it may not be removed at all For this reason the processor continues 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 HibernateLowBat Set function was used to configure an abort if low battery is detected then the power is not 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 13 2 2 22 HibernateRTCDisable Disables the RTC feature of the Hibernation module Prototype void HibernateRTCDisable void Description This function disables the RTC in the Hibernation module After calling this function the RTC features of the Hibernation module are not available Returns None September 05 2012 191 Hibernation Module 13 2 2 23 HibernateRTCEnable Enables the RTC feature of the Hibernation module Prototype void HibernateRTCEnable void Description This function 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 be
523. s 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 September 05 2012 273 Memory Protection Unit MPU 18 2 2 4 162 23 18 2 2 6 274 Description This function sets and enables the handler to be called when the MPU generates a memory management 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 disables and clears the handler to be called when a memory management fault occurs See also IntRegister 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 total number of regions that are supported by the MPU 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 September 05 2012 18 2 2 7 18 2 2 8 Memory Protection Unit MPU P
524. s indicates which interrupt sources to clear Currently the only valid value is EEP ROM_INT_PROGRAM Description This function allows an application to clear the EEPROM interrupt Note Because there is a write buffer in the Cortex M 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 EEPROMIntDisable Disables the EEPROM interrupt Prototype void EFEPROMIntDisable unsigned long ullIntFlags Parameters ullntFlags indicates which EEPROM interrupt source to disable This must be EEP ROM_INT_PROGRAM currently Description This function disables the EEPROM interrupt and prevents calls to the interrupt vector when any EEPROM write or erase operation completes The EEPROM peripheral shares a single interrupt vector with the flash memory subsystem NT_FLASH This function is provided as a September 05 2012 6 2 3 11 6 2 3 12 EEPROM convenience but the EEPROM interrupt can also be disabled using a call to FlashIntDisable passing FLASH_INT_EEPROM in the ullntFlags parame
525. s 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 which must be between 0 and 255 inclusive for 16 32 bit timers and between 0 and 65535 inclusive for 32 64 bit timers Description This function configures the value of the input clock prescaler The prescaler is only opera tional when in half width mode and is used to extend the range of the half width timer modes The prescaler provides the least significant bits when counting down in periodic and one shot modes in all other modes the prescaler provides the most significant bits Note The availability of the prescaler varies with the Stellaris part and timer mode in use Please consult the datasheet for the part you are using to determine whether this support is available Returns None 27 2 2 2 7 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 Returns None 27 2 2 28 TimerRTCEnable 404 Enable RTC counting Prototype void TimerRTCEnable unsigned long ulBase September 05 2012 Timer 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 f
526. s off the Ethernet PHY Prototype void EthernetPHYPowerOff unsigned long ulBase Parameters ulBase is the base address of the controller Description This function powers off the Ethernet PHY reducing the current consumption of the device While in the powered off state the Ethernet controller is 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 September 05 2012 101 Ethernet Controller 1 2 2 22 7 2 2 23 102 Description This function powers on the Ethernet PHY enabling it return to normal operation By default the PHY is powered on so this function is only 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 ucRegAdar is the address of the PHY register to be accessed Description This function returns the contents of the PHY register specified by ucRegAddar Returns Returns the 16 bit value read from the PHY EthernetPHYWrite Writes to the PHY register Prototype void EthernetPHYWrite unsigned long ulBase unsigned char ucRegAddr unsigned long ulData Parameters
527. s specified by u Ref It must be one of ADC_REF_INT ADC_REF_EXT_3V or ADC_REF_EXT_1V 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 If ADC_REF_EXT_1V is chosen then a 1V external 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 ADCResolutionGet Gets the setting of ADC resolution Prototype unsigned long ADCResolutionGet unsigned long ulBase Parameters ulBase is the base address of the ADC module Description The ADC resolution is returned as one of ADC_RES_12BIT or ADC_RES_10BIT Note The value returned by this function is only meaningful if used on a part that is capable of changing ADC resolution mode Consult the data sheet for your part to determine if it is capable of operating in more than one resolution mode Returns The current setting of the ADC resolution ADCResolutionSet Selects the ADC resolution September 05 2012 35 Analog to Digital Converter ADC 4 2 2 22 36 Prototype void ADCResolutionSet unsigned long ulBase unsigned long ulResolution Parameters ulBase is the base address of the ADC module ulResolution
528. s support is available Returns The value of the timer prescale match 27 2 2 25 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 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 which must be between 0 and 255 inclusive for 16 32 bit timers and between 0 and 65535 inclusive for 32 64 bit timers Description This function configures the value of the input clock prescaler match value When in a half width mode that uses the counter match and the prescaler the prescale match effectively extends the range of the match The prescaler provides the least significant bits when counting down in periodic and one shot modes in all other modes the prescaler provides the most significant bits Note The availability of the prescaler match varies with the Stellaris part and timer mode in use Please consult the datasheet for the part you are using to determine whether this support is available Returns None 27 2 2 26 TimerPrescaleSet Set the timer prescale value September 05 2012 403 Timer Prototype void TimerPrescaleSet unsigned long ulBase unsigned long ulTimer unsigned long ulValue Parameters ulBase is the base addres
529. s the SSI module base address pfnHandler is a pointer to the function to be called when the synchronous serial interface interrupt occurs Description This function registers the handler to be called when an SSI interrupt occurs This function enables the global interrupt in the interrupt controller specific SSI interrupts must be enabled via SSlIntEnable If necessary it is the interrupt handler s responsibility to clear the interrupt source via SSllntClear See also IntRegister for important information about registering interrupt handlers Returns None 342 September 05 2012 Synchronous Serial Interface SS 23 2 2 17 SSlilntStatus Gets the current interrupt status Prototype unsigned long SSIIntStatus unsigned long ulBase tBoolean bMasked 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 23 2 2 18 SSllntUnregister Unregisters an interrupt handler for the synchronous serial interface Prototype void SSIIntUnregister unsigned long ulBase Parameters ulBase spe
530. s the SysTick counter to 0 and causes a reload with the u Period supplied here on the next clock after SysTick is enabled Returns None 26 2 2 9 SysTickValueGet Gets the current value of the SysTick counter Prototype unsigned long SysTickValueGet void 386 September 05 2012 System Tick SysTick Description This function returns the current value of the SysTick counter which is a value between the period 1 and zero inclusive Returns Returns the current value of the SysTick counter 26 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 September 05 2012 387 System Tick SysTick 388 September 05 2012 27 27 1 Timer Timer WRT SON anea a a Rea ibd beading bed adn eb ie be ae denen keke 389 Pr iPM CHOU 6 tance ee ec aah E tin tease came bees abana eee an ieee eter heres 390 Programming Example ccc cannpenaeaein pis enedscemeegemeears OeGeaneeee GoeGerseugusncreeabedeeneeamaatas 407 Introduction The timer API provides a set of functions for using the timer module Functions are provided to configure and control the timer modify timer counter values and manage timer i
531. s 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 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 int
532. sGet unsigned long ulBase unsigned long xpulCount unsigned long pulPoolSize unsigned long LPCWordRead unsigned long ulBase unsigned long ulOffset void LPCWordWrite unsigned long ulBase unsigned long ulOffset unsigned long ulData Function Documentation LPCByteRead Reads a byte from the LPC channel pool Prototype unsigned char LPCByteRead unsigned long ulBase unsigned long ulOffset Parameters ulBase specifies the LPC module base address ulOffset specifies the offset from the beginning of the LPC channel pool Description This function reads a byte from the channel pool Returns Returns the byte read from the pool memory September 05 2012 Low Pin Count Interface LPC 17 2 1 2 LPCByteWrite Writes a byte to the LPC channel pool Prototype void LPCByteWrite unsigned long ulBase unsigned long ulOffset unsigned char ucData Parameters ulBase specifies the LPC module base address ulOffset specifies the offset from the beginning of the LPC channel pool ucData specifies the byte to write Description This function writes a byte to the channel pool Returns None 17 2 1 3 LPCChannelConfigCOMxSet Sets the configuration of an LPC Channel as a COMx Prototype void LPCChannelConfigCOMxSet unsigned long ulBase unsigned long ulChannel unsigned long ulConfig unsigned long ulAddress unsigned long ulOffset unsigned long ulCOMxMode Parameters ulBase
533. sample first If the receive mode is 128 MODE_COMPACT_STEREO_16 or 128 MODE_COMPACT_STEREO 8 then the returned data contains both the left and right samples If the receive mode is 128 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 waits in a polling loop until data is available Returns None 15 2 2 10 l2SRxDataGetNonBlocking Reads data 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 September 05 2012 229 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 28 _MODE_DUAL_STEREO then the received data contains either the left or right samp
534. se unsigned long xpulTxLevel unsigned long xpulRxLevel Parameters ulBase is the base address of the UART port pulTxLevel is a pointer to storage for the transmit FIFO 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 28 2 2 25 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 422 September 05 2012 UART Description This function configures the FIFO level at which transmit and receive interrupts are generated Returns None 28 2 2 26 UARTFlowControlGet Returns the UART hardware flow control mode currently in use Prototype unsigned long
535. se address of the quadrature encoder module ullntFlags is a bit mask of the interrupt sources to be cleared This parameter can be any of the QELINTERROR QEI_INTDIR QEl_INTTIMER or QEL_INTINDEX values Description The specified quadrature encoder interrupt sources are cleared so that they no longer assert This function must be called in the interrupt handler to keep the interrupt from being triggered again immediately upon exit Note Because there is a write buffer in the Cortex M 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 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 This parameter can be any of the QELINTERROR QEI_INTDIR QEl_INTTIMER or QEL_INTINDEX values Description This function disables the indicated quadrature encoder interru
536. sentation 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 function cannot be used to turn any pin into a 12S pin it only configures a I2S pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 30 GPIOPinTypeLPC Configures pin s for use by the LPC module Prototype void GPIOPinTypeLPC 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 LPC pins must be properly configured for the LPC module 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 rep
537. ses 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 15 2 2 16 l2STxConfigSet Configures the I2S transmit module Prototype void I2STxConfigSet unsigned long ulBase unsigned long ulConfig Parameters ulBase is the l2S 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 m 12S CONFIG_SCLK_INVERT to invert the polarity of the serial bit clock 232 September 05 2012 Inter IC Sound 12S 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 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 number of bits per word that are transferred on the data line m
538. ses 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 resolution if required In either mode the input signals can be swapped before being processed allowing wiring mistakes to be corrected without modifying the circuit board The index pulse can be used to reset the position counter allowing 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 generates interrupts when the
539. set and the block is unlocked and read only access when a password is set but the block is locked EEPROM_PROT_SUPERVISOR_ONLY Definition define EEPROM _PROT_SUPERVISOR_ONLY Description This bit may be ORed with the protection option passed to EERPROMBlockProtectSet or re turned from EEPROMBlockProtectGet It restricts EEPROM access to threads running in supervisor mode and prevents access to an EEPROM block when the CPU is in user mode EEPROM_RC_INVPL Definition define EEPROM _RC_INVPL September 05 2012 77 EEPROM 6 2 2 10 6 2 2 11 6 2 2 12 6 2 2 13 78 Description This return code bit indicates that the EEPROM programming state machine failed to write a value due to the voltage level dropping below that required for EEPROM programming The operation may be retried once the voltage stabilizes EEPROM_RC_NOPERM Definition define EEPROM _RC_NOPERM Description This return code bit indicates that an attempt was made to write a value but the destination permissions disallow write operations This may be due to the destination block being locked access protection set to prohibit writes or an attempt to write a password when one is already written EEPROM_RC_WKCOPY Definition define EEPROM _RC_WKCOPY Description This return code bit indicates that the EEPROM programming state machine is currently copy ing to or from the internal copy bu
540. sible at all and another 128 KB region that is accessible from user mode Define a 28 KB region of flash from 0x00000000 to 0x00007000 The region is executable and read only for both privileged and user modes To set up the region a 32 KB region 0 is defined starting at address 0 and then a 4 KB hole removed at the end by disabling the last sub region The region is 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 is not executable and is read write access for privileged and user modes fil MPURegionSet 1 0x20000000 MPU_RGN_SIZE_32K MPU_RGN_PERM_NOEXEC MPU_RGN_PERM_PRV_RW_USR_RW MPU_RGN_ENABLBE if Define an additional 8 KB region 2 in RAM from 0x20008000 to 0x2000A000 that is read write accessible only from privileged mode This region is initially disabled to be enabled later September 05 2012 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 an area from 0x40020000 to 0x40040000 that has no peripherals and is not accessible
541. signaled on the peripheral s interrupt Returns None 29 2 3 11 uDMAChannelScatterGatherSet Configures a uUDMA channel for scatter gather mode September 05 2012 447 uDMA Controller Prototype void uDMAChannelScatterGatherSet unsigned long ulChannelNum unsigned ulTaskCount void xpvTaskList unsigned long ullIsPeriphsSG 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 is memory 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 must pass a pointer to the start of the task list as the pv7askList parameter The u TaskCount parameter is the count of tasks in the task list not the size of the task list The flag blsPeriphSG should be used to indicate if scatter gather should be configured for peripheral or memory operation See also uDMATaskStructEntry Returns None 29 2 3 12 uDMAChannelSelectDefault Selects the default peripheral for a set of UDMA channels Prototype void uDMAChannelSelectDefault unsigned long ulDefPeriphs Parameters ulDefPeriphs is the logical OR of the uDMA channels for which to use the default peripheral instead of the secondary periph
542. signed 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 unsigned 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 12STxDisable 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 IASTxFIF
543. signed long ulSequenceNum void x 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 function enables 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 ADCIntClear See also IntRegister for important information about registering interrupt handlers Returns None September 05 2012 31 Analog to Digital Converter ADC 4 2 2 13 4 2 2 14 4 2 2 15 32 ADClntStatus Gets the current interrupt status Prototype unsigned long ADCIntStatus unsigned long ulBase 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 status is required and true if the masked interrupt status is required Description This function 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 AD
544. signed long xpulOffset unsigned long pulCOMxMode Parameters ulBase specifies the LPC module base address ulChannel specifies the LPC channel to configure pulOffset is a pointer to storage for the channel pool offset pulAddress is a pointer to storage for the channel bus address pulCOMxMode is a pointer to storage for the channel COMx mode Description This function determines and returns the configuration for the specified channel Returns Returns the bit mapped channel control register value September 05 2012 17 2 1 6 17 2 1 7 Low Pin Count Interface LPC LPCChannelConfigMBSet Sets the configuration of an LPC Channel as a mailbox Prototype void LPCChannelConfigMBSet unsigned long ulBase unsigned long ulChannel unsigned long ulConfig u u unsigned long ulAddress unsigned long ulOffset Parameters ulBase specifies the LPC module base address ulChannel specifies the LPC channel to configure ulConfig specifies configuration options required for the endpoint ulOffset specifies the offset from the beginning of the buffer pool for this endpoint s data ulAddress specifies the LPC bus address IO and or MEM for this channel Description This function enables the specified LPC Channel as a mailbox Returns None LPCChannelDisable Disables an LPC Channel Prototype void LPCChannelDisable unsigned long ulBase unsigned long ulChannel
545. so on Note This function cannot be used to turn any pin into an I2C pin it only configures an 12C pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 28 GPIOPinTypel2CSCL Configures pin s for use as SCL by the 12C peripheral Prototype void GPIOPinTypel2CSCL 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 the SCL 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 function should only be used for Blizzard class devices It cannot be used to turn any pin into an 12C SCL pin it only configures an I2C SCL pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call Returns None 12 2 2 29 GPIOPinTypel2S Configures pin s for use by the I2S peripheral 168 September 05 2012 GPIO Prototype void GPIOPinTypel2S unsigned long ulPort unsigned char ucPins Parameters ulPort is the base address of the GPIO port ucPins is the bit packed repre
546. 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 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 simply calls ROM_Function otherwise it calls 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 September 05 2012 Using the ROM include driverlib systick h void SetupSysTick void MAP_SysTickPeriodSet 0x1000 Map_SysTickEnable When built for a device that does not have a ROM this example is equivalent to include driverl
547. specifies the LPC module base address ulChannel specifies the LPC channel to configure ulConfig specifies configuration options required for the endpoint ulOffset specifies the offset from the beginning of the buffer pool for this endpoint s data ulAddress specifies the LPC bus address IO and or MEM for this channel ulCOMxMode specifies the COMx mode to be used Description The specified LPC Channel is enabled as a COMx Returns None September 05 2012 253 Low Pin Count Interface LPC 17 2 1 4 17 2 1 5 254 LPCChannelConfigEPSet Sets the configuration of an LPC Channel as an endpoint Prototype void LPCChannelConfigEPSet unsigned long ulBase unsigned long ulChannel unsigned long ulConfig u u unsigned long ulAddress unsigned long ulOffset Parameters ulBase specifies the LPC module base address ulChannel specifies the LPC channel to configure ulConfig specifies configuration options required for the endpoint ulOffset specifies the offset from the beginning of the buffer pool for this endpoint s data ulAddress specifies the LPC bus address IO and or MEM for this channel Description This function enables the specified LPC Channel as an endpoint Returns None LPCChannelConfigGet Gets the configuration of an LPC Channel Prototype unsigned long LPCChannelConfigGet unsigned long ulBase unsigned long ulChannel unsigned long xpulAddress un
548. ssage objects have pending transmission requests m Which message objects are allocated for use Data Structure Documentation tCANBitClkParms Definition typedef struct September 05 2012 Controller Area Network CAN unsigned long ulSyncPropPhaselSeg unsigned long ulPhase2Seg unsigned long ulSJW unsigned long ulQuantumPrescaler tCANBitClkParms Members ulSyncPropPhase1Seg 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 ulPhase2Seg This value holds the Phase Buffer 2 segment in time quanta The valid values for this setting range from 1 to 8 ulSJW This value holds the Resynchronization Jump Width in time quanta The valid values for this setting range from 1 to 4 ulQuantumPrescaler 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 values 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 b
549. stalled 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 take 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 includ
550. stops reading when the FIFO fills up and resumes 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 Description 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 September 05 2012 External Peripheral Interface EPI 8 3 Programming Example This example illustrates the setup steps required to initialize the EPI to access the SDRAM provided with the DK LM3S9B96 board when the system clock is running at 50MHz Set the EPI divider if EPIDividerSet EPIO
551. sy 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 2CMasierErr unsigned long ulBase void 2CMaster InitExpClk unsigned long ulBase unsigned long ull2CClk tBoolean bFast void I2CMasterlntClear unsigned long ulBase void I2CMasterlntClearEx unsigned long ulBase unsigned long ullntFlags void I2CMasterIntDisable unsigned long ulBase September 05 2012 Inter Integrated Circuit 12C void I2CMasterlntDisableEx unsigned long ulBase unsigned long ullntFlags void I2CMasterlntEnable unsigned long ulBase void I2CMasterlntEnableEx unsigned long ulBase unsigned long ullntFlags tBoolean 2CMasterIntStatus unsigned long ulBase tBoolean bMasked unsigned long 2CMasterIntStatusEx unsigned long ulBase tBoolean bMasked unsigned long 2CMasterLineStateGet unsigned long ulBase void 2CMasterSlaveAddrSet unsigned long ulBase unsigned char ucSlaveAddr tBoolean bReceive void I2CMasterTimeoutSet unsigned long ulBase unsigned long ulValue void I2CSlaveACKOverride unsigned long ulBase tBoolean bEnable void I2CSlaveACK ValueSet unsigned long ulBase tBoolean bACK void I2CSlaveAddressSet unsigned long ulBase unsi
552. t 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 Description This function unregisters the handler to be called when a timer interrupt occurs This function also masks 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 27 2 2 15 TimerLoadGet 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 full width operation Description This function gets the currently programmed interval load value for the specified timer Note This function can be used for both full and half width modes of 16 32 bit timers and for half width modes of 32 64 bit timers Use TimerLoadGet64 for full width modes of 32 64 bit timers 398 September 05 2012 Timer Returns Returns the load value for the timer 27 2 2 16 TimerLoadGet64 Gets the timer load value for a 64 bit timer Prototype unsigned long long TimerLoadGet 64 unsigned long ulBase
553. t for an interrupt to indicate that the battery level is low Note A hibernation request is held off if a battery check is in progress This function is only available on some Stellaris devices Returns None HibernateClockConfig Configures the clock input for the Hibernation module Prototype void HibernateClockConfig unsigned long ulConfig Parameters ulConfig is one of the possible configuration options for the clock input listed below Description This function is used to configure the clock input for the Hibernation module The u Config parameter can be one of the following values HIBERNATE_OSC_ DISABLE specifies that the internal oscillator is powered off and either an externally supplied clock source or no clock source is being used HIBERNATE_OSC_HIGHDRIVE specifies a higher drive strength when a 24pF filter ca pacitor is used with a crystal a HIBERNATE_OSC_LOWDRIVE specifies a lower drive strength when a 12pF filter capac itor is used with a crystal The HIBERNATE_OSC_DISABLE option is used to disable and power down the internal os cillator if an external clock source or no clock source is used instead of a 32 768 kHz crystal In the case where an external crystal is used either the HIBERNATE_OSC_HIGHDRIVE or HIBERNATE_OSC_LOWDRIVE is used This optimizes the oscillator drive strength to match the size of the filter capacitor that is used with the external crystal circuit September 05 2012 13 2
554. t handling support Note Because there is a write buffer in the Cortex M 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 September 05 2012 21 2 2 4 21 2 2 5 Pulse Width Modulator PWM 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 This function 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_FAULTS3 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 inp
555. t information about registering interrupt handlers Returns None 16 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 ff extern void IntHandler void Register the interrupt handler function for interrupt 5 IntRegister 5 IntHandler if Enable interrupt 5 IntEnable 5 Enable interrupt 5 IntMasterEnable September 05 2012 249 Interrupt Controller NVIC 250 September 05 2012 Low Pin Count Interface LPC 17 Low Pin Count Interface LPC MOCOCA a a dine adadee E E D 251 APURO NOIS saone Onur nacaies anieaca lind a ena eRe DR eee aeaaed AUREUS aes mone 251 17 1 Introduction The LPC API provides functions to use the LPC module available in the Stellaris family of micro controllers The LPC module provides for up to 8 channels on the LPC bus including one channel which can be configured as a COMx port Some features of the LPC module are m configurable channel type endpoint mailbox m configurable channel pool size m interrupt and uDMA support This driver is contained in driverlib lpc c with driverlib lpc h containing the API defi nitions for use by applications 17 2 API Functions Functions unsigned char LPCByteRead unsigned long ulBase unsigned long ulOffset void LPCByteWrite unsigned long ulBase unsign
556. t information about registering interrupt handlers Returns None September 05 2012 7 2 2 12 7 2 2 13 Ethernet Controller EthernetMACAddrGet Gets the MAC address 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 Description This function reads the currently programmed MAC address into the pucMACAdoar buffer See also Refer to EthernetWACAddrSet 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 pucMACAddr is the pointer to the array of MAC 48 address octets Description This function programs 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
557. t notification of fan events The fan controller allows an application to set the desired cooling fan speed and the speed is maintained without further intervention from the application software The application can also choose to be notified by an interrupt when certain events occur such as fan stall or fan reaching a commanded speed A FAN channel can also be manually controlled by directly specifying the PWM duty cycle This driver is contained in driverlib fan c with driverlib fan h containing the API defi nitions for use by applications API Functions Functions m void FanChannelConfigAuto unsigned long ulBase unsigned long ulChannel unsigned long ulConfig void FanChannelConfigManual unsigned long ulBase unsigned long ulChannel unsigned long ulConfig void FanChannelDisable unsigned long ulBase unsigned long ulChannel unsigned long FanChannelDutyGet unsigned long ulBase unsigned long ulChannel void FanChannelDutySet unsigned long ulBase unsigned long ulChannel unsigned long ul Duty void FanChannelEnable unsigned long ulBase unsigned long ulChannel unsigned long FanChannelRPMGet unsigned long ulBase unsigned long ulChannel September 05 2012 123 Fan Controller 9 2 1 124 void FanChannelRPMSet unsigned long ulBase unsigned long ulChannel unsigned long ulRPM unsigned long FanChannelsGet unsigned long ulBase unsigned long FanChannelStatus unsigned long ulBase unsigned long ulChannel
558. t the datasheet for the part you are using to determine whether this support is available Returns None 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 Description This function does the actual unregistering of the interrupt handler This function clears the handler to be called when a watchdog timer interrupt occurs This function also masks 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 Note For parts with a watchdog timer module that has the ability to generate an NMI instead of a standard interrupt this function unregisters the standard watchdog interrupt handler To unregister the NMI watchdog handler use IntUnregister to unregister the handler for the FAULT_NMI interrupt September 05 2012 505 Watchdog Timer 31 2 2 8 31 2 2 9 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 This function locks out write access to the watchdog timer configuration registers Returns None WatchdogLockState Gets the state of the watchdog ti
559. t the speed reading This parameter can be configured using the configuration flags FAN_CONFIG_AVG_NONE for no speed averaging or FAN_CONFIG_AVG_2 etc to select the number of speed samples to use for averaging Tachometer rate different cooling fans may have a different number of tachometer pulses per revolution This parameter can be configured using the configuration flags FAN_TACH_1 FAN_TACH_2 etc following options are available in manual mode Speed averaging the speed measurement can be averaged over several samples in order to smooth out the speed reading This parameter can be configured using the configuration flags FAN_CONFIG_AVG_NONE for no speed averaging or FAN_CONFIG_AVG_2 etc to select the number of speed samples to use for averaging Tachometer rate different cooling fans may have a different number of tachometer pulses per revolution This parameter can be configured using the configuration flags FAN_TACH_1 FAN_TACH_2 etc Function Documentation FanChannelConfigAuto Configures a FAN channel for automatic operation Prototype void FanChannelConfigAuto unsigned long ulBase unsigned long ulChannel unsigned long ulConfig Parameters ulBase is the base address of the FAN module September 05 2012 125 Fan Controller ulChannel is the FAN channel to configure ulConfig is the logical OR of configuration flags Description This function configures a specific FAN channel to o
560. table in the application s startup code When statically configured the interrupts must be explicitly enabled in the NVIC via IntEnable before the processor can 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 because 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 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 called by the application Run time configuration of interrupts adds a small latency to the interrupt response time because the stacking operation a write to SRAM and the interrupt handler table fetch a read from SRAM must be performed sequentially September 05 2012 241 Interrupt Controller NVIC 16 2 16 2 1 242 Run time configuration of interrupt handlers requires that the interrupt handler table be placed on a 1 kB boundary in SRAM typically this is at the beginning of SRAM Failure to do so results in an incorrect vector address being fetched in response to an in
561. tained only until the next reset This protocol allows the application to be executed in the desired flash protection environment to check for inappro priate flash access via the flash interrupt To make the flash protection permanent use the FlashProtectSave function Returns Returns 0 on success or 1 if an invalid address or an invalid protection was specified 10 2 2 12 FlashUsecGet Gets the number of processor clocks per micro second Prototype unsigned long FlashUsecGet void Description This function returns the number of clocks per micro second as presently known by the flash controller This function is only valid on Sandstorm and Fury class devices Returns Returns the number of processor clocks per micro second 10 2 2 13 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 This function is only valid on Sandstorm and Fury class devices September 05 2012 141 Flash Returns None 10 2 2 14 FlashUserGet Gets the user registers Prototype long FlashUserGet unsigned long pulUser0O unsigned long xpu
562. tatus Prototype void uDMAIntClear unsigned long ulChanMask 454 September 05 2012 uDMA Controller Parameters ulChanMask is a 32 bit mask with one bit for each UDMA channel Description This function clears bits in the uDMA interrupt status register according to which bits are set in ulChanMask There is one bit for each channel If a a bit is set in u ChanMask then that corresponding channel s interrupt status is cleared if it was set Note This function is only available on devices that have the DMA Channel Interrupt Status Register DMACHIS Please consult the data sheet for your part Returns None 29 2 3 24 uDMAIntRegister Registers an interrupt handler for the uDMA controller Prototype void uDMAIntRegister unsigned long ulIntChannel void x pfnHandler void Parameters ullntChannel identifies which uDMA interrupt is to be registered pfnHandler is a pointer to the function to be called when the interrupt is activated Description This function registers and enables the handler to be called when the uDMA controller gener ates an interrupt 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
563. tchdogEnable unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description This function enables the watchdog timer counter and interrupt Note This function has no effect if the watchdog timer has been locked See also WatchdogLock WatchdogUnlock Returns None September 05 2012 31 2 2 2 31 2 2 3 Watchdog Timer WatchdogIntClear Clears the watchdog timer interrupt Prototype void WatchdogIntClear unsigned long ulBase Parameters ulBase is the base address of the watchdog timer module Description The watchdog timer interrupt source is cleared so that it no longer asserts Note Because there is a write buffer in the Cortex M 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 This function enables th
564. ter Returns None EEPROMIntEnable Enables the EEPROM interrupt Prototype void EFEPROMIntEnable unsigned long ullIntFlags Parameters ullntFlags indicates which EEPROM interrupt source to enable This must be EEP ROM_INT_PROGRAM currently Description This function enables the EEPROM interrupt When enabled an interrupt is generated when any EEPROM write or erase operation completes The EEPROM peripheral shares a single interrupt vector with the flash memory subsystem INT_FLASH This function is provided as a convenience but the EEPROM interrupt can also be enabled using a call to FlashintEnable passing FLASH_INT_EEPROM in the ullntFlags parameter Returns None EEPROMIntStatus Reports the state of the EEPROM interrupt Prototype unsigned long EREPROMIntStatus tBoolean bMasked Parameters bMasked determines whether the masked or unmasked state of the interrupt is to be returned If bMasked is true the masked state is returned otherwise the unmasked state is returned Description This function allows an application to query the state of the EEPROM interrupt If active the interrupt may be cleared by calling EEPROMIntClear Returns Returns EEPROM_INT_PROGRAM if an interrupt is being signaled or 0 otherwise September 05 2012 85 EEPROM 6 2 3 13 6 2 3 14 6 2 3 15 86 EEPROMMassErase Erases the EEPROM and returns it to the factory default condition
565. ter 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 Description This function ensures that the interrupt handler specified by pfnintHandler is called when an interrupt is detected from the selected GPIO port This function also enables the corresponding GPIO interrupt in the interrupt controller individual pin interrupts and interrupt sources must be enabled with GPIOPinIntEnable September 05 2012 175 GPIO See also IntRegister for important information about registering interrupt handlers Returns None 12 2 2 42 GPlOPortIntUnregister 12 3 176 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 unregisters the interrupt handler for the specified GPIO port This function also disables the corresponding GPIO port interrupt in the interrupt controller individual GPIO in terrupts 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 if
566. termine if this feature is available Returns None 24 2 2 32 SysCtlPeripheralPowerOn Powers on a peripheral Prototype void SysCtlPeripheralPowerOn unsigned long ulPeripheral Parameters ulPeripheral is the peripheral to be powered on Description This function turns on the power to a peripheral The peripheral continues to receive power even when its clock is not enabled The ing ulPeripheral values parameter must be only SYSCTL_PERIPH_ADCO September 05 2012 one of the follow SYSCTL_PERIPH_ADC1 365 System Control SYSCTL_PERIPH_CANO SYSCTL_PERIPH_COMPO SYSCTL_PERIPH_CAN1 SYSCTL_PERIPH_COMP1 SYSCTL_PERIPH_CAN2 SYSCTL_PERIPH_COMP2 SYSCTL_PERIPH_EEPROMO SYSCTL_PERIPH_FANO SYSCTL_PERIPH_GPIOC SYSCTL_PERIPH_GPIOF SYSCTL_PERIPH_GPIOu SYSCTL_PERIPH_GPIOM SYSCTL_PERIPH_GPIOQ SYSCTL_PERIPH_I2C1 SYSCTL_PERIPH_I2C4 SYSCTL_PERIPH_LPCO SYSCTL_PERIPH_PWM1 SYSCTL_PERIPH_SSIO SYSCTL_PERIPH_SSI3 SYSCTL_PERIPH_TIMER2 SYSCTL_PERIPH_TIMERS SYSCTL_PERIPH_UART2 SYSCTL_PERIPH_UART5 SYSCTL_PERIPH_UARTE6 SYSCTL_PERIPH_UDMA SYSCTL_PERIPH_USBO SYSCTL_PERIPH_WDOG1 SYSCTL_PERIPH_WTIMERO SYSCTL_PERIPH_WTIMER1 SYSCTL_PERIPH_WTIMER2 SYSCTL_PERIPH_WTIMER3 SYSCTL_PERIPH_WTIMER4 or SYSCTL_PERIPH_WTIMERS5 SYSCTL_PERIPH_EPIO SYSCTL_PERIPH_GPIOA SYSCTL_PERIPH_GPIOD SYSCTL_PERIPH_GPIOG SYSCTL_PERIPH_GPIOK SYSCTL_PERIPH_GPION SYSCTL_PERIPH_HIBERNATE SYSCTL_PERIPH_
567. terrupt 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 unsigned long IntlsEnabled 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 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
568. terrupt occurs See also IntRegister for important information about registering interrupt handlers Returns None SysTickintUnregister Unregisters the interrupt handler for the SysTick interrupt Prototype void SysTickIntUnregister void Description This function unregisters the handler to be called when a SysTick interrupt occurs See also IntRegister for important information about registering interrupt handlers September 05 2012 385 System Tick SysTick Returns None 26 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 which equates to the number of processor clocks between interrupts Returns Returns the period of the SysTick counter 26 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 and must be between 1 and 16 777 216 inclusive Description This function sets the rate at which the SysTick counter wraps which 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 clear
569. terrupts if the interrupt is enabled for the selected pin Note This function is not available on all devices consult the data sheet to ensure that the device you are using supports GPIO DMA Control Returns None GP1 OIntTypeGet 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 edges 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 September 05 2012 GPIO 12 2 2 8 GPlOlIntTypeSet Sets the interrupt type for the specified pin s Prototype 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
570. th operation ulValue is the match value Description This function configures the match value for a timer This value 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 On some Stellaris devices match interrupts can also be generated in periodic and one shot modes Note This function can be used for both full and half width modes of 16 32 bit timers and for half width modes of 32 64 bit timers Use TimerMatchSet64 for full width modes of 32 64 bit timers Returns None 27 2 2 22 TimerMatchSet64 Sets the timer match value for a 64 bit timer Prototype void TimerMatchSet 64 unsigned long ulBase unsigned long long ullValue Parameters ulBase is the base address of the timer module September 05 2012 401 Timer ullValue is the match value Description This function configures the match value for a timer This value 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 27 2 2 23 TimerPrescaleGet Get the timer prescale value 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
571. that can be one of the following values GPIO_FALLING_EDGE GPIO_RISING_EDGE GPIO_ BOTH EDGES GPIO_LOW_LEVEL GPIO_HIGH_ LEVEL GPIO_DISCRETE_INT 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 Some devices also support discrete interrupts for each pin on a GPIO port giving each pin a separate interrupt vector To use this feature the GPIO_DISCRETE_INT can be included to enable an interrupt per pin The GPIO_DISCRETE_INT is not available on all devices or all GPIO ports consult the data sheet to ensure that the device and the GPIO port supports discrete interrupts 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 12 2 2 9 GPlOPadConfigGet Gets the pad configuration for a pin September 05 2012 157 GPIO Prototype void GPIOPadConfigGet unsigned long ulPort unsigned char ucPin unsigned long xpulStrength unsigned long xpulPinType Parameters ulPort is the base address of the GPIO port ucPin is the pin number pulStrength is a poi
572. 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 September 05 2012 63 Controller Area Network CAN 5 2 5 16 64 Normally this function is used to read a message object that has received and stored a CAN message with a certain identifier However this function 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 must be changed from a previous setting When using CANMessageGeti 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 data is new 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 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
573. the define is PART_LM3S6965 The part must be specified 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 September 05 2012 20 2 2 3 20 2 2 4 Peripheral Pin Mapping 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 The valid names for the pins are as follows ADCO ADC1 ADC2 ADC3 ADC4 ADC5 ADC6 or ADC7 See also GPIOPinTypeADC in order to configure multiple ADC pins at once Returns None 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 pin
574. the floating point context of the main thread of execution Returns None September 05 2012 149 Floating Point Unit FPU 11 2 2 9 FPUStackingEnable Enables the stacking of floating point registers Prototype void FPUStackingEnable void Description This function enables the stacking of floating point registers sO s15 when an interrupt is han dled When enabled space is reserved on the stack for the floating point context and the floating point state is saved into this stack space Upon return from the interrupt the floating point context is restored If the floating point registers are not stacked floating point instructions cannot be safely exe cuted in an interrupt handler because the values of s0 s15 are not likely to be preserved for the interrupted code On the other hand stacking the floating point registers increases the stacking operation from 8 words to 26 words also increasing the interrupt response latency Returns None 11 3 Programming Example The following example shows how to use the FPU API to enable the floating point unit and configure the stacking of floating point context Enable the floating point unit FPUEnable Configure the floating point unit to perform lazy stacking of the floating point state FPULazyStackingEnable 150 September 05 2012 12 12 1 GPIO GPIO OU manea ea saint won a bbe dnnbeedadina bebe bere daudkeh tad Kents
575. the number of micro seconds certain signals are asserted On these devices 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 capability can be used to validate the operation of a program the interrupt ensures that invalid accesses are not 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 protection is permanently applied to the device which is a non reversible operation on some devices 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 256 or 512 KB This driver is contained in driverlib flash c with driverlib flash h containing the API definitions for use by applications 10 2 API Functions Functions m long FlashErase unsigned long ulAddress m void FlashIntClear unsigned long ullntFlags m void FlashintDisable unsigned long ullntFlags September 05 2012 135 Flash 10 2 1 10 2 2 10 2 2 1 136 void FlashIntEnable unsigned long ullntFlags void FlashIntRegister void xpfnHandler void unsigne
576. the return code associated with the Advanced Command PECIBypassDisable Disables bypassing of negotiation errors Prototype void PECIBypassDisable unsigned long ulBase Parameters ulBase is the base address of the PECI module September 05 2012 283 Platform Environment Control Interface PECI 19 2 1 5 19 2 1 6 284 Description This function disables bypassing of negotiation errors that might occur during a PECI transac tion When disabled negotiation errors are reported and the remainder of the transaction is aborted Returns None PECIBypassEnable Enables bypassing of negotiation errors Prototype void PECIBypassEnable unsigned long ulBase Parameters ulBase is the base address of the PECI module Description This function enables bypassing of negotiation errors that might occur during a PECI transac tion When enabled negotiation errors are ignored Returns None PECIConfigGet Gets the current configuration of the PECI module Prototype void PECIConfigGet unsigned long ulBase unsigned long ulPECIC1k unsigned long xpulBaud unsigned long x pulPoll unsigned long xpulOffset unsigned long xpulRetry Parameters ulBase is the base address of the PECI module ulPECICIk is the rate of the clock supplied to the PECI module pulBaud is a pointer to storage for the bit rate pulPoll is a pointer to storage for the polling rate pulOffset is a point
577. 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 are 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 extended PWM fault handling affected outputs are driven low on a fault condition Returns None 21 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 ulPWMOutBits are the PWM outputs to be modified This parameter 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 is driven high or low The affected outputs are selected using the parameter u P WMoOutBits The para
578. ting point computations NaNs can either propagate the default or they can return the default NaN Note Unless this function is called prior to executing any floating point instructions the default mode is used September 05 2012 11 2 2 7 11 2 2 8 Floating Point Unit FPU Returns None FPURoundingModeSet Selects the rounding mode for floating point results Prototype void FPURoundingModeSet unsigned long ulMode Parameters ulMode is the rounding mode Description This function selects the rounding mode for floating point results After a floating point operation the result is rounded toward the specified value The default mode is FPU_ROUND_NEAREST The following rounding modes are available as specified by u Mode FPU_ROUND_NEAREST round toward the nearest value FPU_ROUND_POS _INF round toward positive infinity FPU_ROUND_NEG_INF round toward negative infinity FPU_ROUND_ZERO round toward zero Note Unless this function is called prior to executing any floating point instructions the default mode is used Returns None FPUStackingDisable Disables the stacking of floating point registers Prototype void FPUStackingDisable void Description This function disables the stacking of floating point registers sO s15 when an interrupt is han dled When floating point context stacking is disabled floating point operations performed in an interrupt handler destroy
579. tion This function enables the SIREN control bit for IrDA mode on the UART If the bLowPower flag is set then SIRLP bit is also set This function only has an effect if the UART has not been enabled by a call to UARTEnable The call UARTEnableSIR must be made before a call to UARTConfigSetExpClk because the UARTConfigSetExpClk function calls the UARTEn able function Another option is to call UARTDisable followed by UARTEnableSIR and then enable the UART by calling UARTEnable Note The availability of SIR IrDA operation 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 28 2 2 22 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 function disables the transmit and receive FIFOs in the UART Returns None 28 2 2 23 UARTFIFOEnable Enables the transmit and receive FIFOs Prototype void UARTFIFOEnable unsigned long ulBase September 05 2012 421 UART Parameters ulBase is the base address of the UART port Description This functions enables the transmit and receive FIFOs in the UART Returns None 28 2 2 24 UARTFIFOLevelGet Gets the FIFO level at which interrupts are generated Prototype void UARTFIFOLevelGet unsigned long ulBa
580. tion should only be called if USBPHY PowerOff has previously been called Returns None Programming Example This example code makes the calls necessary to configure endpoint 1 in device mode as a bulk IN endpoint The first call configures endpoint 1 to have a maximum packet size of 64 bytes and makes it a bulk IN endpoint The call to USBFIFOConfig configures the starting address to 64 bytes in and 64 bytes long It also specifies USB_EP_DEV_IN to indicate 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 schedules the transmission to go out the next time the host controller requests data on this endpoint if 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 USBF IFOConfig USBO_BASE USB_EP_1 64 USB_FIFO_SZ_64 USB_EP_DEV_IN ii 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 September 05 2012 31 31 1 31 2 Watchdog Timer Watc
581. to USBDevConnect is needed to reconnect to the bus Note This function should only be called in device mode Returns None 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 is written with the maximum packet size for this end point pulFlags is a pointer which is written with the current endpoint settings On entry to the func tion 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 returns 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 USBDevEndpointConfigSet for this endpoint Note This function should only be called in device mode Returns None USBDevEndpointConfigSet Sets the configuration for an endpoint Prototype void USBDevEndpointConfigSet unsigned long ulBase unsigned long ulEndpoint unsigned long ulMaxPacketSize unsigned long ulFlags September 05 2012 USB Controller Parameters ulBase specifies the USB mod
582. to be cleared Description The specified 12C Master interrupt sources are cleared so that they no longer assert This function must be called in the interrupt handler to keep the interrupt from being triggered again immediately upon exit The ullntFlags parameter has the same definition as the ullntFlags parameter to I2CMasterIntEnableEx Note Because there is a write buffer in the Cortex M 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 14 2 2 14 2CMasterIntDisable Disables the 12C Master interrupt Prototype void I2CMasterIntDisable unsigned long ulBase Parameters ulBase is the base address of the I2C Master module September 05 2012 209 Inter Integrated Circuit 12C Description This function disables the 12C Master interrupt source Returns None 14 2 2 15 l2CMasterlIntDisableEx Disables individual 12C Master interrupt sources Prototype void I2CMasterIntDisableEx unsigned long ulBase unsigned long ullIntFlags Parameters ulBase is the
583. 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 IntWasterEnable and IntMasterDisable this does not affect the individual interrupt enable states Masking of the processor interrupt can be used as a simple critical section only an NMI can interrupt the processor while the processor interrupt is disabled although masking the processor interrupt can have adverse effects on the interrupt response time The priority of each interrupt source can be set 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 protocol September 05 2012 16 2 2 16 2 2 1 16 2 2 2 16 2 2 3 Interrupt Controller NVIC allows priorities to be defined without knowledge of the exact number of supported priorities mov ing to a device with more or fewer priority bits is made easier as the interrupt source continues to have a similar level of priority Smaller priority numbers correspond to higher interrupt priority so 0 is t
584. tor failing the input voltage dropping too low the internal LDO voltage dropping too low and the PLL failing Not all of these interrupts are available on all Stellaris devices see the device data sheet for more details Each of these inter rupts 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 sysctl h containing the API definitions for use by applications API Functions Functions unsigned long SysCtIADCSpeedGet void void SysCtIADCSpeedSet unsigned long ulSpeed void SysCtlIBrownOutConfigSet unsigned long ulConfig unsigned long ulDelay void SysCtlClkVerificationClear void unsigned long SysCtIClockGet void void SysCtlClockSet unsigned long ulConfig void SysCtIDeepSleep void void SysCtIDeepSleepClockSet unsigned long ulConfig void SysCtlDelay unsigned long ulCount unsigned long SysCitlFlashSizeGet void void SysCtIGPIOAHBDisable unsigned long ulGPIOPeripheral void SysCtIGPIOAHBEnable unsigned long ulGPIOPeripheral unsigned long SysCtllI2SMClkSet unsigned long ullnputClock unsigned long ulMClk void SysCtllntClear unsigned long ullnts void SysCtllntDisable unsigned long ullnts void SysCtllntEnable unsigned long ullnts void SysCtllntRegister void pfnHandler void unsigned long SysCillntStatus tBoolean bMasked void SysCtllntUnregister void void SysCtllOSC
585. toriIntStatus 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 function 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 ComparatorIntUnregister 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 called when a comparator interrupt occurs This function also masks 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 September 05 2012 19 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 Descript
586. totype void T2CSlaveACKValueSet unsigned long ulBase tBoolean bACK Parameters ulBase is the base address of the I2C Slave module bACK chooses whether to ACK true or NACK false the transfer Description This function puts the desired ACK value on SDA during the ACK cycle The value written is only valid when ACK override is enabled using I2CSlaveACKOverride Returns None 14 2 2 25 2CSlaveAddressSet Sets the I2C slave address Prototype void I2CSlaveAddressSet unsigned long ulBase unsigned char ucAddrNum unsigned char ucSlaveAddr Parameters ulBase is the base address of the I2C Slave module ucAddrNum determines which slave address is set ucSlaveAddr is the 7 bit slave address 214 September 05 2012 Inter Integrated Circuit I2C Description This function writes the specified slave address The u AddrNum field dictates which slave address is configured For example a value of 0 configures the primary address and a value of 1 configures the secondary Note Not all Stellaris devices support a secondary address Please consult the device data sheet to determine if this feature is supported Returns None 14 2 2 26 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
587. 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 USB_DEV_OUT_OVERRUN An OUT packet was not loaded due to a full FIFO USB_DEV_OUT_FIFO_FULL The OUT endpoint s FIFO is full USB_DEV_OUT_PKTRDY There is a data packet ready in the OUT endpoints 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_DEV_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 30 3 2 21 USBFIFOAddrGet Returns the absolute FIFO address for a given endpoint Prototype unsigned long USBFIFOAddrGet unsigned long ulBase unsigned long ulEndpoint
588. ts 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 EPlI_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 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 September 05 2012 109 External Peripheral Interface EP 8 2 2 4 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
589. ts 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 12 2 2 17 GPIOPinTypeADC 162 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 representation of the pin s Description The analog to digital converter input pins must be properly configured to function correctly on devices that are not Sandstorm or Fury class 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 function cannot be used to turn any pin into an ADC input it only configures an ADC input pin for proper operation Devices with flexible pin muxing also require a GPIOPinConfigure function call September 05 2012 GPIO Returns None 12 2 2 18 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
590. tuning or frequency measurement mechanism its frequency is not adjustable Almost the entire device operates from a single clock See the device data sheet for more informa tion on how clocking for the various periphersals is configured 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 returns 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 core power supply On some devices 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 several system events that when detected cause system control to reset the device These events are the input voltage dropping too low the LDO voltage dropping too low an
591. tus can be returned Returns Returns the interrupt status as a bit field with the values as described in the HibernatelntEn able function 13 2 2 17 HibernatelntUnregister Unregisters an interrupt handler for the Hibernation module interrupt Prototype void HibernateIntUnregister void Description This function unregisters the interrupt handler in the system interrupt controller The interrupt is disabled at the global level and the interrupt handler is longer called See also IntRegister for important information about registering interrupt handlers Returns None 13 2 2 18 HibernatelsActive Checks to see if the Hibernation module is already powered up Prototype unsigned long HibernatelsActive 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
592. tus is returned Returns Returns the contents of the interrupt status register or the contents of the raw interrupt status register for the specified PWM generator September 05 2012 313 Pulse Width Modulator PWM 21 2 2 18 PWMGenlIntTrigDisable Disables interrupts for the specified PWM generator block Prototype void PWMGenIntTrigDisable unsigned long ulBase unsigned long ulGen unsigned long ullIntTrig Parameters ulBase is the base address of the PWM module ulGen is the PWM generator to have interrupts and triggers disabled This parameter 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 This function masks the specified interrupt s and trigger s by clearing the specified bits of the interrupt trigger enable register for the specified PWM generator The ullntTrig parameter is the logical OR of PWM_INT_CNT_ZERO PWM_INT_CNT_LOAD PWN_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 21 2 2 19 PWMGenlIntTrigEnable 314 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 ulGen is the PWM generator
593. type void FanIntUnregister unsigned long ulBase Parameters ulBase is the base address of the FAN module Description This function unregisters and clears the handler to be called when the FAN module interrupt occurs See also IntRegister for important information about registering interrupt handlers Returns None Programming Example September 05 2012 133 Fan Controller Enable the Fan peripheral SysCtlPeriphalEnable SYSCTL_PERIPH_FANO Configure Fan channel 0 for automatic mode The following configuration choices are used automatic restart fast acceleration 50 startup duty cycle start period of 64 tachometer pulse edges hysteresis smoothing of 16 tachometer edges speed averaging over 4 samples 4 pulses per revolution tachometer rate FanChannelConfigAuto FANO_BASE 0 FAN_CONFIG_RESTART FAN_CONFIG_ACCEL_FAST FAN_CONFIG_HYST_16 FAN_CONFIG_START_DUTY_50 FAN_CONFIG_START_64 FAN_CONFIG_AVG_4 FAN_CONFIG_TACH_4 Enable fan channel 0 for operation FanChannelEnable FANO_BASE 0 Set the fan to run at 1000 RPM FanChannelRPMSet FANO_BASE 0 1000 134 September 05 2012 Flash 10 Flash OMS sadico okie bok seduasatiasedniidineeeniSieeeshshiladaciaeelen satel tdjardsiudearesaidianans 135 SARI TP MAG OENN Sg dads tes ANE ly eR a dabodatut dyed ca bgp imei Coded Gout uted aeleda alee
594. ual Ethernet interrupt sources Prototype void Ethernet IntDisable 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 ullntFlags parameter to Ethernet IntEnable Returns None EthernetintEnable Enables individual Ethernet interrupt sources Prototype void Ethernet IntEnable unsigned long ulBase unsigned long ullIntFlags September 05 2012 Ethernet Controller Parameters ulBase is the base address of the controller ullntFlags is the bit mask of the interrupt sources to be enabled Description This function enables the indicated Ethernet interrupt sources Only the sources that are en abled can be reflected to the processor interrupt disabled sources have no effect on the pro cessor The ullntFlags parameter is the logical OR of any of the following m ETH_INT_PHY An interrupt from the PHY has occurred The integrated PHY supports a number of interrupt conditions The appropriate PHY register PHY_MR17 or PHY_MR29 depending on the device class must be read to determine which PHY int
595. ucPins unsigned long GPIODirModeGet unsigned long ulPort unsigned char ucPin void GPIODirModeSet unsigned long ulPort unsigned char ucPins unsigned long ulPinlO void GPIODMATriggerDisable unsigned long ulPort unsigned char ucPins void GPIODMATriggerEnable unsigned long ulPort unsigned char ucPins unsigned long GP OIntTypeGet unsigned long ulPort unsigned char ucPin void GPIOIntTypeSet unsigned long ulPort unsigned char ucPins unsigned long ullntType void GPIOPadConfigGet unsigned long ulPort unsigned char ucPin unsigned long pulStrength unsigned long xpulPinType 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 OPinIntStatus 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 GPIOPinTypeEthernetMIl
596. ucture 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 UDMA_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 half words 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 half words 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 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 29 2 3 6 uDMAChannelDisable Disables a UDMA channel for operation September 05 201
597. ule 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 sets 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 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 determine 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 configuration 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 option 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 b
598. unc tions should be called 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 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 September 05 2012 USB Controller USB_HOST_IN_FIFO_FULL This IN endpoint s FIFO is full USB_HOST_IN_PKTRDY Data packet ready on this IN endpoint USB_HOST_OUT_NAK_TO NAKs received on this OUT endpoint for more than the specified timeout period USB_HOST_OUT_NOT_COMP The device failed to respond to an OUT request USB_HOST_OUT_STALL A stall was received on this OUT endpoint USB_HOST_OUT_ERROR Failed to communicate with a device using this OUT end point 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
599. unction does nothing Returns None 27 2 2 29 TimerSynchronize Synchronizes the counters in a set of timers Prototype void TimerSynchronize unsigned long ulBase unsigned long ulTimers Parameters ulBase is the base address of the timer module This parameter must be the base address of Timer0 in other words TIMERO_BASE ulTimers is the set of timers to synchronize Description This function synchronizes the counters in a specified set of timers When a timer is running in half width mode each half can be included or excluded in the synchronization event When a timer is running in full width mode only the A timer can be synchronized specifying the B timer has no effect The u Timers parameter is the logical OR of any of the following defines TIMER_0A_SYNC TIMER_0B_ SYNC TIMER_1A_SYNC TIMER_1B SYNC TIMER_2A SYNC TIMER_2B SYNC TIMER_3A_SYNC TIMER_3B_ SYNC TIMER_4A SYNC TIMER_4B SYNC TIMER_5A_SYNC TIMER_5B_SYNC WTIMER_0A_SYNC WTIMER_0B_SYNC WTIMER_1A_SYNC WTIMER_1B_SYNC WTIMER_2A SYNC WTIMER_2B SYNC September 05 2012 405 Timer WTIMER_3A_SYNC WTIMER_3B_SYNC WTIMER_4A_SYNC WTIMER_4B_SYNC WTIMER_5A_SYNC WTIMER_5B_SYNC Note This functionality is not available on all parts Returns None 27 2 2 30 TimerValueGet 27 2 2 31 406 Gets the current timer value Prototype unsigned long TimerValueGet unsigned long ulBase
600. und 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 ulBase 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 indicates the argument that is invalid The debugger is 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 method allows the problem to be quickly identified at the cost of a small amount of code September 05 2012 517 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 t
601. 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 24 2 2 48 SysCtlIUSBPLLDisable Powers down the USB PLL Prototype void SysCtlUSBPLLDisable void Description This function disables the USB controller s PLL which is used by it s physical layer The USB registers are still accessible but the physical layer no longer functions Returns None 24 2 2 49 SysCtlLUSBPLLEnable Powers up the USB PLL Prototype void SysCt LUSBPLLEnable void Description This function enables the USB controllers PLL which is used by it s physical layer This call is necessary before connecting to any external devices Returns None September 05 2012 375 System Control 24 3 Programming Example The following example shows how to use the SysCtl API to configure the device for normal opera tion 376 Configure the device to run at 20 MHz from the PLL using a 4 MHz crystal as the input SysCtlClockSet SYSCTL_SYSDIV_10 SYSCTL_OSC_MAIN Enable t SysCtlPerip SysCtlPerip SysCtlPerip Enable t Lf SysCtlPerip SysCtlPerip SysCtlPerip Enable peripheral clock gating SysCtlPeripheralClockGating true he GPIO blocks and the SSI heralEnable SYSCTL_PERIPH_GPIOA heralEnable SYSCTL_PERIPH_GPIOB heralEnable SYSCTL_PER
602. upt controller specific system exception interrupts must be enabled via SysExclntEnable It is the interrupt handler s responsibility to clear the interrupt source See also IntRegister for important information about registering interrupt handlers September 05 2012 379 System Exception Module 25 2 2 5 25 2 2 6 25 3 380 Returns None SysExclntStatus Gets the current system exception interrupt status Prototype unsigned long SysExcIntStatus tBoolean bMasked Parameters bMasked is false if the raw interrupt status is required and true if the masked interrupt status is required Description This function returns the system exception interrupt status 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 system exception interrupt status enumerated as the logi cal OR of SYSEXC_INT_FP_IXC SYSEXC_INT_FP_OFC SYSEXC_INT_FP_UFC SY SEXC_INT_FP_IOC SYSEXC_INT_FP_DZC and SYSEXC_INT_FP_IDC SysExclntUnregister Unregisters the system exception interrupt handler Prototype void SysExcIntUnregister void Description This function removes the system exception interrupt handler from the vector table in SRAM This function also masks off the system exception interrupt in the interrupt controller so that the interrupt handler is no longer called See also IntRegister for important informatio
603. ured and enabled and if any code causes an access violation the memory management fault occurs 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 September 05 2012 279 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 ulIdx lt 4 ulIdx MPURegionSet uIdx ulRegionAddr uIdx ulRegionAttr ulIdx 280 September 05 2012 19 19 1 19 2 Platform Environment Control Interface PECI Platform Environment Control Interface PECI ASS E NET aE A E EEE T E A E E EE ERES S E EEE S EEI T EAN EAT ET 281 PaM E E a ES EES EE E E E E N T A S E EEL ST O EO ET 281 Introduction The PECI API provides functions to use the PECI module available in the Stellaris microcontroller family The PECI module provides for 2 microprocessors with 2 domains each for a total of up to 4 domains Some features of the PECI module are configurable PECI baud and polling rates m configurable interrupts and thresholds This driver is contained in
604. urned Returns Returns the current interrupt status enumerated as a bit field of values described in I2CMasterIntEnableEx 14 2 2 20 2CMasterLineStateGet Reads the state of the SDA and SCL pins Prototype unsigned long T2CMasterLineStateGet unsigned long ulBase Parameters ulBase is the base address of the I2C Master module Description This function returns the state of the 12C bus by providing the real time values of the SDA and SCL pins Note Not all Stellaris devices support this function Please consult the device data sheet to deter mine if this feature is supported Returns Returns the state of the bus with SDA in bit position 1 and SCL in bit position 0 14 2 2 21 2CMasterSlaveAddrSet Sets the address that the 12C Master places on the bus Prototype void I2CMasterSlaveAddrSet unsigned long ulBase 212 September 05 2012 Inter Integrated Circuit 12C 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 configures the address that the 12C Master places on the bus when initiating a transaction When the bReceive parameter is set to true the address indicates that the 12C Master is initiating a read from the slave otherwise the address indicates that the 12C Master is initiating a write to the sl
605. urns None 8 2 2 9 EPIllntEnable Enables EPI interrupt sources Prototype void EPIIntEnable unsigned long ulBase unsigned long ullIntFlags September 05 2012 113 External Peripheral Interface EPI 8 2 2 10 8 2 2 11 114 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 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 Descript
606. ut drive strength and GPIO_OUT_STRENGTH_8MA_SC specifies 8 mA output drive with slew control Some Stellaris devices also support output drive strengths of 6 10 and 12 mA 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 where GPIO_PIN_TYPE_STD specifies a push pull pin GPIO_PIN_TYPE_OD specifies an open drain pin _WPU specifies a weak pull up _WPD specifies a weak pull down and GPIO_PIN_TYPE_ANALOG specifies an analog input 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 12 2 2 11 GPlOPinConfigure 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 associated with more
607. uts 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 M 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 PWMFaultIntRegister Registers an interrupt handler for a fault condition detected in a PWM module Prototype void PWMFaultIntRegister unsigned long ulBase void pfnIntHandler 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 Description This function ensures that the interrupt handler specified by pfnintHandler is called when a fault interrupt is detected for the selected PWM module This function also enables the PWM September 05 2012 305 Pulse Width Modulator PWM 21 2 2 6 21 2 2 7 306 fault interrupt in the NVIC the PWM fault interrupt
608. vailability of 9 bit 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 UART9BitEnable Enables 9 bit mode on the specified UART Prototype void UART9BitEnable unsigned long ulBase Parameters ulBase is the base address of the UART port Description This function enables the 9 bit operational mode of the UART Note The availability of 9 bit 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 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 bBreakSiate 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 September 05 2012 413 UART 28 2 2 6 28 2 2 7 28 2 2 8 414 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 Description This function all
609. ve the configuration of a region for later use with the MPURe gionSet function The region s enable state is 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 The base address parameter u Addr must be aligned according to the size and the size must be a power of 2 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 September 05 2012 Memory Protection U
610. vent 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 signal used to capture events becomes an output signal and the timer drives an edge aligned pulse onto that signal The timer module also provides the ability to control other functional parameters such 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 timer matches a certain value On some parts the counters from multiple timer modules can be synchronized Synchronized counters are useful in PWM and edge time capture modes In PWM mode the PWM outputs from multiple timers can be in lock step by having the same load value and synchronizing the counters meaning that the counters always have the same value Similarly by using the same load value and synchronized counters in edge time capture mode the absolute time between two input edges can be easily measured This driver is contained in driverlib timer c with driverlib timer h containing the API definitions for use by applications September 05 2012 389 Timer 27 2 API Functions 27 2 1 390 Functions void TimerConfigure unsigned long ulBase
611. vices support this functionality see the data sheet to determine if this feature is supported The ulConfig parameter is the logical OR of the following values ETH_CFG_TS_TSEN Enable TX and RX interrupt status as CCP timer inputs 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 disables the transmitter and receiver and clears 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 programmed using the Et
612. waits until there is space available before returning Note The upper 32 N bits of 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 September 05 2012 Synchronous Serial Interface SS 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 Note The upper 32 N bits of 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 23 2 2 9 SS lDisable Disables the synchronous serial interface Prototype void SSIDisable unsigned long ulBase Parameters
613. ware 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 are 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 September 05 2012 4 3 Analog to Digital Converter ADC Description This function configures a step of the sample sequencer when using the software oversam pling feature The number of steps available depends on the oversampling factor set by AD CSoftwareOversampleConfigure The value of u Config is the same as defined for ADCSe quenceStepConfigure Returns None Programming Example The following example shows how to use the ADC API to initialize a sample sequencer for processor triggering trigger the sample sequence and then read back the data when it is ready unsigned long ulVa
614. y by the FIFO using one of these ready signals A value of 0 means to wait forever Returns None EPIConfigSDRAMSet 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 This function is used to configure the SDRAM interface when the SDRAM mode is chosen with the function EPIModeSet The parameter 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 September 05 2012 111 External Peripheral Interface EP 8 2 2 6 8 2 2 7 112 EPI _SDRAM_SIZE_64MBIT 64 Mbit device 8 MB EPI_SDRAM_SIZE_128MBIT 128 Mbit device 16 MB EPI_SDRAM_SI
615. y reentered because the interrupt controller still sees the interrupt source asserted Returns None 23 2 2 14 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 This function disables the indicated SSI interrupt sources The ullntFlags parameter can be any of the SSI_TXFF SSI_RXFF SSL_RXTO or SSI_RXOR values Returns None September 05 2012 341 Synchronous Serial Interface SSI 23 2 2 15 SSllntEnable Enables individual SSI interrupt sources 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 This function 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 SSI_RXFF SSI_RXTO or SSI_RXOR values Returns None 23 2 2 16 SSllntRegister Registers an interrupt handler for the synchronous serial interface Prototype void SSIIntRegister unsigned long ulBase void x pfnHandler void Parameters ulBase specifie
616. ze is the number of data items to transfer Description This function is used to configure the parameters for a UDMA transfer These parameters are typically changed often The function UDMAChannelControlSet MUST be called at least 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 UDMA_MODE BASIC to perform a basic transfer based on request UDMA_MODE_AUTO io perform a transfer that always completes once started even if the request is removed UDMA_MODE_PINGPONG io set up a transfer that switches between the primary and alternate control structures for the channel This mode 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 September 05 2012 451 uDMA Controller The pvSrcAdadr and pvDstAddr 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 takes care of this alignment if the pointers are pointing to stora

Stellaris Peripheral Driver Library User's Guide

Contents

Download Pdf Manuals

Related Search

Related Contents