los_cir_buf.h 文件参考

浏览源代码.

结构体
struct	CirBuf

枚举
enum	CirBufStatus { CBUF_UNUSED , CBUF_USED }

函数
UINT32	LOS_CirBufInit (CirBuf *cirbufCB, CHAR *fifo, UINT32 size)
	初始化循环buf 更多...
VOID	LOS_CirBufDeinit (CirBuf *cirbufCB)
	删除初始化操作，其实就是清0 更多...
UINT32	LOS_CirBufWrite (CirBuf *cirbufCB, const CHAR *buf, UINT32 size)
	写入数据到循环buf区 更多...
UINT32	LOS_CirBufRead (CirBuf *cirbufCB, CHAR *buf, UINT32 size)
	读取循环buf的数据 更多...
UINT32	LOS_CirBufUsedSize (CirBuf *cirbufCB)
	返回循环buf已使用的大小 更多...

枚举类型说明

CirBufStatus

enum CirBufStatus

枚举值
CBUF_UNUSED
CBUF_USED

在文件 los_cir_buf.h 第 45 行定义.

             {
    CBUF_UNUSED,//未使用
    CBUF_USED   //已使用
} CirBufStatus;

函数说明

LOS_CirBufDeinit()

VOID LOS_CirBufDeinit

(

CirBuf *

cirbufCB

)

删除初始化操作，其实就是清0

在文件 los_cir_buf.c 第 241 行定义.

{
    (VOID)memset_s(cirbufCB, sizeof(CirBuf), 0, sizeof(CirBuf));
}

这是这个函数的调用关系图:

LOS_CirBufInit()

UINT32 LOS_CirBufInit	(	CirBuf *	cirbufCB,
		CHAR *	fifo,
		UINT32	size
	)

初始化循环buf

在文件 los_cir_buf.c 第 225 行定义.

{
    if ((cirbufCB == NULL) || (fifo == NULL)) {
        return LOS_NOK;
    }
 
    (VOID)memset_s(cirbufCB, sizeof(CirBuf), 0, sizeof(CirBuf));//清0
    LOS_SpinInit(&cirbufCB->lock);//自旋锁初始化
    cirbufCB->size = size;  //记录size
    cirbufCB->remain = size;//剩余size
    cirbufCB->status = CBUF_USED;//标记为已使用
    cirbufCB->fifo = fifo;  //顺序buf ,这1K buf 是循环利用
 
    return LOS_OK;
}

函数调用图:

这是这个函数的调用关系图:

LOS_CirBufRead()

UINT32 LOS_CirBufRead	(	CirBuf *	cirbufCB,
		CHAR *	buf,
		UINT32	size
	)

读取循环buf的数据

在文件 los_cir_buf.c 第 199 行定义.

{
    UINT32 cpSize = 0;
    UINT32 intSave;
 
    if ((cirbufCB == NULL) || (buf == NULL) || (size == 0) || (cirbufCB->status != CBUF_USED)) {
        return 0;
    }
 
    LOS_SpinLockSave(&cirbufCB->lock, &intSave);
 
    if ((cirbufCB->fifo == NULL) || (cirbufCB->remain == cirbufCB->size)) {
        goto EXIT;
    }
 
    if (cirbufCB->startIdx >= cirbufCB->endIdx) {//开始位置大于结束位置的情况怎么读
        cpSize = OsCirBufReadLoop(cirbufCB, buf, size);//循环读取buf
    } else {//开始位置小于结束位置的情况怎么读
        cpSize = OsCirBufReadLinear(cirbufCB, buf, size);//线性读取，读取 endIdx - startIdx 部分就行了，所以是线性读取 
    }
 
EXIT:
    LOS_SpinUnlockRestore(&cirbufCB->lock, intSave);
    return cpSize;
}

函数调用图:

这是这个函数的调用关系图:

LOS_CirBufUsedSize()

UINT32 LOS_CirBufUsedSize

(

CirBuf *

cirbufCB

)

返回循环buf已使用的大小

在文件 los_cir_buf.c 第 37 行定义.

{
    UINT32 size;
    UINT32 intSave;
 
    LOS_SpinLockSave(&cirbufCB->lock, &intSave);
    size = cirbufCB->size - cirbufCB->remain; //得到已使用大小
    LOS_SpinUnlockRestore(&cirbufCB->lock, intSave);
 
    return size;
}

函数调用图:

这是这个函数的调用关系图:

LOS_CirBufWrite()

UINT32 LOS_CirBufWrite	(	CirBuf *	cirbufCB,
		const CHAR *	buf,
		UINT32	size
	)

写入数据到循环buf区

在文件 los_cir_buf.c 第 112 行定义.

{
    UINT32 cpSize = 0;
    UINT32 intSave;
 
    if ((cirbufCB == NULL) || (buf == NULL) || (size == 0) || (cirbufCB->status != CBUF_USED)) {
        return 0;
    }
 
    LOS_SpinLockSave(&cirbufCB->lock, &intSave);
 
    if ((cirbufCB->fifo == NULL) || (cirbufCB->remain == 0))  {
        goto EXIT;;
    }
 
    if (cirbufCB->startIdx <= cirbufCB->endIdx) {//开始位置在前面
        cpSize = OsCirBufWriteLoop(cirbufCB, buf, size);//循环方式写入，分两次拷贝
    } else {
        cpSize = OsCirBufWriteLinear(cirbufCB, buf, size);//线性方式写入，分一次拷贝
    }
 
EXIT:
    LOS_SpinUnlockRestore(&cirbufCB->lock, intSave);
    return cpSize;
}

函数调用图:

这是这个函数的调用关系图: