RingBuffer

注意事項

どうせ自分しか使わないからシンプルに，やりたいように作った
バッファがあふれたらもう使い物にならん．バッファを作り直してくれ
いっぱいになったときにPutできなくなる
いっぱいになった後，最初の1文字が上書きされ続ける(やばすぎやろ...)

License

MIT License

Copyright © 2024 ygdstmidn

see LICENSE

使用例

初期化

RingBuffer rb;

RingBuffer_Init(&rb, 256);

Initしたときにmallocしてメモリ確保に失敗すると1が返ってくる．

Put

void IRQ_handler()
{
    unsigned char data; // = UART_Receive();
    RingBuffer_Put(&rb, data);
}

割り込み処理関数で使うことを想定

実際の使用例

void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart)
{
  RingBuffer_HeadMove(&uart2_rxbuf);
  HAL_UART_Receive_IT(&huart2, uart2_rxbuf.buffer + uart2_rxbuf.head, 1);
}

Get

unsigned char data[256];
unsigned int i = 0;
__disable_irq();
if (rb.isntFull == 1)
{
    while (rb.head != rb.tail)
    {
        data[i] = RingBuffer_Get(&rb);
    }
}
else
{
    printf("Buffer is full\n");
    Error_Handler();
}
__enable_irq();

別のバッファに移して使う

unsigned char data[256];
unsigned int i = 0;
__disable_irq();
while (rb.head != rb.tail||rb.isntFull == 1)
{
    data[i] = RingBuffer_Get(&rb);
    __enable_irq();
    __disable_irq();
}
if(rb.isntFull == 0)
{
    printf("Buffer is full\n");
    Error_Handler();
}
__enable_irq();

こっちの方がいいかなぁ?

実際の使用例

unsigned char recievedata[UART_RXBUF_SIZE];
unsigned int index = 0;
__disable_irq();
while (uart2_rxbuf.head != uart2_rxbuf.tail && uart2_rxbuf.isntFull == 1)
{
    recievedata[index++] = RingBuffer_Get(&uart2_rxbuf);
    __enable_irq();
    __disable_irq();
}
if (uart2_rxbuf.isntFull == 0)
{
    RingBuffer_Destroy(&uart2_rxbuf);
    RingBuffer_Init(&uart2_rxbuf, UART_RXBUF_SIZE);
    index = 0;
}
__enable_irq();

メモリ開放

RingBuffer_Destroy(&rb);

メモリは開放すること

if(rb.isntFull == 0)
{
    RingBuffer_Destroy(&rb);
    RingBuffer_Init(&rb, 256);
}

バッファがあふれたらバッファを作り直すことをお勧めする
というか，これが起きないようにバッファは大きめに確保しようね☆
作り直すときは割り込みを無効にしてからやらないと

HeadMove

HALの割り込みの仕様上，割り込みで直接RingBufferにデータを入れた後，割り込み完了関数でHeadを動かす必要がある\

RingBuffer_HeadMove(&rb);

memo

gcc main.c RingBuffer.c

同時にコンパイルしないとエラーになるよ