stm32f1xx_HBL/drivers/usart.c

/** @file usart.c
 * Module handling Universal Synchronous/Asynchronous Receiver/Transmitter
 *
 * The module provides functions to configure the usarts and read/write from/to
 * it
 */

//--includes--------------------------------------------------------------------

#include "usart.h"
#include "nvic.h"
#include "usart_regs.h"
#include "reg.h"

#include "rcc.h"
#include "dma.h"
#include "dma_mbuf.h"

#include "stddef.h"


//--local definitions-----------------------------------------------------------

#define DMA_CONFIG (DMA_CONFIG_IRQ_COMPLETE | DMA_CONFIG_FROM_MEM \
					| DMA_CONFIG_INC_MEM | DMA_CONFIG_PSIZE_8BITS \
					| DMA_CONFIG_MSIZE_8BITS | DMA_CONFIG_PRIO_LOW)


struct CircularBuffer {
	volatile uint8_t* buffer; //the buffer to use as a circular buffer
	uint16_t size;            //the size of the buffer
	uint16_t begin;           //pointer to the current begin of the buffer
	bool dmaLooped;           //whether the DMA looped or not (buffer overflow)
};

static void configure_usart(volatile struct USART* regs,
		enum UsartConfig config);
static void configure_baudrate(volatile struct USART* regs, uint32_t clock,
		uint32_t baudrate);
static uint32_t read_from_buffer(volatile struct CircularBuffer* buffer,
		enum DmaChannel channel, uint8_t* byte);

static void usart1_rx_callback(enum DmaIRQSource src, volatile void* param);
static void usart2_rx_callback(enum DmaIRQSource src, volatile void* param);
static void usart3_rx_callback(enum DmaIRQSource src, volatile void* param);


//--local variables-------------------------------------------------------------

static volatile struct USART* const usart1 = (struct USART*)USART1_BASE_ADDRESS;
static volatile struct USART* const usart2 = (struct USART*)USART2_BASE_ADDRESS;
static volatile struct USART* const usart3 = (struct USART*)USART3_BASE_ADDRESS;

static volatile struct CircularBuffer usart1_rx_buffer;
static volatile struct DmaMultiBuffer usart1_tx_buffer;
static volatile struct CircularBuffer usart2_rx_buffer;
static volatile struct DmaMultiBuffer usart2_tx_buffer;
static volatile struct CircularBuffer usart3_rx_buffer;
static volatile struct DmaMultiBuffer usart3_tx_buffer;


//--public functions------------------------------------------------------------

void usart_configure(enum UsartPeriph periph, enum UsartConfig config,
		uint32_t baudrate)
{
	struct RccClocks clocks;
	rcc_get_clocks(&clocks);

	switch (periph) {
		case USART_PERIPH_1:
			rcc_enable(RCC_AHB_NONE, RCC_APB1_NONE, RCC_APB2_USART);
			configure_baudrate(usart1, clocks.apb2_freq, baudrate);
			configure_usart(usart1, config);
			usart1_tx_buffer.buffers = NULL;
			usart1_rx_buffer.buffer = NULL;
			break;
		case USART_PERIPH_2:
			rcc_enable(RCC_AHB_NONE, RCC_APB1_USART2, RCC_APB2_NONE);
			configure_baudrate(usart2, clocks.apb1_freq, baudrate);
			configure_usart(usart2, config);
			usart2_tx_buffer.buffers = NULL;
			usart2_rx_buffer.buffer = NULL;
			break;
		case USART_PERIPH_3:
			rcc_enable(RCC_AHB_NONE, RCC_APB1_USART3, RCC_APB2_NONE);
			configure_baudrate(usart3, clocks.apb1_freq, baudrate);
			configure_usart(usart3, config);
			usart3_tx_buffer.buffers = NULL;
			usart3_rx_buffer.buffer = NULL;
			break;
		default:
			break;
	}
}

