12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352 |
- //###########################################################################
- //
- // FILE: uart.c
- //
- // TITLE: Stellaris style wrapper driver for C28x SCI peripheral.
- //
- //###########################################################################
- // $TI Release: F2837xD Support Library v3.05.00.00 $
- // $Release Date: Tue Jun 26 03:15:23 CDT 2018 $
- // $Copyright:
- // Copyright (C) 2013-2018 Texas Instruments Incorporated - http://www.ti.com/
- //
- // Redistribution and use in source and binary forms, with or without
- // modification, are permitted provided that the following conditions
- // are met:
- //
- // Redistributions of source code must retain the above copyright
- // notice, this list of conditions and the following disclaimer.
- //
- // Redistributions in binary form must reproduce the above copyright
- // notice, this list of conditions and the following disclaimer in the
- // documentation and/or other materials provided with the
- // distribution.
- //
- // Neither the name of Texas Instruments Incorporated nor the names of
- // its contributors may be used to endorse or promote products derived
- // from this software without specific prior written permission.
- //
- // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- // $
- //###########################################################################
- //*****************************************************************************
- //
- //! \addtogroup uart_api
- //! @{
- //
- //*****************************************************************************
- #include <stdbool.h>
- #include <stdint.h>
- #include "inc/hw_ints.h"
- #include "inc/hw_memmap.h"
- #include "inc/hw_types.h"
- #include "inc/hw_uart.h"
- #include "driverlib/debug.h"
- #include "driverlib/interrupt.h"
- #include "driverlib/uart.h"
- //*****************************************************************************
- //
- //! \internal
- //! Checks a UART base address.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! This function determines if a UART port base address is valid.
- //!
- //! \return Returns \b true if the base address is valid and \b false
- //! otherwise.
- //
- //*****************************************************************************
- #ifdef DEBUG
- static bool
- UARTBaseValid(uint32_t ui32Base)
- {
- return((ui32Base == UARTA_BASE) || (ui32Base == UARTB_BASE) ||
- (ui32Base == UARTC_BASE) || (ui32Base == UARTD_BASE));
- }
- #endif
- //*****************************************************************************
- //
- //! Sets the type of parity.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param ui32Parity specifies the type of parity to use.
- //!
- //! Sets the type of parity to use for transmitting and expect when receiving.
- //! The \e ui32Parity parameter must be one of \b UART_CONFIG_PAR_NONE,
- //! \b UART_CONFIG_PAR_EVEN, \b UART_CONFIG_PAR_ODD, \b UART_CONFIG_PAR_ONE,
- //! or \b UART_CONFIG_PAR_ZERO. The last two allow direct control of the
- //! parity bit; it is always either one or zero based on the mode.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTParityModeSet(uint32_t ui32Base, uint32_t ui32Parity)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- ASSERT((ui32Parity == UART_CONFIG_PAR_NONE) ||
- (ui32Parity == UART_CONFIG_PAR_EVEN) ||
- (ui32Parity == UART_CONFIG_PAR_ODD) ||
- (ui32Parity == UART_CONFIG_PAR_ONE) ||
- (ui32Parity == UART_CONFIG_PAR_ZERO));
- //
- // Set the parity mode.
- //
- HWREGB(ui32Base + UART_O_CCR) = ((HWREGB(ui32Base + UART_O_CCR) &
- ~(UART_CONFIG_PAR_MASK)) | ui32Parity);
- }
- //*****************************************************************************
- //
- //! Gets the type of parity currently being used.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! This function gets the type of parity used for transmitting data and
- //! expected when receiving data.
- //!
- //! \return Returns the current parity settings, specified as one of
- //! \b UART_CONFIG_PAR_NONE, \b UART_CONFIG_PAR_EVEN, \b UART_CONFIG_PAR_ODD,
- //! \b UART_CONFIG_PAR_ONE, or \b UART_CONFIG_PAR_ZERO.
- //
- //*****************************************************************************
- uint32_t
- UARTParityModeGet(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Return the current parity setting.
- //
- return(HWREGB(ui32Base + UART_O_CCR) &
- (UART_CONFIG_PAR_MASK));
- }
- //*****************************************************************************
- //
- //! Sets the FIFO level at which interrupts are generated.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param ui32TxLevel is the transmit FIFO interrupt level, specified as one of
- //! \b UART_FIFO_TX1_8, \b UART_FIFO_TX2_8, \b UART_FIFO_TX4_8,
- //! \b UART_FIFO_TX6_8, or \b UART_FIFO_TX7_8.
- //! \param ui32RxLevel is the receive FIFO interrupt level, specified as one of
- //! \b UART_FIFO_RX1_8, \b UART_FIFO_RX2_8, \b UART_FIFO_RX4_8,
- //! \b UART_FIFO_RX6_8, or \b UART_FIFO_RX7_8.
- //!
- //! This function sets the FIFO level at which transmit and receive interrupts
- //! are generated.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTFIFOIntLevelSet(uint32_t ui32Base, uint32_t ui32TxLevel,
- uint32_t ui32RxLevel)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- ASSERT((ui32TxLevel == UART_FIFO_TX1_8) ||
- (ui32TxLevel == UART_FIFO_TX2_8) ||
- (ui32TxLevel == UART_FIFO_TX4_8) ||
- (ui32TxLevel == UART_FIFO_TX6_8));
- ASSERT((ui32RxLevel == UART_FIFO_RX1_8) ||
- (ui32RxLevel == UART_FIFO_RX2_8) ||
- (ui32RxLevel == UART_FIFO_RX4_8) ||
- (ui32RxLevel == UART_FIFO_RX6_8));
- //
- // Set the FIFO interrupt levels.
- //
- HWREGH(ui32Base + UART_O_FFTX) = (HWREGH(ui32Base + UART_O_FFTX)& (~UART_FFTX_TXFFIL_M)) | ui32TxLevel ;
- HWREGH(ui32Base + UART_O_FFRX) = (HWREGH(ui32Base + UART_O_FFRX)& (~UART_FFRX_RXFFIL_M)) | ui32RxLevel ;
- }
- //*****************************************************************************
- //
- //! Gets the FIFO level at which interrupts are generated.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param pui32TxLevel is a pointer to storage for the transmit FIFO level,
- //! returned as one of \b UART_FIFO_TX1_8, \b UART_FIFO_TX2_8,
- //! \b UART_FIFO_TX4_8, \b UART_FIFO_TX6_8, or \b UART_FIFO_TX7_8.
- //! \param pui32RxLevel is a pointer to storage for the receive FIFO level,
- //! returned as one of \b UART_FIFO_RX1_8, \b UART_FIFO_RX2_8,
- //! \b UART_FIFO_RX4_8, \b UART_FIFO_RX6_8, or \b UART_FIFO_RX7_8.
- //!
- //! This function gets the FIFO level at which transmit and receive interrupts
- //! are generated.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTFIFOIntLevelGet(uint32_t ui32Base, uint32_t *pui32TxLevel,
- uint32_t *pui32RxLevel)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Extract the transmit and receive FIFO levels.
- //
- *pui32TxLevel = HWREGH(ui32Base + UART_O_FFTX) & UART_FFTX_TXFFIL_M;
- *pui32RxLevel = HWREGH(ui32Base + UART_O_FFRX) & UART_FFRX_RXFFIL_M;
- }
- //*****************************************************************************
- //
- //! Gets the FIFO level at which interrupts are generated.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param pui32TxLevel is a pointer to storage for the transmit FIFO level,
- //! returned as one of \b UART_FIFO_TX1_8, \b UART_FIFO_TX2_8,
- //! \b UART_FIFO_TX4_8, \b UART_FIFO_TX6_8, or \b UART_FIFO_TX7_8.
- //! \param pui32RxLevel is a pointer to storage for the receive FIFO level,
- //! returned as one of \b UART_FIFO_RX1_8, \b UART_FIFO_RX2_8,
- //! \b UART_FIFO_RX4_8, \b UART_FIFO_RX6_8, or \b UART_FIFO_RX7_8.
- //!
- //! This function gets the FIFO level at which transmit and receive interrupts
- //! are generated.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTFIFOLevelGet(uint32_t ui32Base, uint32_t *pui32TxLevel,
- uint32_t *pui32RxLevel)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Extract the transmit and receive FIFO levels.
- //
- *pui32TxLevel = (HWREGH(ui32Base + UART_O_FFTX) & UART_FFTX_TXFFST_M) >> UART_FFTX_TXFFST_S;
- *pui32RxLevel = (HWREGH(ui32Base + UART_O_FFRX) & UART_FFRX_RXFFST_M) >> UART_FFRX_RXFFST_S;
- }
- //*****************************************************************************
- //
- //! Sets the configuration of a UART.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param ui32UARTClk is the rate of the clock supplied to the UART module.
- //! \param ui32Baud is the desired baud rate.
- //! \param ui32Config is the data format for the port (number of data bits,
- //! number of stop bits, and parity).
- //!
- //! This function configures the UART for operation in the specified data
- //! format. The baud rate is provided in the \e ui32Baud parameter and the data
- //! format in the \e ui32Config parameter.
- //!
- //! The \e ui32Config parameter is the logical OR of three values: the number of
- //! data bits, the number of stop bits, and the parity. \b UART_CONFIG_WLEN_8,
- //! \b UART_CONFIG_WLEN_7, \b UART_CONFIG_WLEN_6, and \b UART_CONFIG_WLEN_5
- //! select from eight to five data bits per byte (respectively).
- //! \b UART_CONFIG_STOP_ONE and \b UART_CONFIG_STOP_TWO select one or two stop
- //! bits (respectively). \b UART_CONFIG_PAR_NONE, \b UART_CONFIG_PAR_EVEN,
- //! \b UART_CONFIG_PAR_ODD, \b UART_CONFIG_PAR_ONE, and \b 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 will be the same as the processor clock. This will be
- //! the value returned by SysCtlClockGet(), or it can be explicitly hard coded
- //! if it is constant and known (to save the code/execution overhead of a call
- //! to SysCtlClockGet()).
- //!
- //! This function replaces the original UARTConfigSet() API and performs the
- //! same actions. A macro is provided in <tt>uart.h</tt> to map the original
- //! API to this API.
- //!
- //! \return None.
- //
- //*****************************************************************************
- //Changed for C28x
- void
- UARTConfigSetExpClk(uint32_t ui32Base, uint32_t ui32UARTClk,
- uint32_t ui32Baud, uint32_t ui32Config)
- {
- uint32_t ui32Div;
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- ASSERT(ui32Baud != 0);
- // ASSERT(ui32UARTClk >= (ui32Baud * UART_CLK_DIVIDER));
- //
- // Stop the UART.
- //
- UARTDisable(ui32Base);
- //
- // Is the required baud rate greater than the maximum rate supported?
- //
- if((ui32Baud * 16) > ui32UARTClk)
- {
- //
- // Baud Rate Not supported with current clock
- //
- return;
- }
- //
- // Compute the baud rate divider.
- //
- ui32Div = ((ui32UARTClk / (ui32Baud * 8)) - 1);
- //
- // Set the baud rate.
- //
- HWREGB(ui32Base + UART_O_HBAUD) = (ui32Div & 0xFF00) >> 8;
- HWREGB(ui32Base + UART_O_LBAUD) = ui32Div & 0x00FF;
- //
- // Set parity, data length, and number of stop bits.
- //
- HWREGB(ui32Base + UART_O_CCR) = ((HWREGB(ui32Base + UART_O_CCR) &
- ~(UART_CONFIG_PAR_MASK | UART_CONFIG_STOP_MASK | UART_CONFIG_WLEN_MASK))
- | ui32Config);
- //
- // Start the UART.
- //
- UARTEnable(ui32Base);
- }
- //*****************************************************************************
- //
- //! Gets the current configuration of a UART.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param ui32UARTClk is the rate of the clock supplied to the UART module.
- //! \param pui32Baud is a pointer to storage for the baud rate.
- //! \param pui32Config is a pointer to storage for the data format.
- //!
- //! The baud rate and data format for the UART is determined, given an
- //! explicitly provided 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
- //! \e pui32Config is enumerated the same as the \e ui32Config parameter of
- //! UARTConfigSetExpClk().
- //!
- //! The peripheral clock will be the same as the processor clock. This will be
- //! the value returned by SysCtlClockGet(), or it can be explicitly hard coded
- //! if it is constant and known (to save the code/execution overhead of a call
- //! to SysCtlClockGet()).
- //!
- //! This function replaces the original UARTConfigGet() API and performs the
- //! same actions. A macro is provided in <tt>uart.h</tt> to map the original
- //! API to this API.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTConfigGetExpClk(uint32_t ui32Base, uint32_t ui32UARTClk,
- uint32_t *pui32Baud, uint32_t *pui32Config)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Compute the baud rate.
- //
- *pui32Baud = ui32UARTClk / ((1 + (HWREGB(ui32Base + UART_O_HBAUD) << 8 ) | HWREGB(ui32Base + UART_O_LBAUD)) * 8);
- //
- // Get the parity, data length, and number of stop bits.
- //
- *pui32Config = HWREGB(ui32Base + UART_O_CCR) &
- (UART_CONFIG_PAR_MASK | UART_CONFIG_STOP_MASK | UART_CONFIG_WLEN_MASK);
- }
- //*****************************************************************************
- //
- //! Enables transmitting and receiving.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! Sets the UARTEN, TXE, and RXE bits, and enables the transmit and receive
- //! FIFOs.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTEnable(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Enable RX, TX, and the UART.
- //
- HWREGB(ui32Base + UART_O_CTL1) |= (UART_CTL1_TXENA | UART_CTL1_RXENA | UART_CTL1_SWRESET);
- }
- //*****************************************************************************
- //
- //! Disables transmitting and receiving.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! Clears the UARTEN, TXE, and RXE bits, then waits for the end of
- //! transmission of the current character, and flushes the transmit FIFO.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTDisable(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Wait for end of TX.
- //
- while(!(HWREGH(ui32Base + UART_O_CTL2) & UART_CTL2_TXEMPTY))
- {
- }
- //
- // Disable the FIFO.
- //
- HWREGH(ui32Base + UART_O_FFTX) &= ~(UART_FFTX_SCIFFENA);
- //
- // Disable the UART.
- //
- HWREGB(ui32Base + UART_O_CTL1) &= ~(UART_CTL1_TXENA | UART_CTL1_RXENA);
- }
- //*****************************************************************************
- //
- //! Enables Loop Back Test Mode.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! Sets the SCICCR.LOOPBKENA to enable
- //!
- //! \return None.
- //
- //*****************************************************************************
- void UARTsetLoopBack(uint32_t ui32Base, bool enable)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- if(enable)
- {
- //
- // Enable LoopBack.
- //
- HWREGB(ui32Base + UART_O_CCR) |= UART_CCR_LOOPBKENA;
- }
- else
- {
- //
- // Disable LoopBack.
- //
- HWREGB(ui32Base + UART_O_CCR) &= ~UART_CCR_LOOPBKENA;
- }
- }
- //*****************************************************************************
- //
- //! Enables the transmit and receive FIFOs.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! This functions enables the transmit and receive FIFOs in the UART.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTFIFOEnable(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Enable the FIFO.
- //
- HWREGH(ui32Base + UART_O_FFTX) |= UART_FFTX_SCIFFENA;
- }
- //*****************************************************************************
- //
- //! Disables the transmit and receive FIFOs.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! This functions disables the transmit and receive FIFOs in the UART.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTFIFODisable(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Disable the FIFO.
- //
- HWREGH(ui32Base + UART_O_FFTX) &= ~UART_FFTX_SCIFFENA;
- }
- //*****************************************************************************
- //
- //! Sets the operating mode for the UART transmit interrupt.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param ui32Mode is the operating mode for the transmit interrupt. It may be
- //! \b UART_TXINT_MODE_EOT to trigger interrupts when the transmitter is idle
- //! or \b UART_TXINT_MODE_FIFO to trigger based on the current transmit FIFO
- //! level.
- //!
- //! This function allows the mode of the UART transmit interrupt to be set. By
- //! default, the transmit interrupt is asserted when the FIFO level falls past
- //! a threshold set via a call to UARTFIFOLevelSet(). Alternatively, if this
- //! function is called with \e ui32Mode set to \b UART_TXINT_MODE_EOT, the
- //! transmit interrupt will only be asserted once the transmitter is completely
- //! idle - the transmit FIFO is empty and all bits, including any stop bits,
- //! have cleared the transmitter.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTTxIntModeSet(uint32_t ui32Base, uint32_t ui32Mode)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- ASSERT((ui32Mode == UART_TXINT_MODE_EOT) ||
- (ui32Mode == UART_TXINT_MODE_FIFO_M));
- //
- // Set or clear the EOT bit of the UART control register as appropriate.
- //
- HWREGH(ui32Base + UART_O_FFTX) = ((HWREG(ui32Base + UART_O_FFTX) & ~(UART_TXINT_MODE_FIFO_M)) | ui32Mode);
- }
- //*****************************************************************************
- //
- //! Returns the current operating mode for the UART transmit interrupt.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! This function returns the current operating mode for the UART transmit
- //! interrupt. The return value will be \b UART_TXINT_MODE_EOT if the
- //! transmit interrupt is currently set to be asserted once the transmitter is
- //! completely idle - the transmit FIFO is empty and all bits, including any
- //! stop bits, have cleared the transmitter. The return value will be \b
- //! UART_TXINT_MODE_FIFO if the interrupt is set to be asserted based upon the
- //! level of the transmit FIFO.
- //!
- //! \return Returns \b UART_TXINT_MODE_FIFO or \b UART_TXINT_MODE_EOT.
- //
- //*****************************************************************************
- uint32_t
- UARTTxIntModeGet(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Return the current transmit interrupt mode.
- //
- return(HWREGH(ui32Base + UART_O_FFTX) & UART_TXINT_MODE_FIFO_M);
- }
- //*****************************************************************************
- //
- //! Determines if there are any characters in the receive FIFO.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! This function returns a flag indicating whether or not there is data
- //! available in the receive FIFO.
- //!
- //! \return Returns \b true if there is data in the receive FIFO or \b false
- //! if there is no data in the receive FIFO.
- //
- //*****************************************************************************
- bool
- UARTCharsAvail(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Return the availability of characters.
- //
- if(HWREGH(ui32Base + UART_O_FFTX) & UART_FFTX_SCIFFENA)
- {
- return(((HWREGH(ui32Base + UART_O_FFRX) & UART_FFRX_RXFFST_M) >> UART_FFRX_RXFFST_S) ? true : false);
- }
- else
- {
- return((HWREGB(ui32Base + UART_O_RXST) & UART_RXST_RXRDY) ? true : false);
- }
- }
- //*****************************************************************************
- //
- //! Determines if there is any space in the transmit FIFO.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! This function returns a flag indicating whether or not there is space
- //! available in the transmit FIFO.
- //!
- //! \return Returns \b true if there is space available in the transmit FIFO
- //! or \b false if there is no space available in the transmit FIFO.
- //
- //*****************************************************************************
- bool
- UARTSpaceAvail(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Return the availability of space.
- //
- return((HWREGB(ui32Base + UART_O_CTL2) & UART_CTL2_TXRDY) ? true : false);
- }
- //*****************************************************************************
- //
- //! Receives a character from the specified port.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! 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 <tt>uart.h</tt> to map
- //! the original API to this API.
- //!
- //! \return Returns the character read from the specified port, cast as a
- //! \e long. A \b -1 is returned if there are no characters present in the
- //! receive FIFO. The UARTCharsAvail() function should be called before
- //! attempting to call this function.
- //
- //*****************************************************************************
- int32_t
- UARTCharGetNonBlocking(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // See if there are any characters in the receive FIFO.
- //
- if(HWREGH(ui32Base + UART_O_FFTX) & UART_FFTX_SCIFFENA)
- {
- if((HWREGH(ui32Base + UART_O_FFRX) & UART_FFRX_RXFFST_M) >> UART_FFRX_RXFFST_S)
- {
- //
- // Read and return the next character.
- //
- return(HWREGH(ui32Base + UART_O_RXBUF) & UART_RXBUF_SAR_M);
- }
- else
- {
- //
- // There are no characters, so return a failure.
- //
- return(-1);
- }
- }
- else
- {
- if((HWREGB(ui32Base + UART_O_RXST) & UART_RXST_RXRDY))
- {
- //
- // Read and return the next character.
- //
- return(HWREGH(ui32Base + UART_O_RXBUF) & UART_RXBUF_SAR_M);
- }
- else
- {
- //
- // There are no characters, so return a failure.
- //
- return(-1);
- }
- }
- }
- //*****************************************************************************
- //
- //! Waits for a character from the specified port.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! 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.
- //!
- //! \return Returns the character read from the specified port, cast as a
- //! \e long.
- //
- //*****************************************************************************
- int32_t
- UARTCharGet(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Wait until a char is available.
- //
- if(HWREGH(ui32Base + UART_O_FFTX) & UART_FFTX_SCIFFENA)
- {
- while(!((HWREGH(ui32Base + UART_O_FFRX) & UART_FFRX_RXFFST_M) >> UART_FFRX_RXFFST_S))
- {
- }
- }
- else
- {
- while(!(HWREGH(ui32Base + UART_O_RXST) & UART_RXST_RXRDY))
- {
- }
- }
- //
- // Now get the char.
- //
- return(HWREGH(ui32Base + UART_O_RXBUF) & UART_RXBUF_SAR_M);
- }
- //*****************************************************************************
- //
- //! Sends a character to the specified port.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param ucData is the character to be transmitted.
- //!
- //! Writes the character \e ucData to the transmit FIFO for the specified port.
- //! This function does not block, so if there is no space available, then a
- //! \b 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 <tt>uart.h</tt> to map
- //! the original API to this API.
- //!
- //! \return Returns \b true if the character was successfully placed in the
- //! transmit FIFO or \b false if there was no space available in the transmit
- //! FIFO.
- //
- //*****************************************************************************
- bool
- UARTCharPutNonBlocking(uint32_t ui32Base, unsigned char ucData)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // See if there is space in the transmit FIFO.
- //
- if(HWREGB(ui32Base + UART_O_CTL2) & UART_CTL2_TXRDY)
- {
- //
- // Write this character to the transmit FIFO.
- //
- HWREGB(ui32Base + UART_O_TXBUF) = ucData;
- //
- // Success.
- //
- return(true);
- }
- else
- {
- //
- // There is no space in the transmit FIFO, so return a failure.
- //
- return(false);
- }
- }
- //*****************************************************************************
- //
- //! Waits to send a character from the specified port.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param ucData is the character to be transmitted.
- //!
- //! Sends the character \e 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.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTCharPut(uint32_t ui32Base, unsigned char ucData)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Wait until space is available.
- //
- while(!(HWREGH(ui32Base + UART_O_CTL2) & UART_CTL2_TXRDY))
- {
- }
- //
- // Send the char.
- //
- HWREGB(ui32Base + UART_O_TXBUF) = ucData;
- }
- //*****************************************************************************
- //
- //! Determines whether the UART transmitter is busy or not.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! Allows the caller to determine whether all transmitted bytes have cleared
- //! the transmitter hardware. If \b 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.
- //!
- //! \return Returns \b true if the UART is transmitting or \b false if all
- //! transmissions are complete.
- //
- //*****************************************************************************
- bool
- UARTBusy(uint32_t ui32Base)
- {
- //
- // Check the argument.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Determine if the UART is busy.
- //
- return((HWREGB(ui32Base + UART_O_CTL2) & UART_CTL2_TXEMPTY) ? false : true);
- }
- //*****************************************************************************
- //
- //! Registers an interrupt handler for a UART RX interrupt.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param pfnHandler is a pointer to the function to be called when the
- //! UART interrupt occurs.
- //!
- //! This function does the actual registering of the interrupt handler. This
- //! will enable the global interrupt in the interrupt controller; specific UART
- //! interrupts must be enabled via UARTIntEnable(). It is the interrupt
- //! handler's responsibility to clear the interrupt source.
- //!
- //! \sa IntRegister() for important information about registering interrupt
- //! handlers.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTRXIntRegister(uint32_t ui32Base, void (*pfnHandler)(void))
- {
- uint32_t ui32Int;
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Determine the interrupt number based on the UART port.
- //
- ui32Int = ((ui32Base == UARTA_BASE) ? INT_SCIRXINTA : INT_SCIRXINTB );
- //
- // Register the interrupt handler.
- //
- IntRegister(ui32Int, pfnHandler);
- //
- // Enable the UART interrupt.
- //
- IntEnable(ui32Int);
- }
- //*****************************************************************************
- //
- //! Registers an interrupt handler for a UART TX interrupt.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param pfnHandler is a pointer to the function to be called when the
- //! UART interrupt occurs.
- //!
- //! This function does the actual registering of the interrupt handler. This
- //! will enable the global interrupt in the interrupt controller; specific UART
- //! interrupts must be enabled via UARTIntEnable(). It is the interrupt
- //! handler's responsibility to clear the interrupt source.
- //!
- //! \sa IntRegister() for important information about registering interrupt
- //! handlers.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTTXIntRegister(uint32_t ui32Base, void (*pfnHandler)(void))
- {
- uint32_t ui32Int;
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Determine the interrupt number based on the UART port.
- //
- ui32Int = ((ui32Base == UARTA_BASE) ? INT_SCITXINTA : INT_SCITXINTB );
- //
- // Register the interrupt handler.
- //
- IntRegister(ui32Int, pfnHandler);
- //
- // Enable the UART interrupt.
- //
- IntEnable(ui32Int);
- }
- //*****************************************************************************
- //
- //! Unregisters an interrupt handler for a UART RX interrupt.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! This function does the actual unregistering of the interrupt handler. It
- //! will clear the handler to be called when a UART interrupt occurs. This
- //! will also mask off the interrupt in the interrupt controller so that the
- //! interrupt handler no longer is called.
- //!
- //! \sa IntRegister() for important information about registering interrupt
- //! handlers.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTRXIntUnregister(uint32_t ui32Base)
- {
- uint32_t ui32Int;
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Determine the interrupt number based on the UART port.
- //
- ui32Int = ((ui32Base == UARTA_BASE) ? INT_SCIRXINTA : INT_SCIRXINTB );
- //
- // Disable the interrupt.
- //
- IntDisable(ui32Int);
- //
- // Unregister the interrupt handler.
- //
- IntUnregister(ui32Int);
- }
- //*****************************************************************************
- //
- //! Unregisters an interrupt handler for a UART TX interrupt.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! This function does the actual unregistering of the interrupt handler. It
- //! will clear the handler to be called when a UART interrupt occurs. This
- //! will also mask off the interrupt in the interrupt controller so that the
- //! interrupt handler no longer is called.
- //!
- //! \sa IntRegister() for important information about registering interrupt
- //! handlers.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTTXIntUnregister(uint32_t ui32Base)
- {
- uint32_t ui32Int;
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Determine the interrupt number based on the UART port.
- //
- ui32Int = ((ui32Base == UARTA_BASE) ? INT_SCITXINTA : INT_SCITXINTB );
- //
- // Disable the interrupt.
- //
- IntDisable(ui32Int);
- //
- // Unregister the interrupt handler.
- //
- IntUnregister(ui32Int);
- }
- //*****************************************************************************
- //
- //! Enables individual UART interrupt sources.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param ui32IntFlags is the bit mask of the interrupt sources to be enabled.
- //!
- //! 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 \e ui32IntFlags parameter is the logical OR of any of the following:
- //!
- //! - \b UART_INT_OE - Overrun Error interrupt
- //! - \b UART_INT_BE - Break Error interrupt
- //! - \b UART_INT_PE - Parity Error interrupt
- //! - \b UART_INT_FE - Framing Error interrupt
- //! - \b UART_INT_RT - Receive Timeout interrupt
- //! - \b UART_INT_TX - Transmit interrupt
- //! - \b UART_INT_RX - Receive interrupt
- //! - \b UART_INT_DSR - DSR interrupt
- //! - \b UART_INT_DCD - DCD interrupt
- //! - \b UART_INT_CTS - CTS interrupt
- //! - \b UART_INT_RI - RI interrupt
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTIntEnable(uint32_t ui32Base, uint32_t ui32IntFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Enable the specified interrupts.
- //
- if(ui32IntFlags & UART_INT_RXERR)
- HWREGB(ui32Base + UART_O_CTL1) |= UART_CTL1_RXERRINTENA;
- if(ui32IntFlags & UART_INT_RXRDY_BRKDT)
- HWREGB(ui32Base + UART_O_CTL2) |= UART_CTL2_RXBKINTENA;
- if(ui32IntFlags & UART_INT_TXRDY)
- HWREGB(ui32Base + UART_O_CTL2) |= UART_CTL2_TXINTENA;
- if(ui32IntFlags & UART_INT_TXFF)
- HWREGB(ui32Base + UART_O_FFTX) |= UART_FFTX_TXFFIENA;
- if(ui32IntFlags & UART_INT_RXFF)
- HWREGB(ui32Base + UART_O_FFRX) |= UART_FFRX_RXFFIENA;
- }
- //*****************************************************************************
- //
- //! Disables individual UART interrupt sources.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param ui32IntFlags is the bit mask of the interrupt sources to be disabled.
- //!
- //! 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 \e ui32IntFlags parameter has the same definition as the \e ui32IntFlags
- //! parameter to UARTIntEnable().
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTIntDisable(uint32_t ui32Base, uint32_t ui32IntFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Disable the specified interrupts.
- //
- if(ui32IntFlags & UART_INT_RXERR)
- HWREGB(ui32Base + UART_O_CTL1) &= ~UART_CTL1_RXERRINTENA;
- if(ui32IntFlags & UART_INT_RXRDY_BRKDT)
- HWREGB(ui32Base + UART_O_CTL2) &= ~UART_CTL2_RXBKINTENA;
- if(ui32IntFlags & UART_INT_TXRDY)
- HWREGB(ui32Base + UART_O_CTL2) &= ~UART_CTL2_TXINTENA;
- if(ui32IntFlags & UART_INT_TXFF)
- HWREGB(ui32Base + UART_O_FFTX) &= ~UART_FFTX_TXFFIENA;
- if(ui32IntFlags & UART_INT_RXFF)
- HWREGB(ui32Base + UART_O_FFRX) &= ~UART_FFRX_RXFFIENA;
- }
- //*****************************************************************************
- //
- //! Gets the current interrupt status.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param bMasked is \b false if the raw interrupt status is required and
- //! \b true if the masked interrupt status is required.
- //!
- //! This returns the interrupt status for the specified UART. Either the raw
- //! interrupt status or the status of interrupts that are allowed to reflect to
- //! the processor can be returned.
- //!
- //! \return Returns the current interrupt status, enumerated as a bit field of
- //! values described in UARTIntEnable().
- //
- //*****************************************************************************
- uint32_t
- UARTIntStatus(uint32_t ui32Base, bool bMasked)
- {
- uint32_t temp = 0;
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Return either the interrupt status or the raw interrupt status as
- // requested.
- //
- if(HWREGB(ui32Base + UART_O_CTL2) & UART_CTL2_TXRDY)
- temp |= UART_INT_TXRDY;
- if(HWREGB(ui32Base + UART_O_RXST) & UART_RXST_RXERROR)
- temp |= UART_INT_RXERR;
- if(HWREGB(ui32Base + UART_O_RXST) & (UART_RXST_RXRDY | UART_RXST_BRKDT))
- temp |= UART_INT_RXRDY_BRKDT;
- if(HWREGB(ui32Base + UART_O_FFTX) & UART_FFTX_TXFFINT)
- temp |= UART_INT_TXFF;
- if(HWREGB(ui32Base + UART_O_FFRX) & UART_FFRX_RXFFINT)
- temp |= UART_INT_RXFF;
- return temp;
- }
- //*****************************************************************************
- //
- //! Clears UART interrupt sources.
- //!
- //! \param ui32Base is the base address of the UART port.
- //! \param ui32IntFlags is a bit mask of the interrupt sources to be cleared.
- //!
- //! The specified UART 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 recognized again immediately upon exit.
- //!
- //! The \e ui32IntFlags parameter has the same definition as the \e ui32IntFlags
- //! parameter to UARTIntEnable().
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTIntClear(uint32_t ui32Base, uint32_t ui32IntFlags)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Clear the requested interrupt sources.
- //
- if(ui32IntFlags & (UART_INT_RXERR | UART_INT_RXRDY_BRKDT))
- {
- HWREGB(ui32Base + UART_O_CTL1) &= ~UART_CTL1_SWRESET;
- __asm(" nop");
- __asm(" nop");
- __asm(" nop");
- __asm(" nop");
- HWREGB(ui32Base + UART_O_CTL1) |= UART_CTL1_SWRESET;
- }
- if(ui32IntFlags & UART_INT_TXFF)
- HWREGB(ui32Base + UART_O_FFTX) |= UART_FFTX_TXFFINTCLR;
- if(ui32IntFlags & UART_INT_RXFF)
- HWREGB(ui32Base + UART_O_FFRX) |= UART_FFRX_RXFFINTCLR;
- }
- //*****************************************************************************
- //
- //! Gets current receiver errors.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! 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 the overrun
- //! occurs rather than when a character is next read.
- //!
- //! \return Returns a logical OR combination of the receiver error flags,
- //! \b UART_RXERROR_FRAMING, \b UART_RXERROR_PARITY, \b UART_RXERROR_BREAK
- //! and \b UART_RXERROR_OVERRUN.
- //
- //*****************************************************************************
- uint32_t
- UARTRxErrorGet(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // Return the current value of the receive status register.
- //
- return(HWREGH(ui32Base + UART_O_RXST));
- }
- //*****************************************************************************
- //
- //! Clears all reported receiver errors.
- //!
- //! \param ui32Base is the base address of the UART port.
- //!
- //! This function is used to clear all receiver error conditions reported via
- //! UARTRxErrorGet(). If using the overrun, framing error, parity error or
- //! break interrupts, this function must be called after clearing the interrupt
- //! to ensure that later errors of the same type trigger another interrupt.
- //!
- //! \return None.
- //
- //*****************************************************************************
- void
- UARTRxErrorClear(uint32_t ui32Base)
- {
- //
- // Check the arguments.
- //
- ASSERT(UARTBaseValid(ui32Base));
- //
- // To clear all errors a sw reset of the module is required
- //
- HWREGB(ui32Base + UART_O_CTL1) &= ~UART_CTL1_SWRESET;
- __asm(" nop");
- __asm(" nop");
- __asm(" nop");
- __asm(" nop");
- HWREGB(ui32Base + UART_O_CTL1) |= UART_CTL1_SWRESET;
- }
- //*****************************************************************************
- //
- // Close the Doxygen group.
- //! @}
- //
- //*****************************************************************************
|