[style] format files by clang-format

This commit is contained in:
jzlv 2021-06-20 12:25:46 +08:00
parent 47ce9f871c
commit d427e7fdda
1131 changed files with 7338846 additions and 422042 deletions

View file

@ -1,24 +1,24 @@
/**
* @file ring_buffer.c
* @brief
*
* @brief
*
* Copyright (c) 2021 Bouffalolab team
*
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
*
* http://www.apache.org/licenses/LICENSE-2.0
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
*
*/
#include "ring_buffer.h"
@ -70,7 +70,7 @@
* @{
*/
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Ring buffer init function
*
* @param rbType: Ring buffer type structure pointer
@ -82,29 +82,28 @@
* @return SUCCESS
*
*******************************************************************************/
BL_Err_Type Ring_Buffer_Init(Ring_Buffer_Type* rbType,uint8_t* buffer,uint32_t size,ringBuffer_Lock_Callback* lockCb,ringBuffer_Lock_Callback* unlockCb)
BL_Err_Type Ring_Buffer_Init(Ring_Buffer_Type *rbType, uint8_t *buffer, uint32_t size, ringBuffer_Lock_Callback *lockCb, ringBuffer_Lock_Callback *unlockCb)
{
/* Init ring buffer pointer */
rbType->pointer = buffer;
/* Init read/write mirror and index */
rbType->readMirror = 0;
rbType->readIndex = 0;
rbType->writeMirror = 0;
rbType->writeIndex = 0;
/* Set ring buffer size */
rbType->size = size;
/* Set lock and unlock callback function */
rbType->lock = lockCb;
rbType->unlock = unlockCb;
return SUCCESS;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Ring buffer reset function
*
* @param rbType: Ring buffer type structure pointer
@ -112,27 +111,26 @@ BL_Err_Type Ring_Buffer_Init(Ring_Buffer_Type* rbType,uint8_t* buffer,uint32_t s
* @return SUCCESS
*
*******************************************************************************/
BL_Err_Type Ring_Buffer_Reset(Ring_Buffer_Type* rbType)
BL_Err_Type Ring_Buffer_Reset(Ring_Buffer_Type *rbType)
{
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
/* Clear read/write mirror and index */
rbType->readMirror = 0;
rbType->readIndex = 0;
rbType->writeMirror = 0;
rbType->writeIndex = 0;
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
return SUCCESS;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Use callback function to write ring buffer function
*
* @param rbType: Ring buffer type structure pointer
@ -143,54 +141,55 @@ BL_Err_Type Ring_Buffer_Reset(Ring_Buffer_Type* rbType)
* @return Length of data actually write
*
*******************************************************************************/
uint32_t Ring_Buffer_Write_Callback(Ring_Buffer_Type* rbType,uint32_t length,ringBuffer_Write_Callback* writeCb,void* parameter)
uint32_t Ring_Buffer_Write_Callback(Ring_Buffer_Type *rbType, uint32_t length, ringBuffer_Write_Callback *writeCb, void *parameter)
{
uint32_t sizeRemained = Ring_Buffer_Get_Empty_Length(rbType);
if(writeCb == NULL){
if (writeCb == NULL) {
return 0;
}
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
/* Ring buffer has no space for new data */
if(sizeRemained == 0){
if(rbType->unlock != NULL){
if (sizeRemained == 0) {
if (rbType->unlock != NULL) {
rbType->unlock();
}
return 0;
}
/* Drop part of data when length out of space remained */
if(length > sizeRemained){
if (length > sizeRemained) {
length = sizeRemained;
}
/* Get size of space remained in current mirror */
sizeRemained = rbType->size - rbType->writeIndex;
if(sizeRemained > length){
if (sizeRemained > length) {
/* Space remained is enough for data in current mirror */
writeCb(parameter,&rbType->pointer[rbType->writeIndex],length);
writeCb(parameter, &rbType->pointer[rbType->writeIndex], length);
rbType->writeIndex += length;
}else{
} else {
/* Data is divided to two parts with different mirror */
writeCb(parameter,&rbType->pointer[rbType->writeIndex],sizeRemained);
writeCb(parameter,&rbType->pointer[0],length-sizeRemained);
rbType->writeIndex = length-sizeRemained;
writeCb(parameter, &rbType->pointer[rbType->writeIndex], sizeRemained);
writeCb(parameter, &rbType->pointer[0], length - sizeRemained);
rbType->writeIndex = length - sizeRemained;
rbType->writeMirror = ~rbType->writeMirror;
}
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
return length;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Copy data from data buffer to ring buffer function
*
* @param parameter: Pointer to source pointer
@ -200,16 +199,15 @@ uint32_t Ring_Buffer_Write_Callback(Ring_Buffer_Type* rbType,uint32_t length,rin
* @return None
*
*******************************************************************************/
static void Ring_Buffer_Write_Copy(void* parameter,uint8_t* dest,uint32_t length)
static void Ring_Buffer_Write_Copy(void *parameter, uint8_t *dest, uint32_t length)
{
uint8_t **src = (uint8_t **)parameter;
ARCH_MemCpy_Fast(dest,*src,length);
ARCH_MemCpy_Fast(dest, *src, length);
*src += length;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Write ring buffer function
*
* @param rbType: Ring buffer type structure pointer
@ -219,13 +217,12 @@ static void Ring_Buffer_Write_Copy(void* parameter,uint8_t* dest,uint32_t length
* @return Length of data writted actually
*
*******************************************************************************/
uint32_t Ring_Buffer_Write(Ring_Buffer_Type* rbType,const uint8_t* data,uint32_t length)
uint32_t Ring_Buffer_Write(Ring_Buffer_Type *rbType, const uint8_t *data, uint32_t length)
{
return Ring_Buffer_Write_Callback(rbType,length,Ring_Buffer_Write_Copy,&data);
return Ring_Buffer_Write_Callback(rbType, length, Ring_Buffer_Write_Copy, &data);
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Write 1 byte to ring buffer function
*
* @param rbType: Ring buffer type structure pointer
@ -234,38 +231,39 @@ uint32_t Ring_Buffer_Write(Ring_Buffer_Type* rbType,const uint8_t* data,uint32_t
* @return Length of data writted actually
*
*******************************************************************************/
uint32_t Ring_Buffer_Write_Byte(Ring_Buffer_Type* rbType,const uint8_t data)
uint32_t Ring_Buffer_Write_Byte(Ring_Buffer_Type *rbType, const uint8_t data)
{
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
/* Ring buffer has no space for new data */
if(!Ring_Buffer_Get_Empty_Length(rbType)){
if(rbType->unlock != NULL){
if (!Ring_Buffer_Get_Empty_Length(rbType)) {
if (rbType->unlock != NULL) {
rbType->unlock();
}
return 0;
}
rbType->pointer[rbType->writeIndex] = data;
/* Judge to change index and mirror */
if(rbType->writeIndex != (rbType->size-1)){
if (rbType->writeIndex != (rbType->size - 1)) {
rbType->writeIndex++;
}else{
} else {
rbType->writeIndex = 0;
rbType->writeMirror = ~rbType->writeMirror;
}
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
return 1;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Write ring buffer function, old data will be covered by new data when ring buffer is
* full
*
@ -276,52 +274,52 @@ uint32_t Ring_Buffer_Write_Byte(Ring_Buffer_Type* rbType,const uint8_t data)
* @return Length of data writted actually
*
*******************************************************************************/
uint32_t Ring_Buffer_Write_Force(Ring_Buffer_Type* rbType,const uint8_t* data,uint32_t length)
uint32_t Ring_Buffer_Write_Force(Ring_Buffer_Type *rbType, const uint8_t *data, uint32_t length)
{
uint32_t sizeRemained = Ring_Buffer_Get_Empty_Length(rbType);
uint32_t indexRemained = rbType->size - rbType->writeIndex;
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
/* Drop extra data when data length is large than size of ring buffer */
if(length > rbType->size){
if (length > rbType->size) {
data = &data[length - rbType->size];
length = rbType->size;
}
if(indexRemained > length){
if (indexRemained > length) {
/* Space remained is enough for data in current mirror */
ARCH_MemCpy_Fast(&rbType->pointer[rbType->writeIndex],data,length);
ARCH_MemCpy_Fast(&rbType->pointer[rbType->writeIndex], data, length);
rbType->writeIndex += length;
/* Update read index */
if(length > sizeRemained){
if (length > sizeRemained) {
rbType->readIndex = rbType->writeIndex;
}
}else{
} else {
/* Data is divided to two parts with different mirror */
ARCH_MemCpy_Fast(&rbType->pointer[rbType->writeIndex],data,indexRemained);
ARCH_MemCpy_Fast(&rbType->pointer[0],&data[indexRemained],length-indexRemained);
rbType->writeIndex = length-indexRemained;
ARCH_MemCpy_Fast(&rbType->pointer[rbType->writeIndex], data, indexRemained);
ARCH_MemCpy_Fast(&rbType->pointer[0], &data[indexRemained], length - indexRemained);
rbType->writeIndex = length - indexRemained;
rbType->writeMirror = ~rbType->writeMirror;
/* Update read index and mirror */
if(length > sizeRemained){
if (length > sizeRemained) {
rbType->readIndex = rbType->writeIndex;
rbType->readMirror = ~rbType->readMirror;
}
}
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
return length;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Write 1 byte to ring buffer function, old data will be covered by new data when ring
* buffer is full
*
@ -331,43 +329,43 @@ uint32_t Ring_Buffer_Write_Force(Ring_Buffer_Type* rbType,const uint8_t* data,ui
* @return Length of data writted actually
*
*******************************************************************************/
uint32_t Ring_Buffer_Write_Byte_Force(Ring_Buffer_Type* rbType,const uint8_t data)
uint32_t Ring_Buffer_Write_Byte_Force(Ring_Buffer_Type *rbType, const uint8_t data)
{
Ring_Buffer_Status_Type status = Ring_Buffer_Get_Status(rbType);
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
rbType->pointer[rbType->writeIndex] = data;
/* Judge to change index and mirror */
if(rbType->writeIndex == rbType->size-1){
if (rbType->writeIndex == rbType->size - 1) {
rbType->writeIndex = 0;
rbType->writeMirror = ~rbType->writeMirror;
/* Update read index and mirror */
if(status == RING_BUFFER_FULL){
if (status == RING_BUFFER_FULL) {
rbType->readIndex = rbType->writeIndex;
rbType->readMirror = ~rbType->readMirror;
}
}else{
} else {
rbType->writeIndex++;
/* Update read index */
if(status == RING_BUFFER_FULL){
if (status == RING_BUFFER_FULL) {
rbType->readIndex = rbType->writeIndex;
}
}
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
return 1;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Use callback function to read ring buffer function
*
* @param rbType: Ring buffer type structure pointer
@ -378,54 +376,55 @@ uint32_t Ring_Buffer_Write_Byte_Force(Ring_Buffer_Type* rbType,const uint8_t dat
* @return Length of data actually read
*
*******************************************************************************/
uint32_t Ring_Buffer_Read_Callback(Ring_Buffer_Type* rbType,uint32_t length,ringBuffer_Read_Callback* readCb,void* parameter)
uint32_t Ring_Buffer_Read_Callback(Ring_Buffer_Type *rbType, uint32_t length, ringBuffer_Read_Callback *readCb, void *parameter)
{
uint32_t size = Ring_Buffer_Get_Length(rbType);
if(readCb == NULL){
if (readCb == NULL) {
return 0;
}
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
/* Ring buffer has no data */
if(!size){
if(rbType->unlock != NULL){
if (!size) {
if (rbType->unlock != NULL) {
rbType->unlock();
}
return 0;
}
/* Ring buffer do not have enough data */
if(size < length){
if (size < length) {
length = size;
}
/* Get size of space remained in current mirror */
size = rbType->size - rbType->readIndex;
if(size > length){
if (size > length) {
/* Read all data needed */
readCb(parameter,&rbType->pointer[rbType->readIndex],length);
readCb(parameter, &rbType->pointer[rbType->readIndex], length);
rbType->readIndex += length;
}else{
} else {
/* Read two part of data in different mirror */
readCb(parameter,&rbType->pointer[rbType->readIndex],size);
readCb(parameter,&rbType->pointer[0],length-size);
rbType->readIndex = length-size;
readCb(parameter, &rbType->pointer[rbType->readIndex], size);
readCb(parameter, &rbType->pointer[0], length - size);
rbType->readIndex = length - size;
rbType->readMirror = ~rbType->readMirror;
}
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
return length;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Copy data from ring buffer to data buffer function
*
* @param parameter: Pointer to destination pointer
@ -435,16 +434,15 @@ uint32_t Ring_Buffer_Read_Callback(Ring_Buffer_Type* rbType,uint32_t length,ring
* @return None
*
*******************************************************************************/
static void Ring_Buffer_Read_Copy(void* parameter,uint8_t* data,uint32_t length)
static void Ring_Buffer_Read_Copy(void *parameter, uint8_t *data, uint32_t length)
{
uint8_t **dest = (uint8_t **)parameter;
ARCH_MemCpy_Fast(*dest,data,length);
ARCH_MemCpy_Fast(*dest, data, length);
*dest += length;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Read ring buffer function
*
* @param rbType: Ring buffer type structure pointer
@ -454,13 +452,12 @@ static void Ring_Buffer_Read_Copy(void* parameter,uint8_t* data,uint32_t length)
* @return Length of data read actually
*
*******************************************************************************/
uint32_t Ring_Buffer_Read(Ring_Buffer_Type* rbType,uint8_t* data,uint32_t length)
uint32_t Ring_Buffer_Read(Ring_Buffer_Type *rbType, uint8_t *data, uint32_t length)
{
return Ring_Buffer_Read_Callback(rbType,length,Ring_Buffer_Read_Copy,&data);
return Ring_Buffer_Read_Callback(rbType, length, Ring_Buffer_Read_Copy, &data);
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Read 1 byte from ring buffer function
*
* @param rbType: Ring buffer type structure pointer
@ -469,39 +466,40 @@ uint32_t Ring_Buffer_Read(Ring_Buffer_Type* rbType,uint8_t* data,uint32_t length
* @return Length of data actually read
*
*******************************************************************************/
uint32_t Ring_Buffer_Read_Byte(Ring_Buffer_Type* rbType,uint8_t* data)
uint32_t Ring_Buffer_Read_Byte(Ring_Buffer_Type *rbType, uint8_t *data)
{
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
/* Ring buffer has no data */
if(!Ring_Buffer_Get_Length(rbType)){
if(rbType->unlock != NULL){
if (!Ring_Buffer_Get_Length(rbType)) {
if (rbType->unlock != NULL) {
rbType->unlock();
}
return 0;
}
/* Read data */
*data = rbType->pointer[rbType->readIndex];
/* Update read index and mirror */
if(rbType->readIndex == rbType->size-1){
if (rbType->readIndex == rbType->size - 1) {
rbType->readIndex = 0;
rbType->readMirror = ~rbType->readMirror;
}else{
} else {
rbType->readIndex++;
}
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
return 1;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Read ring buffer function, do not remove from buffer actually
*
* @param rbType: Ring buffer type structure pointer
@ -511,47 +509,48 @@ uint32_t Ring_Buffer_Read_Byte(Ring_Buffer_Type* rbType,uint8_t* data)
* @return Length of data read actually
*
*******************************************************************************/
uint32_t Ring_Buffer_Peek(Ring_Buffer_Type* rbType,uint8_t* data,uint32_t length)
uint32_t Ring_Buffer_Peek(Ring_Buffer_Type *rbType, uint8_t *data, uint32_t length)
{
uint32_t size = Ring_Buffer_Get_Length(rbType);
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
/* Ring buffer has no data */
if(!size){
if(rbType->unlock != NULL){
if (!size) {
if (rbType->unlock != NULL) {
rbType->unlock();
}
return 0;
}
/* Ring buffer do not have enough data */
if(size < length){
if (size < length) {
length = size;
}
/* Get size of space remained in current mirror */
size = rbType->size - rbType->readIndex;
if(size > length){
if (size > length) {
/* Read all data needed */
ARCH_MemCpy_Fast(data,&rbType->pointer[rbType->readIndex],length);
}else{
ARCH_MemCpy_Fast(data, &rbType->pointer[rbType->readIndex], length);
} else {
/* Read two part of data in different mirror */
ARCH_MemCpy_Fast(data,&rbType->pointer[rbType->readIndex],size);
ARCH_MemCpy_Fast(&data[size],&rbType->pointer[0],length-size);
ARCH_MemCpy_Fast(data, &rbType->pointer[rbType->readIndex], size);
ARCH_MemCpy_Fast(&data[size], &rbType->pointer[0], length - size);
}
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
return length;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Read 1 byte from ring buffer function, do not remove from buffer actually
*
* @param rbType: Ring buffer type structure pointer
@ -560,31 +559,32 @@ uint32_t Ring_Buffer_Peek(Ring_Buffer_Type* rbType,uint8_t* data,uint32_t length
* @return Length of data actually read
*
*******************************************************************************/
uint32_t Ring_Buffer_Peek_Byte(Ring_Buffer_Type* rbType,uint8_t* data)
uint32_t Ring_Buffer_Peek_Byte(Ring_Buffer_Type *rbType, uint8_t *data)
{
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
/* Ring buffer has no data */
if(!Ring_Buffer_Get_Length(rbType)){
if(rbType->unlock != NULL){
if (!Ring_Buffer_Get_Length(rbType)) {
if (rbType->unlock != NULL) {
rbType->unlock();
}
return 0;
}
/* Read data */
*data = rbType->pointer[rbType->readIndex];
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
return 1;
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Get length of data in ring buffer function
*
* @param rbType: Ring buffer type structure pointer
@ -592,37 +592,36 @@ uint32_t Ring_Buffer_Peek_Byte(Ring_Buffer_Type* rbType,uint8_t* data)
* @return Length of data
*
*******************************************************************************/
uint32_t Ring_Buffer_Get_Length(Ring_Buffer_Type* rbType)
uint32_t Ring_Buffer_Get_Length(Ring_Buffer_Type *rbType)
{
uint32_t readMirror = 0;
uint32_t writeMirror = 0;
uint32_t readIndex = 0;
uint32_t writeIndex = 0;
uint32_t size = 0;
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
readMirror = rbType->readMirror;
writeMirror = rbType->writeMirror;
readIndex = rbType->readIndex;
writeIndex = rbType->writeIndex;
size = rbType->size;
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
if(readMirror == writeMirror){
if (readMirror == writeMirror) {
return writeIndex - readIndex;
}else{
} else {
return size - (readIndex - writeIndex);
}
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Get space remained in ring buffer function
*
* @param rbType: Ring buffer type structure pointer
@ -630,13 +629,12 @@ uint32_t Ring_Buffer_Get_Length(Ring_Buffer_Type* rbType)
* @return Length of space remained
*
*******************************************************************************/
uint32_t Ring_Buffer_Get_Empty_Length(Ring_Buffer_Type* rbType)
uint32_t Ring_Buffer_Get_Empty_Length(Ring_Buffer_Type *rbType)
{
return (rbType->size - Ring_Buffer_Get_Length(rbType));
}
/****************************************************************************//**
/****************************************************************************/ /**
* @brief Get ring buffer status function
*
* @param rbType: Ring buffer type structure pointer
@ -644,33 +642,36 @@ uint32_t Ring_Buffer_Get_Empty_Length(Ring_Buffer_Type* rbType)
* @return Status of ring buffer
*
*******************************************************************************/
Ring_Buffer_Status_Type Ring_Buffer_Get_Status(Ring_Buffer_Type* rbType)
Ring_Buffer_Status_Type Ring_Buffer_Get_Status(Ring_Buffer_Type *rbType)
{
if(rbType->lock != NULL){
if (rbType->lock != NULL) {
rbType->lock();
}
/* Judge empty or full */
if(rbType->readIndex == rbType->writeIndex){
if(rbType->readMirror == rbType->writeMirror){
if(rbType->unlock != NULL){
if (rbType->readIndex == rbType->writeIndex) {
if (rbType->readMirror == rbType->writeMirror) {
if (rbType->unlock != NULL) {
rbType->unlock();
}
return RING_BUFFER_EMPTY;
}else{
if(rbType->unlock != NULL){
} else {
if (rbType->unlock != NULL) {
rbType->unlock();
}
return RING_BUFFER_FULL;
}
}
if(rbType->unlock != NULL){
if (rbType->unlock != NULL) {
rbType->unlock();
}
return RING_BUFFER_PARTIAL;
}
/*@} end of group RING_BUFFER_Public_Functions */
/*@} end of group RING_BUFFER */