Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
spsc_pbuf.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
7#ifndef ZEPHYR_INCLUDE_SYS_SPSC_PBUF_H_
8#define ZEPHYR_INCLUDE_SYS_SPSC_PBUF_H_
9
10#include <zephyr/cache.h>
11#include <zephyr/devicetree.h>
12
13#ifdef __cplusplus
14extern "C" {
15#endif
16
29#define SPSC_PBUF_CACHE BIT(0)
30
32#define SPSC_PBUF_UTILIZATION_BITS 24
33
35#define SPSC_PBUF_UTILIZATION_OFFSET 8
36
39#if CONFIG_DCACHE_LINE_SIZE != 0
40#define Z_SPSC_PBUF_LOCAL_DCACHE_LINE CONFIG_DCACHE_LINE_SIZE
41#else
42#define Z_SPSC_PBUF_LOCAL_DCACHE_LINE DT_PROP_OR(CPU, d_cache_line_size, 0)
43#endif
44
45#ifndef CONFIG_SPSC_PBUF_REMOTE_DCACHE_LINE
46#define CONFIG_SPSC_PBUF_REMOTE_DCACHE_LINE 0
47#endif
48
49#define Z_SPSC_PBUF_DCACHE_LINE \
50 MAX(CONFIG_SPSC_PBUF_REMOTE_DCACHE_LINE, Z_SPSC_PBUF_LOCAL_DCACHE_LINE)
51
53#define SPSC_PBUF_MAX_LEN 0xFF00
54
63 uint32_t len; /* Length of data[] in bytes. */
64 uint32_t flags; /* Flags. See @ref SPSC_PBUF_FLAGS */
65 uint32_t rd_idx; /* Index of the first valid byte in data[] */
66};
67
68/* Padding to fill cache line. */
69#define Z_SPSC_PBUF_PADDING \
70 MAX(0, Z_SPSC_PBUF_DCACHE_LINE - (int)sizeof(struct spsc_pbuf_common))
71
78 uint8_t reserved[Z_SPSC_PBUF_PADDING];
79 uint32_t wr_idx; /* Index of the first free byte in data[] */
80 uint8_t data[]; /* Buffer data. */
81};
82
85 uint32_t wr_idx; /* Index of the first free byte in data[] */
86 uint8_t data[]; /* Buffer data. */
87};
88
101struct spsc_pbuf {
103 union {
105 struct spsc_pbuf_ext_nocache nocache;
107};
108
119static inline uint32_t spsc_pbuf_capacity(struct spsc_pbuf *pb)
120{
121 return pb->common.len - sizeof(uint32_t);
122}
123
143struct spsc_pbuf *spsc_pbuf_init(void *buf, size_t blen, uint32_t flags);
144
158int spsc_pbuf_write(struct spsc_pbuf *pb, const char *buf, uint16_t len);
159
188int spsc_pbuf_alloc(struct spsc_pbuf *pb, uint16_t len, char **buf);
189
199void spsc_pbuf_commit(struct spsc_pbuf *pb, uint16_t len);
200
218int spsc_pbuf_read(struct spsc_pbuf *pb, char *buf, uint16_t len);
219
237uint16_t spsc_pbuf_claim(struct spsc_pbuf *pb, char **buf);
238
247void spsc_pbuf_free(struct spsc_pbuf *pb, uint16_t len);
248
265#ifdef __cplusplus
266}
267#endif
268
269#endif /* ZEPHYR_INCLUDE_SYS_SPSC_PBUF_H_ */
cache API interface
Devicetree main header.
static uint32_t spsc_pbuf_capacity(struct spsc_pbuf *pb)
Get buffer capacity.
Definition: spsc_pbuf.h:119
int spsc_pbuf_read(struct spsc_pbuf *pb, char *buf, uint16_t len)
Read specified amount of data from the packet buffer.
void spsc_pbuf_free(struct spsc_pbuf *pb, uint16_t len)
Free the packet to the buffer.
int spsc_pbuf_alloc(struct spsc_pbuf *pb, uint16_t len, char **buf)
Allocate space in the packet buffer.
int spsc_pbuf_write(struct spsc_pbuf *pb, const char *buf, uint16_t len)
Write specified amount of data to the packet buffer.
void spsc_pbuf_commit(struct spsc_pbuf *pb, uint16_t len)
Commit packet to the buffer.
uint16_t spsc_pbuf_claim(struct spsc_pbuf *pb, char **buf)
Claim packet from the buffer.
struct spsc_pbuf * spsc_pbuf_init(void *buf, size_t blen, uint32_t flags)
Initialize the packet buffer.
int spsc_pbuf_get_utilization(struct spsc_pbuf *pb)
Get maximum utilization of the packet buffer.
flags
Definition: parser.h:96
__UINT32_TYPE__ uint32_t
Definition: stdint.h:90
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINT16_TYPE__ uint16_t
Definition: stdint.h:89
First part of packet buffer control block.
Definition: spsc_pbuf.h:62
uint32_t len
Definition: spsc_pbuf.h:63
uint32_t flags
Definition: spsc_pbuf.h:64
uint32_t rd_idx
Definition: spsc_pbuf.h:65
Remaining part of a packet buffer when cache is used.
Definition: spsc_pbuf.h:77
uint32_t wr_idx
Definition: spsc_pbuf.h:79
uint8_t data[]
Definition: spsc_pbuf.h:80
uint8_t reserved[MAX(0, MAX(0, DT_PROP_OR(CPU, d_cache_line_size, 0)) -(int) sizeof(struct spsc_pbuf_common))]
Definition: spsc_pbuf.h:78
Remaining part of a packet buffer when cache is not used.
Definition: spsc_pbuf.h:84
uint8_t data[]
Definition: spsc_pbuf.h:86
uint32_t wr_idx
Definition: spsc_pbuf.h:85
Single producer, single consumer packet buffer.
Definition: spsc_pbuf.h:101
struct spsc_pbuf_common common
Definition: spsc_pbuf.h:102
union spsc_pbuf::@394 ext