BaseFlight_USART - FabLabSeoul/WingProject GitHub Wiki

오픈소스 Multiwii BaseFlight의 USART 라이브러리를 분석한 글이다. 자세한 내용보다는 개념적으로 설명한다. 자세히 알고 싶다면 소스를 보자.

이 글은 Stm32 value line discovery 보드를 토대로 하고 있다.

예제는 STM32\stm32vldiscovery_package\Project\Examples\Serial_Baseflight 경로에 있다. Base flight의 USART 라이브러리를 이용해 PC와 시리얼 통신하는 예제다. 시작하면 Start 문자열을 보내고, 열 개의 문자를 받으면, 그 문자 그대로 재전송하는 예제다.

###Baseflight USART

baseflight의 USART는 여러 라이브러리가 묶여있는 형태다.

• drv_uart.c,h : usart 생성 및 초기화, 인터럽트 처리
• drv_serial.c,h : usart 추상화
• serial.c : baseflight 전용 시리얼통신 처리, CLI(command line interface)

실제 baseflight의 USART 부분만 가져다 쓰고 싶으면, drv_uart.c,h 라이브러리만 있으면 된다. 나머지 두 개는 baseflight에서 쓰이기 위해 모듈화 된 형태로 되어있다.

drv_serial.c,h

시리얼 통신을 위한 포트 구조체와, 시리얼 포트 추상화를 위한 함수 포인터 테이블을 선언하고 있다.

가장 핵심인 serialPort_t 구조체를 눈여겨보자.

typedef enum portMode_t {
    MODE_RX = 1 << 0,
    MODE_TX = 1 << 1,
    MODE_RXTX = MODE_RX | MODE_TX,
    MODE_SBUS = 1 << 2,
} portMode_t;

typedef struct serialPort {

    const struct serialPortVTable *vTable; // serial port 가상함수 테이블, 현재는 하나만 쓰임.

    portMode_t mode; // Rx,Tx 설정
    uint32_t baudRate;

    uint32_t rxBufferSize; // receiver buffer size
    uint32_t txBufferSize; // transmitter buffer size
    volatile uint8_t *rxBuffer; // receiver buffer pointer
    volatile uint8_t *txBuffer; // transmitter buffer size
    uint32_t rxBufferHead; // receiver buffer 에 정보가 저장될 index
    uint32_t rxBufferTail; // receiver buffer 에 정보가 저장된 첫 번째 index
    uint32_t txBufferHead; // transmitter buffer 에 정보가 저장될 index
    uint32_t txBufferTail; // transmitter buffer 에 정보가 저장된 첫 번째 index

    // FIXME rename member to rxCallback
    serialReceiveCallbackPtr callback;
} serialPort_t;

mode, baudRate 변수로 쓰기용, 읽기용 타입을 결정하며, Serial BaudRate를 설정한다.

시리얼통신을 위해 버퍼를 사용하고 있다. 버퍼는 Ring형태이며, xxBufferHead 변수가 정보가 저장될 index를 가르키며, xxBufferTail은 첫 번째 정보가 저장된 index를 가르킨다. 예를들어 버퍼정보를 transmitt한다면, Tail index부터 Head index까지 하나씩 전송하게 된다. 모든 버퍼가 전송 되었다면, Tail index == Head index 상태가 된다. 이 비교로 버퍼가 비어있는지 판단한다.

C언어로 C++의 virtual function을 흉내낸 함수 포인터 구조체 serialPortVTable이 있다. 이 예제에서는 똑같은 함수만 사용할 것이기 때문에, 이 구조체는 쓰고는 있지만, 제대로 쓰지 않고 있다.

serialPortVTable은 시리얼 read, write와 시리얼 통신 상태를 설정하고, 얻어오는 함수포인터 모음 구조체다.

struct serialPortVTable {
    void (*serialWrite)(serialPort_t *instance, uint8_t ch);

    uint8_t (*serialTotalBytesWaiting)(serialPort_t *instance);

    uint8_t (*serialRead)(serialPort_t *instance);

    // Specified baud rate may not be allowed by an implementation, use serialGetBaudRate to determine actual baud rate in use.
    void (*serialSetBaudRate)(serialPort_t *instance, uint32_t baudRate);

    bool (*isSerialTransmitBufferEmpty)(serialPort_t *instance);

    void (*setMode)(serialPort_t *instance, portMode_t mode);
};