uint32_t usart_write_byte(enum UsartPeriph periph, uint8_t byte)
{
	volatile struct USART* regs;
	volatile struct DmaMultiBuffer* buffer;
	enum NvicIrq irq;

	switch (periph) {
		case USART_PERIPH_1:
			regs = usart1;
			buffer = &usart1_tx_buffer;
			irq = NVIC_IRQ_USART1;
			break;
		case USART_PERIPH_2:
			regs = usart2;
			buffer = &usart2_tx_buffer;
			irq = NVIC_IRQ_USART2;
			break;
		case USART_PERIPH_3:
			regs = usart3;
			buffer = &usart3_tx_buffer;
			irq = NVIC_IRQ_USART3;
			break;
		default:
			return 1;
			break;
	}

	if (buffer->buffers) {
		//if the tx register is empty, there is no need to go through the dma
		if (regs->SR.TXE) {
			reg_write(regs->DR, USART_DR_DR, byte);
			//enable IRQ, disable DMA
			reg_reset(regs->CR3, USART_CR3_DMAT);
			reg_set(regs->CR1, USART_CR1_TXEIE);
			nvic_enable(irq);
			return 0;
		} else {
			return dma_mbuf_write_byte(buffer, byte);
		}
	} else {
		//only write data if the tx register it empty, give up otherwise
		if (regs->SR.TXE) {
			reg_write(regs->DR, USART_DR_DR, byte);
			return 0;
		} else {
			return 1;
		}
	}
}

uint32_t usart_read_byte(enum UsartPeriph periph, uint8_t* byte)
{
	volatile struct USART* regs;
	volatile struct CircularBuffer* buffer;
	enum DmaChannel dma_channel;

	switch (periph) {
		case USART_PERIPH_1:
			regs = usart1;
			buffer = &usart1_rx_buffer;
			dma_channel = DMA_CHANNEL_5;
			break;
		case USART_PERIPH_2:
			regs = usart2;
			buffer = &usart2_rx_buffer;
			dma_channel = DMA_CHANNEL_6;
			break;
		case USART_PERIPH_3:
			regs = usart3;
			buffer = &usart3_rx_buffer;
			dma_channel = DMA_CHANNEL_3;
			break;
		default:
			return 1;
			break;
	}

	if (buffer->buffer) {
		return read_from_buffer(buffer, dma_channel, byte);
	} else {
		if (regs->SR.RXNE) {
			*byte = regs->DR.DR;
			return 0;
		} else {
			return 1;
		}
	}
}

void usart_set_tx_buffer(enum UsartPeriph periph, uint8_t** buffers,
		uint16_t buffer_size, uint8_t buffer_nb)
{
	switch (periph) {
		case USART_PERIPH_1:
			dma_mbuf_configure(&usart1_tx_buffer, (void**)buffers, &usart1->DR,
					buffer_size, buffer_nb, DMA_PERIPH_1, DMA_CHANNEL_4,
					DMA_CONFIG);
			break;
		case USART_PERIPH_2:
			dma_mbuf_configure(&usart2_tx_buffer, (void**)buffers, &usart2->DR,
					buffer_size, buffer_nb, DMA_PERIPH_1, DMA_CHANNEL_7,
					DMA_CONFIG);
			break;
		case USART_PERIPH_3:
			dma_mbuf_configure(&usart3_tx_buffer, (void**)buffers, &usart3->DR,
					buffer_size, buffer_nb, DMA_PERIPH_1, DMA_CHANNEL_2,
					DMA_CONFIG);
			break;
	}
}

