The foxBMS secondary mcu API documentation
uart.c File Reference

Driver for the UART. More...

#include "uart.h"
Include dependency graph for uart.c:

Macros

#define MSG_NOT_BUSY   0
 
#define MSG_BUSY   1
 

Functions

static uint8_t * UART_txbuf_copy (uint8_t *ptrb, uint8_t *ptra)
 UART_txbuf_copy is a helper function. More...
 
static uint8_t * UART_txbuf_copy_length (uint8_t *ptrb, uint8_t *ptra, uint16_t length)
 UART_txbuf_copy_length is a helper function. More...
 
 __attribute__ ((weak))
 
void HAL_UART_TxCpltCallback (UART_HandleTypeDef *huart)
 
void HAL_UART_RxCpltCallback (UART_HandleTypeDef *huart)
 
void UART_Init (void)
 UART_Init provides initialization of the UART module. More...
 
void UART_IntRx (UART_HandleTypeDef *huart)
 UART_IntRx is responsible for handling receive requests. More...
 
static void UART_IntTx (UART_HandleTypeDef *huart)
 UART_IntTx is responsible for handling send requests. More...
 
void UART_vWrite (const uint8_t *source)
 UART_vWrite provides an interface to send data. More...
 
void UART_vWrite_intbuf (const uint8_t *source, uint16_t length)
 UART_vWrite provides an interface to send data. More...
 

Variables

volatile unsigned char Msg0SendBusy = 0
 
uint8_t rxbuf [RXBUF_LENGTH]
 
uint8_t * wrpoi_rxbuf = &rxbuf[0]
 
uint8_t * rdpoi_rxbuf = &rxbuf[0]
 
uint8_t txbuf [TXBUF_LENGTH]
 
uint8_t * wrpoi_txbuf = &txbuf[0]
 
uint8_t * rdpoi_txbuf = &txbuf[0]
 
uint8_t received_char = 0
 
char uart_com_receivedbyte [UART_COM_RECEIVEBUFFER_LENGTH]
 
uint8_t uart_com_receive_slot
 

Detailed Description

Driver for the UART.

BSD 3-Clause License Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. 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.
  3. Neither the name of the copyright holder 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 HOLDER 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.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

″This product uses parts of foxBMS®″

″This product includes parts of foxBMS®″

″This product is derived from foxBMS®″

Author
foxBMS Team
Date
23.09.2015 (date of creation)
Module-prefix UART

This uart module handles sending/receiving requests using UART/RS232. In its current implementation it's interrupt driven, may change in the future in order to support DMA.

Macro Definition Documentation

◆ MSG_BUSY

#define MSG_BUSY   1

◆ MSG_NOT_BUSY

#define MSG_NOT_BUSY   0

Function Documentation

◆ __attribute__()

__attribute__ ( (weak)  )

◆ HAL_UART_RxCpltCallback()

void HAL_UART_RxCpltCallback ( UART_HandleTypeDef *  huart)
Here is the call graph for this function:

◆ HAL_UART_TxCpltCallback()

void HAL_UART_TxCpltCallback ( UART_HandleTypeDef *  huart)
Here is the call graph for this function:

◆ UART_Init()

void UART_Init ( void  )

UART_Init provides initialization of the UART module.

It needs to be called during startup, send/receive will only work after initialization is completed. This function configures parameters of the UART interface and enables the needed interrupts.

Available baudrate is dependent on Sysclock.

◆ UART_IntRx()

void UART_IntRx ( UART_HandleTypeDef *  huart)

UART_IntRx is responsible for handling receive requests.

This is invoked from with the interrupt handler and processes userdata on receive event. It copies data from data register into a ringbuffer, provides some very basic application example.

◆ UART_IntTx()

static void UART_IntTx ( UART_HandleTypeDef *  huart)
static

UART_IntTx is responsible for handling send requests.

This is invoked from with the interrupt handler and processes userdata on send event. It copies data from a ringbuffer into the data register as long as the read pointer doesn't match the write pointer (which means there's still unsent data in the ringbuffer)

◆ UART_txbuf_copy()

static uint8_t * UART_txbuf_copy ( uint8_t *  ptrb,
uint8_t *  ptra 
)
static

UART_txbuf_copy is a helper function.

This function just copies content from buffer a to ringbuffer b.

Returns
(type: uint8_t)

◆ UART_txbuf_copy_length()

static uint8_t * UART_txbuf_copy_length ( uint8_t *  ptrb,
uint8_t *  ptra,
uint16_t  length 
)
static

UART_txbuf_copy_length is a helper function.

This function just copies a given length of data from buffer a to ringbuffer b. Difference to uint8_t *UART_txbuf_copy (uint8_t *ptrb, uint8_t *ptra) is, that it will stop at an ASCII_NULL character.

Returns
(type: uint8_t)

◆ UART_vWrite()

void UART_vWrite ( const uint8_t *  source)

UART_vWrite provides an interface to send data.

---------------------— IMPORTANT!!!! -----------------------------— Make sure that this function is not interrupted by the operating system during its execution.

This function copies data from input buffer to transmit ringbuffer and processes this data in case it's not already busy transmitting data. The copying will stop as soon as an ASCII NULL character is detected. To avoid data corruption caused by simultaneous accesses some kind of critical section is used.

Returns
(type: uint8_t)
Here is the call graph for this function:

◆ UART_vWrite_intbuf()

void UART_vWrite_intbuf ( const uint8_t *  source,
uint16_t  length 
)

UART_vWrite provides an interface to send data.

---------------------— IMPORTANT!!!! -----------------------------— Make sure that this function is not interrupted by the operating system during its execution.

This function copies data from input buffer to transmit ringbuffer and processes this data in case it's not already busy transmitting data. To avoid data corruption caused by simultaneous accesses some kind of critical section is used. The difference between UART_vWrite(const uint8_t *source) and this function is, that this one does not stop at an ASCII_NULL character. Therefore writing of non ASCII characters is possible without having to worry that the data might represent an ASCII NULL character.

Returns
(type: uint8_t)
Here is the call graph for this function:

Variable Documentation

◆ Msg0SendBusy

volatile unsigned char Msg0SendBusy = 0

◆ rdpoi_rxbuf

uint8_t* rdpoi_rxbuf = &rxbuf[0]

◆ rdpoi_txbuf

uint8_t* rdpoi_txbuf = &txbuf[0]

◆ received_char

uint8_t received_char = 0

◆ rxbuf

uint8_t rxbuf[RXBUF_LENGTH]

◆ txbuf

uint8_t txbuf[TXBUF_LENGTH]

◆ uart_com_receive_slot

uint8_t uart_com_receive_slot

◆ uart_com_receivedbyte

char uart_com_receivedbyte[UART_COM_RECEIVEBUFFER_LENGTH]

◆ wrpoi_rxbuf

uint8_t* wrpoi_rxbuf = &rxbuf[0]

◆ wrpoi_txbuf

uint8_t* wrpoi_txbuf = &txbuf[0]