drv_serial.c 에서는 drv_uart.c,h 라이브러리에 있는 함수들을 래핑하고 있다. 시리얼통신에 대한 자세한 내용은 drv_uart 라이브러리에서 확인 할 수 있다.

drv_uart.c,h

USART 통신을 위한 핵심 구조체가 선언되어있고, 시리얼포트를 생성하고, DMA, Interrupt를 생성하고, 인터럽트를 처리하는 코드가 있다. 다시말하면, 시리얼통신의 핵심 코드가 이 라이브러리에 있다.

typedef struct {
    serialPort_t port; // 시리얼 통신 포트 정보

    // FIXME these are uart specific and do not belong in here
    DMA_Channel_TypeDef *rxDMAChannel; // receiver DMA 채널 포인터
    DMA_Channel_TypeDef *txDMAChannel; // transmitter DMA 채널 포인터

    uint32_t rxDMAIrq;
    uint32_t txDMAIrq;

    uint32_t rxDMAPos; // DMA reciever일 때, 버퍼를 읽을 위치를 나타낸다.
    bool txDMAEmpty; // DMA buffer가 비어있을 때 true가 된다.

    USART_TypeDef *USARTx; // 통신하는 UART 포인터
} uartPort_t;

구조체 uartPort_t는 DMA방식과 Interrupt 방식 모두를 사용할 수 있게 설계되어 있다. 자세히 얘기하자면 rxDMAChannel 이 NULL이라면 인터럽트 방식을 사용하고, NULL이 아니라면 DMA방식을 사용해 시리얼통신을 한다.

시리얼통신에 관련된 정보는 serialPort_t port;에서 관리한다. uartPort_t는 DMA, Interrupt를 제어를 위한 객체라고 보면 된다.

drv_uart 헤더 파일

#pragma once

#define UART_BUFFER_SIZE    64

#define UART1_RX_BUFFER_SIZE    256
#define UART1_TX_BUFFER_SIZE    256
#define UART2_RX_BUFFER_SIZE    128
#define UART2_TX_BUFFER_SIZE    64
#define UART3_RX_BUFFER_SIZE    256
#define UART3_TX_BUFFER_SIZE    256
#define MAX_SERIAL_PORTS        3

// FIXME this is a uart_t really.  Move the generic properties into a separate structure (serialPort_t) and update the code to use it
typedef struct {
    serialPort_t port;

    // FIXME these are uart specific and do not belong in here
    DMA_Channel_TypeDef *rxDMAChannel; // receiver DMA 채널 포인터
    DMA_Channel_TypeDef *txDMAChannel; // transmitter DMA 채널 포인터

    uint32_t rxDMAIrq;
    uint32_t txDMAIrq;

    uint32_t rxDMAPos; // DMA reciever일 때, 버퍼를 읽을 위치를 나타낸다.
    bool txDMAEmpty; // DMA buffer가 비어있을 때 true가 된다.

    USART_TypeDef *USARTx;
} uartPort_t;

extern const struct serialPortVTable uartVTable[];

serialPort_t *uartOpen(USART_TypeDef *USARTx, serialReceiveCallbackPtr callback, uint32_t baudRate, portMode_t mode);

// serialPort API
void uartWrite(serialPort_t *instance, uint8_t ch);
uint8_t uartTotalBytesWaiting(serialPort_t *instance);
uint8_t uartRead(serialPort_t *instance);
void uartSetBaudRate(serialPort_t *s, uint32_t baudRate);
bool isUartTransmitBufferEmpty(serialPort_t *s);

시리얼포트를 생성하는 함수는 uartOpen() 다. USART1,2,3 포트에 따라 다르게 생성되는데, baseflight는 각 USART포트마다 정해진 역할이 있는 듯하다. 공용 usart 라이브러리로 쓰고 싶다면, serialUSART1,2,3() 함수를 수정해줘야 한다.

serialUSART1()로 시리얼포트가 생성되었다면, Transmitter는 DMA channel4 로 동작한다. DMA1_Channel4_IRQn 으로 DMA 인터럽트로 제어 된다. receiver는 DMA로 동작한다. 시리얼통신으로 부터 받은 정보를 가져오려면, uartPort_t.rxDMAPos를 이용해야한다. rxDMAPos는 통신으로부터 읽을 정보 개수를 뜻하며, read() 함수를 호출 할 때마다 -1 씩 줄어든다. rxDMAPos 값과는 다르게 실제 버퍼에서 정보를 가져올 때는 0 ~ buffersize 순으로 가져오게 된다. 자세한 내용은 uartRead()함수에서 확인하자.