From a7099d5dfd25be443f12b2be42ed74114e9f8cd0 Mon Sep 17 00:00:00 2001 From: Steins7 Date: Thu, 21 Sep 2023 20:41:50 +0200 Subject: [PATCH] Rename drivers folder to drv --- {drivers => drv}/afio.c | 0 {drivers => drv}/afio.h | 0 {drivers => drv}/afio_regs.h | 0 {drivers => drv}/dma.c | 0 {drivers => drv}/dma.h | 0 {drivers => drv}/dma_cbuf.c | 0 {drivers => drv}/dma_cbuf.h | 14 ++++++++++++++ {drivers => drv}/dma_mbuf.c | 0 {drivers => drv}/dma_mbuf.h | 0 {drivers => drv}/dma_regs.h | 0 {drivers => drv}/exti.c | 0 {drivers => drv}/exti.h | 0 {drivers => drv}/exti_regs.h | 0 {drivers => drv}/flash.c | 0 {drivers => drv}/flash.h | 0 {drivers => drv}/flash_regs.h | 0 {drivers => drv}/gpio.c | 0 {drivers => drv}/gpio.h | 0 {drivers => drv}/gpio_regs.h | 0 {drivers => drv}/nvic.c | 0 {drivers => drv}/nvic.h | 0 {drivers => drv}/nvic_regs.h | 0 {drivers => drv}/rcc.c | 0 {drivers => drv}/rcc.h | 0 {drivers => drv}/rcc_regs.h | 0 {drivers => drv}/reg.h | 0 {drivers => drv}/usart.c | 0 {drivers => drv}/usart.h | 0 {drivers => drv}/usart_regs.h | 0 29 files changed, 14 insertions(+) rename {drivers => drv}/afio.c (100%) rename {drivers => drv}/afio.h (100%) rename {drivers => drv}/afio_regs.h (100%) rename {drivers => drv}/dma.c (100%) rename {drivers => drv}/dma.h (100%) rename {drivers => drv}/dma_cbuf.c (100%) rename {drivers => drv}/dma_cbuf.h (70%) rename {drivers => drv}/dma_mbuf.c (100%) rename {drivers => drv}/dma_mbuf.h (100%) rename {drivers => drv}/dma_regs.h (100%) rename {drivers => drv}/exti.c (100%) rename {drivers => drv}/exti.h (100%) rename {drivers => drv}/exti_regs.h (100%) rename {drivers => drv}/flash.c (100%) rename {drivers => drv}/flash.h (100%) rename {drivers => drv}/flash_regs.h (100%) rename {drivers => drv}/gpio.c (100%) rename {drivers => drv}/gpio.h (100%) rename {drivers => drv}/gpio_regs.h (100%) rename {drivers => drv}/nvic.c (100%) rename {drivers => drv}/nvic.h (100%) rename {drivers => drv}/nvic_regs.h (100%) rename {drivers => drv}/rcc.c (100%) rename {drivers => drv}/rcc.h (100%) rename {drivers => drv}/rcc_regs.h (100%) rename {drivers => drv}/reg.h (100%) rename {drivers => drv}/usart.c (100%) rename {drivers => drv}/usart.h (100%) rename {drivers => drv}/usart_regs.h (100%) diff --git a/drivers/afio.c b/drv/afio.c similarity index 100% rename from drivers/afio.c rename to drv/afio.c diff --git a/drivers/afio.h b/drv/afio.h similarity index 100% rename from drivers/afio.h rename to drv/afio.h diff --git a/drivers/afio_regs.h b/drv/afio_regs.h similarity index 100% rename from drivers/afio_regs.h rename to drv/afio_regs.h diff --git a/drivers/dma.c b/drv/dma.c similarity index 100% rename from drivers/dma.c rename to drv/dma.c diff --git a/drivers/dma.h b/drv/dma.h similarity index 100% rename from drivers/dma.h rename to drv/dma.h diff --git a/drivers/dma_cbuf.c b/drv/dma_cbuf.c similarity index 100% rename from drivers/dma_cbuf.c rename to drv/dma_cbuf.c diff --git a/drivers/dma_cbuf.h b/drv/dma_cbuf.h similarity index 70% rename from drivers/dma_cbuf.h rename to drv/dma_cbuf.h index 12ca678..4221f14 100644 --- a/drivers/dma_cbuf.h +++ b/drv/dma_cbuf.h @@ -15,6 +15,11 @@ //--type definitions------------------------------------------------------------ +/** + * Struct used by the circular buffer system. This system allows bufferized + * reads to a peripheral with no latency, minimal cpu usage and customisable + * buffer sizes + */ struct DmaCircBuffer { volatile void* buffer; //the buffer to use as a circular buffer volatile void* src; //source peripheral register @@ -32,6 +37,15 @@ struct DmaCircBuffer { //--functions------------------------------------------------------------------- +/** + * Configure a DMA circular buffer for a single DMA channel. A standard buffer + * is used a base to construct a circular buffer, supplied in data by DMA + * tranfers from a peripheral. The DMA's priority is given as parameters. + * The peripheral's specific configuration must be handled separately. + * + * Once this function is called, the system will start running right away and + * will stay running until manually stopped + */ void dma_cbuf_configure(volatile struct DmaCircBuffer* buffer, volatile void* raw_buffer, volatile void* src, uint16_t buffer_size, enum DmaPeriph dma, enum DmaChannel channel, enum DmaConfig priority); diff --git a/drivers/dma_mbuf.c b/drv/dma_mbuf.c similarity index 100% rename from drivers/dma_mbuf.c rename to drv/dma_mbuf.c diff --git a/drivers/dma_mbuf.h b/drv/dma_mbuf.h similarity index 100% rename from drivers/dma_mbuf.h rename to drv/dma_mbuf.h diff --git a/drivers/dma_regs.h b/drv/dma_regs.h similarity index 100% rename from drivers/dma_regs.h rename to drv/dma_regs.h diff --git a/drivers/exti.c b/drv/exti.c similarity index 100% rename from drivers/exti.c rename to drv/exti.c diff --git a/drivers/exti.h b/drv/exti.h similarity index 100% rename from drivers/exti.h rename to drv/exti.h diff --git a/drivers/exti_regs.h b/drv/exti_regs.h similarity index 100% rename from drivers/exti_regs.h rename to drv/exti_regs.h diff --git a/drivers/flash.c b/drv/flash.c similarity index 100% rename from drivers/flash.c rename to drv/flash.c diff --git a/drivers/flash.h b/drv/flash.h similarity index 100% rename from drivers/flash.h rename to drv/flash.h diff --git a/drivers/flash_regs.h b/drv/flash_regs.h similarity index 100% rename from drivers/flash_regs.h rename to drv/flash_regs.h diff --git a/drivers/gpio.c b/drv/gpio.c similarity index 100% rename from drivers/gpio.c rename to drv/gpio.c diff --git a/drivers/gpio.h b/drv/gpio.h similarity index 100% rename from drivers/gpio.h rename to drv/gpio.h diff --git a/drivers/gpio_regs.h b/drv/gpio_regs.h similarity index 100% rename from drivers/gpio_regs.h rename to drv/gpio_regs.h diff --git a/drivers/nvic.c b/drv/nvic.c similarity index 100% rename from drivers/nvic.c rename to drv/nvic.c diff --git a/drivers/nvic.h b/drv/nvic.h similarity index 100% rename from drivers/nvic.h rename to drv/nvic.h diff --git a/drivers/nvic_regs.h b/drv/nvic_regs.h similarity index 100% rename from drivers/nvic_regs.h rename to drv/nvic_regs.h diff --git a/drivers/rcc.c b/drv/rcc.c similarity index 100% rename from drivers/rcc.c rename to drv/rcc.c diff --git a/drivers/rcc.h b/drv/rcc.h similarity index 100% rename from drivers/rcc.h rename to drv/rcc.h diff --git a/drivers/rcc_regs.h b/drv/rcc_regs.h similarity index 100% rename from drivers/rcc_regs.h rename to drv/rcc_regs.h diff --git a/drivers/reg.h b/drv/reg.h similarity index 100% rename from drivers/reg.h rename to drv/reg.h diff --git a/drivers/usart.c b/drv/usart.c similarity index 100% rename from drivers/usart.c rename to drv/usart.c diff --git a/drivers/usart.h b/drv/usart.h similarity index 100% rename from drivers/usart.h rename to drv/usart.h diff --git a/drivers/usart_regs.h b/drv/usart_regs.h similarity index 100% rename from drivers/usart_regs.h rename to drv/usart_regs.h