m2mb_netbuf.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
/* Global declarations ==========================================================================*/
#ifndef M2MB_NETBUF_H
#define M2MB_NETBUF_H

#include "stdint.h"
/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/

#define M2MB_NETBUF_MAX_QUEUE_NAME   6

#define M2MB_NETBUF_MAX_QUEUES       3

typedef struct M2MB_NET_BUF
{
   VOID *reserved;         
   struct M2MB_NET_BUF *pk_Prev;  
   struct M2MB_NET_BUF *pk_Next;  
   char     *nb_Buff;      
   UINT32 nb_Blen;       
   char     *nb_Prot;      
   UINT32 nb_Tlen;       
   UINT32 nb_Plen;       
} M2MB_NET_BUF_T;

typedef M2MB_NET_BUF_T *PACKET;


typedef struct m2mb_Net_Buf_Queue_s
{
   char name[M2MB_NETBUF_MAX_QUEUE_NAME];     
   uint8_t total_Buffers;                     
   uint8_t free_Buffers;                      
} m2mb_Net_Buf_Queue_t;

typedef struct m2mb_Net_Buf_Queue_Status_s
{ 
   m2mb_Net_Buf_Queue_t queue[M2MB_NETBUF_MAX_QUEUES];  
   uint16_t total_Free_Buffers;                         
} m2mb_Net_Buf_Queue_Status_t; 

#define M2MB_NETBUF_UDP_HEADROOM    (52)

#define M2MB_NETBUF_TCP_HEADROOM    (64)

#define M2MB_NETBUF_UDP6_HEADROOM   (72)

#define M2MB_NETBUF_TCP6_HEADROOM   (88)

/* For a non-chained netbuf, we can use the following MACROs to update the netbuf */

#define M2MB_NET_BUF_UPDATE_START(pkt, p) \
        (p) = ((M2MB_NET_BUF_T *)(pkt))->nb_Prot

#define M2MB_NET_BUF_UPDATE_INT32(p, val) \
        *(UINT32 *)(p) = (UINT32)(val); (p) += sizeof(UINT32)

#define M2MB_NET_BUF_UPDATE_INT16(p, val) \
        *(uint16_t *)(p) = (uint16_t)(val); (p) += sizeof(uint16_t)

#define M2MB_NET_BUF_UPDATE_INT8(p, val) \
        *(uint8_t *)(p) = (uint8_t)(val); (p) += sizeof(uint8_t)

#define M2MB_NET_BUF_UPDATE_DATA(p, data, len) \
        memcpy((p), (data), (len)); (p) += (len)

#define M2MB_NET_BUF_UPDATE_END(pkt, len) \
        ((M2MB_NET_BUF_T *)(pkt))->nb_Plen = \
    ((M2MB_NET_BUF_T *)(pkt))->nb_Tlen = (len)

/* Definitions used for id in calls to m2mb_Net_Buf_Alloc() and m2mb_Net_Buf_Free() */

#define M2MB_NETBUF_APP     0x0

#define M2MB_NETBUF_SYS     0x1

#define M2MB_NETBUF_SYS_CONTIG    (0x4 | M2MB_NETBUF_SYS)

#define M2MB_NETBUF_SSL     0x2


void *m2mb_Net_Buf_Alloc(UINT32 size, UINT32 id);

INT32 m2mb_Net_Buf_Free(void *buf, UINT32 id);

INT32 m2mb_Net_Buf_Update(void *netbuf, UINT32 offset, void *srcbuf, UINT32 len, UINT32 id);

M2MB_STATUS_T m2mb_Net_Buf_Free_Queue_Status(m2mb_Net_Buf_Queue_Status_t *arg);

/*-----------------------------------------------------------------------------------------------*/

#endif  /*M2MB_NETBUF_H*/