void usart_set_rx_buffer(enum UsartPeriph periph, uint8_t* buffer,
		uint16_t size)
{
	switch (periph) {
		case USART_PERIPH_1:
			dma_configure(DMA_PERIPH_1, DMA_CHANNEL_5,
					DMA_CONFIG_IRQ_COMPLETE | DMA_CONFIG_FROM_PERIPH
					| DMA_CONFIG_CIRCULAR | DMA_CONFIG_INC_MEM
					| DMA_CONFIG_PSIZE_8BITS | DMA_CONFIG_MSIZE_8BITS
					| DMA_CONFIG_PRIO_LOW, (void*)&usart1->DR, buffer,
					size, usart1_rx_callback, NULL);
			usart1_rx_buffer.buffer = buffer;
			usart1_rx_buffer.size = size;
			usart1_rx_buffer.begin = 0;
			usart1_rx_buffer.dmaLooped = false;
			reg_set(usart1->CR3, USART_CR3_DMAR);
			break;
		case USART_PERIPH_2:
			dma_configure(DMA_PERIPH_1, DMA_CHANNEL_6,
					DMA_CONFIG_IRQ_COMPLETE | DMA_CONFIG_FROM_PERIPH
					| DMA_CONFIG_CIRCULAR | DMA_CONFIG_INC_MEM
					| DMA_CONFIG_PSIZE_8BITS | DMA_CONFIG_MSIZE_8BITS
					| DMA_CONFIG_PRIO_LOW, (void*)&usart2->DR, buffer,
					size, usart2_rx_callback, NULL);
			usart2_rx_buffer.buffer = buffer;
			usart2_rx_buffer.size = size;
			usart2_rx_buffer.begin = 0;
			usart2_rx_buffer.dmaLooped = false;
			reg_set(usart2->CR3, USART_CR3_DMAR);
			break;

		case USART_PERIPH_3:
			dma_configure(DMA_PERIPH_1, DMA_CHANNEL_3,
					DMA_CONFIG_IRQ_COMPLETE | DMA_CONFIG_FROM_PERIPH
					| DMA_CONFIG_CIRCULAR | DMA_CONFIG_INC_MEM
					| DMA_CONFIG_PSIZE_8BITS | DMA_CONFIG_MSIZE_8BITS
					| DMA_CONFIG_PRIO_LOW, (void*)&usart3->DR, buffer,
					size, usart3_rx_callback, NULL);
			usart3_rx_buffer.buffer = buffer;
			usart3_rx_buffer.size = size;
			usart3_rx_buffer.begin = 0;
			usart3_rx_buffer.dmaLooped = false;
			reg_set(usart3->CR3, USART_CR3_DMAR);

			break;
	}
}

//--local functions-------------------------------------------------------------

/**
 * Apply the given configuration to the given registers. Generic version of
 * usart_configure()
 */
static void configure_usart(volatile struct USART* regs,
		enum UsartConfig config)
{
	//configure parity
	switch (config)
	{
		case USART_CONFIG_7E1:
		case USART_CONFIG_8E1:
		case USART_CONFIG_7E2:
		case USART_CONFIG_8E2:
			reg_set(regs->CR1, USART_CR1_PCE);
			reg_reset(regs->CR1, USART_CR1_PS);
			break;
		case USART_CONFIG_7O1:
		case USART_CONFIG_7O2:
		case USART_CONFIG_8O1:
		case USART_CONFIG_8O2:
			reg_set(regs->CR1, USART_CR1_PCE);
			reg_set(regs->CR1, USART_CR1_PS);
			break;
		case USART_CONFIG_8N1:
		case USART_CONFIG_8N2:
			reg_reset(regs->CR1, USART_CR1_PCE);
			break;
		default:
			break;
	}

	//configure bit number
	switch (config)
	{
		case USART_CONFIG_7E1:
		case USART_CONFIG_7E2:
		case USART_CONFIG_7O1:
		case USART_CONFIG_7O2:
		case USART_CONFIG_8N1:
		case USART_CONFIG_8N2:
			reg_reset(regs->CR1, USART_CR1_M);
			break;
		case USART_CONFIG_8E2:
		case USART_CONFIG_8E1:
		case USART_CONFIG_8O1:
		case USART_CONFIG_8O2:
			reg_set(regs->CR1, USART_CR1_M);
			break;
		default:
			break;
	}

	//configure stop bits
	switch (config)
	{
		case USART_CONFIG_7E1:
		case USART_CONFIG_7O1:
		case USART_CONFIG_8N1:
		case USART_CONFIG_8E1:
		case USART_CONFIG_8O1:
			reg_reset(regs->CR2, USART_CR2_STOP);
			break;
		case USART_CONFIG_7E2:
		case USART_CONFIG_7O2:
		case USART_CONFIG_8N2:
		case USART_CONFIG_8E2:
		case USART_CONFIG_8O2:
			reg_reset(regs->CR2, USART_CR2_STOP);
			reg_write(regs->CR2, USART_CR2_STOP, 2);
			break;
		default:
			break;
	}

	//enable Rx/Tx
	reg_set(regs->CR1, USART_CR1_TE);
	reg_set(regs->CR1, USART_CR1_RE);
	reg_set(regs->CR1, USART_CR1_UE);
}

