snickerdoodle Platform Controller
firmware for STM32F0 platform controller
sd_buffer.c File Reference

Circular buffers. More...

#include <string.h>
#include "stm32f0xx_hal.h"
#include "sd_buffer.h"

Functions

enum sd_buff_err sd_char_buff_init (struct sd_cbuf *buff, uint32_t size, uint8_t *pbuff)
 Initialize Character Buffer. More...
 
enum sd_buff_err sd_doub_buff_init (struct sd_doub_buff *buff, uint32_t size, uint8_t **pbuff)
 Initialize Double Buffer. More...
 
enum sd_buff_err sd_char_buff_putc (struct sd_cbuf *buffer, uint8_t data)
 Put Character in Buffer Write a character to the buffer. More...
 
enum sd_buff_err sd_char_buff_putc_to (struct sd_cbuf *buffer, uint8_t data, uint32_t timeout)
 Put Character in Buffer with Timeout Write a character to the buffer with a timeout. More...
 
enum sd_buff_err sd_char_buff_write (struct sd_cbuf *buffer, uint8_t *data, uint32_t len)
 Write Data to Buffer Write a specified length of characters from a data pointer to the buffer. More...
 
enum sd_buff_err sd_char_buff_read (struct sd_cbuf *buff, uint8_t *data, uint32_t *len)
 Read Length of Characters from Buffer Copy a specified length of the buffer to a pointer. More...
 
enum sd_buff_err sd_char_buff_getc (struct sd_cbuf *buff, uint8_t *data)
 Get Character from Buffer Get a single character from the buffer. More...
 
enum sd_buff_err sd_char_buff_getc_to (struct sd_cbuf *buff, uint8_t *data, uint32_t timeout)
 Get Character from Buffer with Timeout Get a single character from the buffer with a timeout if the buffer is locked. More...
 
enum sd_buff_err sd_buff_reset (struct sd_cbuf *buff)
 Reset buffer Resets the in and out indexes of the buffer (without removing contents of the buffer) to the start of the buffer. More...
 
__weak void sd_char_write_end_cb (struct sd_cbuf *buff)
 Write Command End Callback User defined function executed when a write operation is completed. More...
 
__weak void sd_char_read_end_cb (struct sd_cbuf *buff)
 Read Command End Callback User defined function executed when a read operation is completed. More...
 

Detailed Description

Circular buffers.

Author
R. Bush bush@.nosp@m.krtk.nosp@m.l.com
Version
v1.0
Date
2016 March 28

Copyright (c) 2016, krtkl inc. All rights reserved.

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.

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 OWNER 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.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the FreeBSD Project.