abc/lwip
1
0
Fork 0
mirror of https://git.savannah.nongnu.org/git/lwip.git synced 2026-08-10 09:33:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Some documentation updates and fixes

Browse Source 
Dedicated Zero-copy RX page
Fix doxygen warnings
This commit is contained in:
Dirk Ziegelmeier
2017-04-27 12:40:16 +02:00
parent 6aac9377ee
commit a09a8e4a06
5 changed files with 54 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
src/core/pbuf.c
View File

@@ -33,48 +33,7 @@
* Therefore, looping through a pbuf of a single packet, has an
* loop end condition (tot_len == p->len), NOT (next == NULL).
*
* Example of custom pbuf usage for zero-copy RX:
@code{.c}
typedef struct my_custom_pbuf
{
struct pbuf_custom p;
void* dma_descriptor;
} my_custom_pbuf_t;
LWIP_MEMPOOL_DECLARE(RX_POOL, 10, sizeof(my_custom_pbuf_t), "Zero-copy RX PBUF pool");
void my_pbuf_free_custom(void* p)
{
my_custom_pbuf_t* my_puf = (my_custom_pbuf_t*)p;
LOCK_INTERRUPTS();
free_rx_dma_descriptor(my_pbuf->dma_descriptor);
LWIP_MEMPOOL_FREE(RX_POOL, my_pbuf);
UNLOCK_INTERRUPTS();
}
void eth_rx_irq()
{
dma_descriptor* dma_desc = get_RX_DMA_descriptor_from_ethernet();
my_custom_pbuf_t* my_pbuf = (my_custom_pbuf_t*)LWIP_MEMPOOL_ALLOC(RX_POOL);
my_pbuf->p.custom_free_function = my_pbuf_free_custom;
my_pbuf->dma_descriptor = dma_desc;
invalidate_cpu_cache(dma_desc->rx_data, dma_desc->rx_length);
struct pbuf* p = pbuf_alloced_custom(PBUF_RAW,
dma_desc->rx_length,
PBUF_REF,
&my_pbuf->p,
dma_desc->rx_data,
dma_desc->max_buffer_size);
if(netif->input(p, netif) != ERR_OK) {
pbuf_free(p);
}
}
@endcode
* Example of custom pbuf usage: @ref zerocopyrx
*/
/*
@@ -1320,12 +1279,12 @@ pbuf_coalesce(struct pbuf *p, pbuf_layer layer)
/**
* @ingroup pbuf
* Allocates a new pbuf of same length (via @pbuf_alloc) and copies the source
* pbuf into this new pbuf (using @pbuf_copy).
* Allocates a new pbuf of same length (via pbuf_alloc()) and copies the source
* pbuf into this new pbuf (using pbuf_copy()).
*
* @param layer pbuf_layer of the new pbuf
* @param type this parameter decides how and where the pbuf should be allocated
* (@see pbuf_alloc)
* (@see pbuf_alloc())
* @param p the source pbuf
*
* @return a new pbuf or NULL if allocation fails