ESP-IDF
RingbufferDefinition
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading...
Files
loading...
Summary
Syntax
Related
Examples
References
Call Tree
Data Use
Class Tree
Override Tree
Implementations
Instances
Lifecycle
SourceVu
ESP-IDF Framework and Examples
ESP-IDF
RingbufferDefinition
RingbufferDefinition struct
Syntax
Show:
Summary
Declaration
Definition
from
ringbuf.c:44
typedef
struct
RingbufferDefinition
Ringbuffer_t
;
Implemented in
ringbuf.c:52
Fields
Field
Declared as
RingbufferDefinition::xSize
size_t
RingbufferDefinition::xMaxItemSize
size_t
RingbufferDefinition::uxRingbufferFlags
UBaseType_t
RingbufferDefinition::xCheckItemFits
CheckItemFitsFunction_t
RingbufferDefinition::vCopyItem
CopyItemFunction_t
RingbufferDefinition::pvGetItem
GetItemFunction_t
RingbufferDefinition::vReturnItem
ReturnItemFunction_t
RingbufferDefinition::xGetCurMaxSize
GetCurMaxSizeFunction_t
RingbufferDefinition::pucAcquire
uint8_t
*
RingbufferDefinition::pucWrite
uint8_t
*
RingbufferDefinition::pucRead
uint8_t
*
RingbufferDefinition::pucFree
uint8_t
*
RingbufferDefinition::pucHead
uint8_t
*
RingbufferDefinition::pucTail
uint8_t
*
RingbufferDefinition::xItemsWaiting
BaseType_t
RingbufferDefinition::xTasksWaitingToSend
List_t
RingbufferDefinition::xTasksWaitingToReceive
List_t
RingbufferDefinition::xQueueSet
QueueSetHandle_t
RingbufferDefinition::mux
portMUX_TYPE
Related Functions
Found 20 other functions taking a
RingbufferDefinition
argument:
Function
prvCheckItemAvail()
prvReceiveGeneric()
prvReceiveGenericFromISR()
prvCheckItemFitsDefault()
prvInitializeNewRingbuffer()
prvReturnItemDefault()
prvGetItemDefault()
prvSendAcquireGeneric()
prvCheckItemFitsByteBuffer()
prvGetFreeSize()
prvCopyItemNoSplit()
prvCopyItemAllowSplit()
prvAcquireItemNoSplit()
prvSendItemDoneNoSplit()
prvCopyItemByteBuf()
prvGetItemByteBuf()
prvGetCurMaxSizeAllowSplit()
prvReturnItemByteBuf()
prvGetCurMaxSizeNoSplit()
prvGetCurMaxSizeByteBuf()
Examples
References
from
examples
Code
Location
Scope
Referrer
typedef
struct
RingbufferDefinition
Ringbuffer_t
;
ringbuf.c:44
typedef
struct
RingbufferDefinition
{
ringbuf.c:52
}
Ringbuffer_t
;
ringbuf.c:76
typedef
struct
RingbufferDefinition
Ringbuffer_t
;
ringbuf.c:44
Ringbuffer_t
typedef
BaseType_t
(
*
CheckItemFitsFunction_t
)
(
Ringbuffer_t
*
pxRingbuffer
,
size_t
xItemSize
)
;
ringbuf.c:45
typedef
void
(
*
CopyItemFunction_t
)
(
Ringbuffer_t
*
pxRingbuffer
,
const
uint8_t
*
pcItem
,
size_t
xItemSize
)
;
ringbuf.c:46
typedef
BaseType_t
(
*
CheckItemAvailFunction_t
)
(
Ringbuffer_t
*
pxRingbuffer
)
;
ringbuf.c:47
typedef
void
*
(
*
GetItemFunction_t
)
(
Ringbuffer_t
*
pxRingbuffer
,
BaseType_t
*
pxIsSplit
,
size_t
xMaxSize
,
size_t
*
pxItemSize
)
;
ringbuf.c:48
typedef
void
(
*
ReturnItemFunction_t
)
(
Ringbuffer_t
*
pxRingbuffer
,
uint8_t
*
pvItem
)
;
ringbuf.c:49
typedef
size_t
(
*
GetCurMaxSizeFunction_t
)
(
Ringbuffer_t
*
pxRingbuffer
)
;
ringbuf.c:50
}
Ringbuffer_t
;
ringbuf.c:76
Ringbuffer_t
_Static_assert
(
sizeof
(
StaticRingbuffer_t
)
==
sizeof
(
Ringbuffer_t
)
,
"StaticRingbuffer_t != Ringbuffer_t"
)
;
ringbuf.c:78
Ringbuffer_t
*
pxNewRingbuffer
,
ringbuf.c:91
prvInitializeNewRingbuffer()
prvInitializeNewRingbuffer()::pxNewRingbuffer
static
size_t
prvGetFreeSize
(
Ringbuffer_t
*
pxRingbuffer
)
;
ringbuf.c:95
prvGetFreeSize()
prvGetFreeSize()::pxRingbuffer
static
BaseType_t
prvCheckItemAvail
(
Ringbuffer_t
*
pxRingbuffer
)
;
ringbuf.c:98
prvCheckItemAvail()
prvCheckItemAvail()::pxRingbuffer
static
BaseType_t
prvCheckItemFitsDefault
(
Ringbuffer_t
*
pxRingbuffer
,
size_t
xItemSize
)
;
ringbuf.c:101
prvCheckItemFitsDefault()
prvCheckItemFitsDefault()::pxRingbuffer
static
BaseType_t
prvCheckItemFitsByteBuffer
(
Ringbuffer_t
*
pxRingbuffer
,
size_t
xItemSize
)
;
ringbuf.c:104
prvCheckItemFitsByteBuffer()
prvCheckItemFitsByteBuffer()::pxRingbuffer
static
void
prvCopyItemNoSplit
(
Ringbuffer_t
*
pxRingbuffer
,
const
uint8_t
*
pucItem
,
size_t
xItemSize
)
;
ringbuf.c:115
prvCopyItemNoSplit()
prvCopyItemNoSplit()::pxRingbuffer
static
void
prvCopyItemAllowSplit
(
Ringbuffer_t
*
pxRingbuffer
,
const
uint8_t
*
pucItem
,
size_t
xItemSize
)
;
ringbuf.c:126
prvCopyItemAllowSplit()
prvCopyItemAllowSplit()::pxRingbuffer
static
void
prvCopyItemByteBuf
(
Ringbuffer_t
*
pxRingbuffer
,
const
uint8_t
*
pucItem
,
size_t
xItemSize
)
;
ringbuf.c:129
prvCopyItemByteBuf()
prvCopyItemByteBuf()::pxRingbuffer
static
void
*
prvGetItemDefault
(
Ringbuffer_t
*
pxRingbuffer
,
ringbuf.c:141
prvGetItemDefault()
prvGetItemDefault()::pxRingbuffer
static
void
*
prvGetItemByteBuf
(
Ringbuffer_t
*
pxRingbuffer
,
ringbuf.c:147
prvGetItemByteBuf()
prvGetItemByteBuf()::pxRingbuffer
static
void
prvReturnItemDefault
(
Ringbuffer_t
*
pxRingbuffer
,
uint8_t
*
pucItem
)
;
ringbuf.c:158
prvReturnItemDefault()
prvReturnItemDefault()::pxRingbuffer
static
void
prvReturnItemByteBuf
(
Ringbuffer_t
*
pxRingbuffer
,
uint8_t
*
pucItem
)
;
ringbuf.c:161
prvReturnItemByteBuf()
prvReturnItemByteBuf()::pxRingbuffer
static
size_t
prvGetCurMaxSizeNoSplit
(
Ringbuffer_t
*
pxRingbuffer
)
;
ringbuf.c:164
prvGetCurMaxSizeNoSplit()
prvGetCurMaxSizeNoSplit()::pxRingbuffer
static
size_t
prvGetCurMaxSizeAllowSplit
(
Ringbuffer_t
*
pxRingbuffer
)
;
ringbuf.c:167
prvGetCurMaxSizeAllowSplit()
prvGetCurMaxSizeAllowSplit()::pxRingbuffer
static
size_t
prvGetCurMaxSizeByteBuf
(
Ringbuffer_t
*
pxRingbuffer
)
;
ringbuf.c:170
prvGetCurMaxSizeByteBuf()
prvGetCurMaxSizeByteBuf()::pxRingbuffer
static
BaseType_t
prvSendAcquireGeneric
(
Ringbuffer_t
*
pxRingbuffer
,
ringbuf.c:177
prvSendAcquireGeneric()
prvSendAcquireGeneric()::pxRingbuffer
static
BaseType_t
prvReceiveGeneric
(
Ringbuffer_t
*
pxRingbuffer
,
ringbuf.c:189
prvReceiveGeneric()
prvReceiveGeneric()::pxRingbuffer
static
BaseType_t
prvReceiveGenericFromISR
(
Ringbuffer_t
*
pxRingbuffer
,
ringbuf.c:198
prvReceiveGenericFromISR()
prvReceiveGenericFromISR()::pxRingbuffer
Ringbuffer_t
*
pxNewRingbuffer
,
ringbuf.c:209
prvInitializeNewRingbuffer()
prvInitializeNewRingbuffer()::pxNewRingbuffer
static
size_t
prvGetFreeSize
(
Ringbuffer_t
*
pxRingbuffer
)
ringbuf.c:262
prvGetFreeSize()
prvGetFreeSize()::pxRingbuffer
static
BaseType_t
prvCheckItemFitsDefault
(
Ringbuffer_t
*
pxRingbuffer
,
size_t
xItemSize
)
ringbuf.c:279
prvCheckItemFitsDefault()
prvCheckItemFitsDefault()::pxRingbuffer
static
BaseType_t
prvCheckItemFitsByteBuffer
(
Ringbuffer_t
*
pxRingbuffer
,
size_t
xItemSize
)
ringbuf.c:307
prvCheckItemFitsByteBuffer()
prvCheckItemFitsByteBuffer()::pxRingbuffer
static
uint8_t
*
prvAcquireItemNoSplit
(
Ringbuffer_t
*
pxRingbuffer
,
size_t
xItemSize
)
ringbuf.c:324
prvAcquireItemNoSplit()
prvAcquireItemNoSplit()::pxRingbuffer
static
void
prvSendItemDoneNoSplit
(
Ringbuffer_t
*
pxRingbuffer
,
uint8_t
*
pucItem
)
ringbuf.c:363
prvSendItemDoneNoSplit()
prvSendItemDoneNoSplit()::pxRingbuffer
static
void
prvCopyItemNoSplit
(
Ringbuffer_t
*
pxRingbuffer
,
const
uint8_t
*
pucItem
,
size_t
xItemSize
)
ringbuf.c:414
prvCopyItemNoSplit()
prvCopyItemNoSplit()::pxRingbuffer
static
void
prvCopyItemAllowSplit
(
Ringbuffer_t
*
pxRingbuffer
,
const
uint8_t
*
pucItem
,
size_t
xItemSize
)
ringbuf.c:421
prvCopyItemAllowSplit()
prvCopyItemAllowSplit()::pxRingbuffer
static
void
prvCopyItemByteBuf
(
Ringbuffer_t
*
pxRingbuffer
,
const
uint8_t
*
pucItem
,
size_t
xItemSize
)
ringbuf.c:476
prvCopyItemByteBuf()
prvCopyItemByteBuf()::pxRingbuffer
static
BaseType_t
prvCheckItemAvail
(
Ringbuffer_t
*
pxRingbuffer
)
ringbuf.c:509
prvCheckItemAvail()
prvCheckItemAvail()::pxRingbuffer
static
void
*
prvGetItemDefault
(
Ringbuffer_t
*
pxRingbuffer
,
ringbuf.c:528
prvGetItemDefault()
prvGetItemDefault()::pxRingbuffer
static
void
*
prvGetItemByteBuf
(
Ringbuffer_t
*
pxRingbuffer
,
ringbuf.c:569
prvGetItemByteBuf()
prvGetItemByteBuf()::pxRingbuffer
static
void
prvReturnItemDefault
(
Ringbuffer_t
*
pxRingbuffer
,
uint8_t
*
pucItem
)
ringbuf.c:610
prvReturnItemDefault()
prvReturnItemDefault()::pxRingbuffer
static
void
prvReturnItemByteBuf
(
Ringbuffer_t
*
pxRingbuffer
,
uint8_t
*
pucItem
)
ringbuf.c:662
prvReturnItemByteBuf()
prvReturnItemByteBuf()::pxRingbuffer
static
size_t
prvGetCurMaxSizeNoSplit
(
Ringbuffer_t
*
pxRingbuffer
)
ringbuf.c:675
prvGetCurMaxSizeNoSplit()
prvGetCurMaxSizeNoSplit()::pxRingbuffer
static
size_t
prvGetCurMaxSizeAllowSplit
(
Ringbuffer_t
*
pxRingbuffer
)
ringbuf.c:708
prvGetCurMaxSizeAllowSplit()
prvGetCurMaxSizeAllowSplit()::pxRingbuffer
static
size_t
prvGetCurMaxSizeByteBuf
(
Ringbuffer_t
*
pxRingbuffer
)
ringbuf.c:739
prvGetCurMaxSizeByteBuf()
prvGetCurMaxSizeByteBuf()::pxRingbuffer
static
BaseType_t
prvSendAcquireGeneric
(
Ringbuffer_t
*
pxRingbuffer
,
ringbuf.c:758
prvSendAcquireGeneric()
prvSendAcquireGeneric()::pxRingbuffer
static
BaseType_t
prvReceiveGeneric
(
Ringbuffer_t
*
pxRingbuffer
,
ringbuf.c:825
prvReceiveGeneric()
prvReceiveGeneric()::pxRingbuffer
static
BaseType_t
prvReceiveGenericFromISR
(
Ringbuffer_t
*
pxRingbuffer
,
ringbuf.c:891
prvReceiveGenericFromISR()
prvReceiveGenericFromISR()::pxRingbuffer
Ringbuffer_t
*
pxNewRingbuffer
=
calloc
(
1
,
sizeof
(
Ringbuffer_t
)
)
;
ringbuf.c:943
xRingbufferCreate()
free
(
pxNewRingbuffer
)
;
ringbuf.c:954
xRingbufferCreate()
Ringbuffer_t
*
pxNewRingbuffer
=
(
Ringbuffer_t
*
)
pxStaticRingbuffer
;
ringbuf.c:978
xRingbufferCreateStatic()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:986
xRingbufferSendAcquire()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1003
xRingbufferSendComplete()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1038
xRingbufferSend()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1058
xRingbufferSendFromISR()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1103
xRingbufferReceive()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1119
xRingbufferReceiveFromISR()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1140
xRingbufferReceiveSplit()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1155
xRingbufferReceiveSplitFromISR()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1169
xRingbufferReceiveUpTo()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1189
xRingbufferReceiveUpToFromISR()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1209
vRingbufferReturnItem()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1227
vRingbufferReturnItemFromISR()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1247
vRingbufferDelete()
free
(
pxRingbuffer
)
;
ringbuf.c:1253
vRingbufferDelete()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1259
xRingbufferGetMaxItemSize()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1266
xRingbufferGetCurFreeSize()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1278
xRingbufferAddToQueueSetRead()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1302
xRingbufferRemoveFromQueueSetRead()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1331
vRingbufferGetInfo()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1355
xRingbufferPrintInfo()
Ringbuffer_t
*
pxRingbuffer
=
(
Ringbuffer_t
*
)
xRingbuffer
;
ringbuf.c:1367
xRingbufferGetStaticBuffer()
Call Tree
from
examples
All items filtered out
All items filtered out
Data Use
from
examples
All items filtered out
All items filtered out
Class Tree
from
examples
All items filtered out
All items filtered out
Override Tree
from
examples
All items filtered out
All items filtered out
Implementations
from
examples
All items filtered out
All items filtered out
Instances
from
examples
Instance
Scope
Location
Project
prvInitializeNewRingbuffer()::pxNewRingbuffer
prvInitializeNewRingbuffer()
ringbuf.c:91
prvGetFreeSize()::pxRingbuffer
prvGetFreeSize()
ringbuf.c:95
prvCheckItemAvail()::pxRingbuffer
prvCheckItemAvail()
ringbuf.c:98
prvCheckItemFitsDefault()::pxRingbuffer
prvCheckItemFitsDefault()
ringbuf.c:101
prvCheckItemFitsByteBuffer()::pxRingbuffer
prvCheckItemFitsByteBuffer()
ringbuf.c:104
prvCopyItemNoSplit()::pxRingbuffer
prvCopyItemNoSplit()
ringbuf.c:115
prvCopyItemAllowSplit()::pxRingbuffer
prvCopyItemAllowSplit()
ringbuf.c:126
prvCopyItemByteBuf()::pxRingbuffer
prvCopyItemByteBuf()
ringbuf.c:129
prvGetItemDefault()::pxRingbuffer
prvGetItemDefault()
ringbuf.c:141
prvGetItemByteBuf()::pxRingbuffer
prvGetItemByteBuf()
ringbuf.c:147
prvReturnItemDefault()::pxRingbuffer
prvReturnItemDefault()
ringbuf.c:158
prvReturnItemByteBuf()::pxRingbuffer
prvReturnItemByteBuf()
ringbuf.c:161
prvGetCurMaxSizeNoSplit()::pxRingbuffer
prvGetCurMaxSizeNoSplit()
ringbuf.c:164
prvGetCurMaxSizeAllowSplit()::pxRingbuffer
prvGetCurMaxSizeAllowSplit()
ringbuf.c:167
prvGetCurMaxSizeByteBuf()::pxRingbuffer
prvGetCurMaxSizeByteBuf()
ringbuf.c:170
prvSendAcquireGeneric()::pxRingbuffer
prvSendAcquireGeneric()
ringbuf.c:177
prvReceiveGeneric()::pxRingbuffer
prvReceiveGeneric()
ringbuf.c:189
prvReceiveGenericFromISR()::pxRingbuffer
prvReceiveGenericFromISR()
ringbuf.c:198
prvInitializeNewRingbuffer()::pxNewRingbuffer
prvInitializeNewRingbuffer()
ringbuf.c:209
prvGetFreeSize()::pxRingbuffer
prvGetFreeSize()
ringbuf.c:262
prvCheckItemFitsDefault()::pxRingbuffer
prvCheckItemFitsDefault()
ringbuf.c:279
prvCheckItemFitsByteBuffer()::pxRingbuffer
prvCheckItemFitsByteBuffer()
ringbuf.c:307
prvAcquireItemNoSplit()::pxRingbuffer
prvAcquireItemNoSplit()
ringbuf.c:324
prvSendItemDoneNoSplit()::pxRingbuffer
prvSendItemDoneNoSplit()
ringbuf.c:363
prvCopyItemNoSplit()::pxRingbuffer
prvCopyItemNoSplit()
ringbuf.c:414
prvCopyItemAllowSplit()::pxRingbuffer
prvCopyItemAllowSplit()
ringbuf.c:421
prvCopyItemByteBuf()::pxRingbuffer
prvCopyItemByteBuf()
ringbuf.c:476
prvCheckItemAvail()::pxRingbuffer
prvCheckItemAvail()
ringbuf.c:509
prvGetItemDefault()::pxRingbuffer
prvGetItemDefault()
ringbuf.c:528
prvGetItemByteBuf()::pxRingbuffer
prvGetItemByteBuf()
ringbuf.c:569
prvReturnItemDefault()::pxRingbuffer
prvReturnItemDefault()
ringbuf.c:610
prvReturnItemByteBuf()::pxRingbuffer
prvReturnItemByteBuf()
ringbuf.c:662
prvGetCurMaxSizeNoSplit()::pxRingbuffer
prvGetCurMaxSizeNoSplit()
ringbuf.c:675
prvGetCurMaxSizeAllowSplit()::pxRingbuffer
prvGetCurMaxSizeAllowSplit()
ringbuf.c:708
prvGetCurMaxSizeByteBuf()::pxRingbuffer
prvGetCurMaxSizeByteBuf()
ringbuf.c:739
prvSendAcquireGeneric()::pxRingbuffer
prvSendAcquireGeneric()
ringbuf.c:758
prvReceiveGeneric()::pxRingbuffer
prvReceiveGeneric()
ringbuf.c:825
prvReceiveGenericFromISR()::pxRingbuffer
prvReceiveGenericFromISR()
ringbuf.c:891
Lifecycle
from
examples
RingbufferDefinition
is allocated by 1 symbol and is freed by 2 symbols:
xRingbufferCreate()
All items filtered out
RingbufferDefinition
xRingbufferCreate()
vRingbufferDelete()
All items filtered out