/**
 * Configure the given registers with the given baudrate. Baudrate is dependant
 * on the peripheric's clock and may not be exact due to precision errors (see
 * table 192 in documentation)
 */
static void configure_baudrate(volatile struct USART* regs, uint32_t clock,
		uint32_t baudrate)
{
	uint32_t mantissa = clock / (baudrate * 16);
	uint32_t factor = clock / baudrate;
	volatile uint32_t divider = factor - (mantissa * 16);

	reg_reset(regs->BRR, USART_BRR_DIV_Mantissa);
	reg_write(regs->BRR, USART_BRR_DIV_Mantissa, mantissa & 0xFFF);
	reg_reset(regs->BRR, USART_BRR_DIV_Fraction);
	reg_write(regs->BRR, USART_BRR_DIV_Fraction, divider & 0xF);
}

/**
 * Reads the oldest byte from the given CircularBuffer if any. Returns 0 if the
 * read was successfull, 1 otherwise
 */
static uint32_t read_from_buffer(volatile struct CircularBuffer* buffer,
		enum DmaChannel channel, uint8_t* byte)
{
	//retreive the current end of the buffer based on the DMA's progress
	uint16_t end = buffer->size - dma_get_remaining(DMA_PERIPH_1, channel);

	//check for bytes to read and overflow
	if ((end > buffer->begin) && buffer->dmaLooped) {
		//TODO overflow
		buffer->begin = end;
	} else if ((buffer->begin == end) && !buffer->dmaLooped) {
		//TODO no data
		return 1;
	}

	//read the oldest byte and advance the buffer
	*byte = buffer->buffer[buffer->begin];
	++buffer->begin;
	if (buffer->begin >= buffer->size) {
		buffer->begin = 0;
		buffer->dmaLooped = false;
	}

	return 0;
}

//--allbacks-------------------------------------------------------------------

/**
 * Callback called on DMA RX tranfert's completion. Sets a flag needed to
 * properly handle the circular buffer
 */
static void usart1_rx_callback(enum DmaIRQSource src, volatile void* param)
{
	(void)src; //only transfer complete expected
	usart1_rx_buffer.dmaLooped = true;
}

/**
 * Callback called on DMA RX tranfert's completion. Sets a flag needed to
 * properly handle the circular buffer
 */
static void usart2_rx_callback(enum DmaIRQSource src, volatile void* param)
{
	(void)src; //only transfer complete expected
	usart2_rx_buffer.dmaLooped = true;
}

/**
 * Callback called on DMA RX tranfert's completion. Sets a flag needed to
 * properly handle the circular buffer
 */
static void usart3_rx_callback(enum DmaIRQSource src, volatile void* param)
{
	(void)src; //only transfer complete expected
	usart3_rx_buffer.dmaLooped = true;
}


//--ISRs------------------------------------------------------------------------

void hdr_usart1(void)
{
	//disable the interrupt. It will be reenabled on a write if needed
	nvic_clear_pending(NVIC_IRQ_USART1);
	nvic_disable(NVIC_IRQ_USART1);
	reg_reset(usart1->CR1, USART_CR1_TXEIE);
	reg_set(usart1->CR3, USART_CR3_DMAT);

	dma_mbuf_refresh(&usart1_tx_buffer);
}

void hdr_usart2(void)
{
	//disable the interrupt. It will be reenabled on a write if needed
	nvic_clear_pending(NVIC_IRQ_USART2);
	nvic_disable(NVIC_IRQ_USART2);
	reg_reset(usart2->CR1, USART_CR1_TXEIE);
	reg_set(usart2->CR3, USART_CR3_DMAT);

	dma_mbuf_refresh(&usart2_tx_buffer);
}

void hdr_usart3(void)
{
	//disable the interrupt. It will be reenabled on a write if needed
	nvic_clear_pending(NVIC_IRQ_USART3);
	nvic_disable(NVIC_IRQ_USART3);
	reg_reset(usart3->CR1, USART_CR1_TXEIE);
	reg_set(usart3->CR3, USART_CR3_DMAT);

	dma_mbuf_refresh(&usart3_tx_buffer);
}