Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
udc_buf.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2024 Nordic Semiconductor ASA
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12#ifndef ZEPHYR_INCLUDE_UDC_BUF_H
13#define ZEPHYR_INCLUDE_UDC_BUF_H
14
15#include <zephyr/kernel.h>
16#include <zephyr/net_buf.h>
17
18#if defined(CONFIG_DCACHE) && !defined(CONFIG_UDC_BUF_FORCE_NOCACHE)
19/*
20 * Here we try to get DMA-safe buffers, but we lack a consistent source of
21 * information about data cache properties, such as line cache size, and a
22 * consistent source of information about what part of memory is DMA'able.
23 * For now, we simply assume that all available memory is DMA'able and use
24 * Kconfig option DCACHE_LINE_SIZE for alignment and granularity.
25 */
26#define Z_UDC_BUF_ALIGN CONFIG_DCACHE_LINE_SIZE
27#define Z_UDC_BUF_GRANULARITY CONFIG_DCACHE_LINE_SIZE
28#else
29/*
30 * Default alignment and granularity to pointer size if the platform does not
31 * have a data cache or buffers are placed in nocache memory region.
32 */
33#define Z_UDC_BUF_ALIGN sizeof(void *)
34#define Z_UDC_BUF_GRANULARITY sizeof(void *)
35#endif
36
47#define UDC_BUF_ALIGN Z_UDC_BUF_ALIGN
48
50#define UDC_BUF_GRANULARITY Z_UDC_BUF_GRANULARITY
51
61#define UDC_STATIC_BUF_DEFINE(name, size) \
62 static uint8_t __aligned(UDC_BUF_ALIGN) name[ROUND_UP(size, UDC_BUF_GRANULARITY)];
63
71#define IS_UDC_ALIGNED(buf) IS_ALIGNED(buf, UDC_BUF_ALIGN)
72
76#define UDC_HEAP_DEFINE(name, bytes, in_section) \
77 uint8_t in_section __aligned(UDC_BUF_ALIGN) \
78 kheap_##name[MAX(bytes, Z_HEAP_MIN_SIZE)]; \
79 STRUCT_SECTION_ITERABLE(k_heap, name) = { \
80 .heap = { \
81 .init_mem = kheap_##name, \
82 .init_bytes = MAX(bytes, Z_HEAP_MIN_SIZE), \
83 }, \
84 }
85
86#define UDC_K_HEAP_DEFINE(name, size) \
87 COND_CODE_1(CONFIG_UDC_BUF_FORCE_NOCACHE, \
88 (UDC_HEAP_DEFINE(name, size, __nocache)), \
89 (UDC_HEAP_DEFINE(name, size, __noinit)))
90
91extern const struct net_buf_data_cb net_buf_dma_cb;
108#define UDC_BUF_POOL_VAR_DEFINE(pname, count, size, ud_size, fdestroy) \
109 _NET_BUF_ARRAY_DEFINE(pname, count, ud_size); \
110 UDC_K_HEAP_DEFINE(net_buf_mem_pool_##pname, size); \
111 static const struct net_buf_data_alloc net_buf_data_alloc_##pname = { \
112 .cb = &net_buf_dma_cb, \
113 .alloc_data = &net_buf_mem_pool_##pname, \
114 .max_alloc_size = 0, \
115 }; \
116 static STRUCT_SECTION_ITERABLE(net_buf_pool, pname) = \
117 NET_BUF_POOL_INITIALIZER(pname, &net_buf_data_alloc_##pname, \
118 _net_buf_##pname, count, ud_size, \
119 fdestroy)
120
135#define UDC_BUF_POOL_DEFINE(pname, count, size, ud_size, fdestroy) \
136 _NET_BUF_ARRAY_DEFINE(pname, count, ud_size); \
137 BUILD_ASSERT((UDC_BUF_GRANULARITY) % (UDC_BUF_ALIGN) == 0, \
138 "Code assumes granurality is multiple of alignment"); \
139 static uint8_t __nocache __aligned(UDC_BUF_ALIGN) \
140 net_buf_data_##pname[count][ROUND_UP(size, UDC_BUF_GRANULARITY)];\
141 static const struct net_buf_pool_fixed net_buf_fixed_##pname = { \
142 .data_pool = (uint8_t *)net_buf_data_##pname, \
143 }; \
144 static const struct net_buf_data_alloc net_buf_fixed_alloc_##pname = { \
145 .cb = &net_buf_fixed_cb, \
146 .alloc_data = (void *)&net_buf_fixed_##pname, \
147 .max_alloc_size = ROUND_UP(size, UDC_BUF_GRANULARITY), \
148 }; \
149 static STRUCT_SECTION_ITERABLE(net_buf_pool, pname) = \
150 NET_BUF_POOL_INITIALIZER(pname, &net_buf_fixed_alloc_##pname, \
151 _net_buf_##pname, count, ud_size, \
152 fdestroy)
153
158#endif /* ZEPHYR_INCLUDE_UDC_BUF_H */
kernel.h
Public kernel APIs.
net_buf.h
Buffer management.