1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2014-2016, 2018, 2020 The Linux Foundation. All rights reserved. 3*5113495bSYour Name * Copyright (c) 2022-2023 Qualcomm Innovation Center, Inc. All rights reserved. 4*5113495bSYour Name * 5*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for 6*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the 7*5113495bSYour Name * above copyright notice and this permission notice appear in all 8*5113495bSYour Name * copies. 9*5113495bSYour Name * 10*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 11*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 12*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 13*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 14*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 15*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 16*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 17*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE. 18*5113495bSYour Name */ 19*5113495bSYour Name 20*5113495bSYour Name #if !defined(__CDS_PKT_H) 21*5113495bSYour Name #define __CDS_PKT_H 22*5113495bSYour Name 23*5113495bSYour Name /** 24*5113495bSYour Name * DOC: cds_packet.h 25*5113495bSYour Name * Connectivity driver services (CDS) network Packet APIs 26*5113495bSYour Name * Network Protocol packet/buffer support interfaces 27*5113495bSYour Name */ 28*5113495bSYour Name 29*5113495bSYour Name #include <qdf_types.h> 30*5113495bSYour Name #include <qdf_status.h> 31*5113495bSYour Name 32*5113495bSYour Name /*-------------------------------------------------------------------------- 33*5113495bSYour Name Preprocessor definitions and constants 34*5113495bSYour Name ------------------------------------------------------------------------*/ 35*5113495bSYour Name 36*5113495bSYour Name /*-------------------------------------------------------------------------- 37*5113495bSYour Name Type declarations 38*5113495bSYour Name ------------------------------------------------------------------------*/ 39*5113495bSYour Name struct cds_pkt_t; 40*5113495bSYour Name typedef struct cds_pkt_t cds_pkt_t; 41*5113495bSYour Name 42*5113495bSYour Name #include "qdf_nbuf.h" 43*5113495bSYour Name 44*5113495bSYour Name /** 45*5113495bSYour Name * cds_pkt_return_packet() - Free the cds Packet 46*5113495bSYour Name * @packet: cds Packet 47*5113495bSYour Name * 48*5113495bSYour Name * Return: QDF_STATUS 49*5113495bSYour Name */ 50*5113495bSYour Name QDF_STATUS cds_pkt_return_packet(cds_pkt_t *packet); 51*5113495bSYour Name 52*5113495bSYour Name /** 53*5113495bSYour Name * cds_pkt_get_packet_length() - Get packet length for a cds Packet 54*5113495bSYour Name * @pPacket: the cds Packet to get the packet length from 55*5113495bSYour Name * @pPacketSize: location to return the total size of the data 56*5113495bSYour Name * contained in the cds Packet. 57*5113495bSYour Name * 58*5113495bSYour Name * Return: QDF_STATUS_SUCCESS if the length was returned, otherwise an 59*5113495bSYour Name * appropriate QDF_STATUS_E_* status code. 60*5113495bSYour Name */ 61*5113495bSYour Name QDF_STATUS cds_pkt_get_packet_length(cds_pkt_t *pPacket, 62*5113495bSYour Name uint16_t *pPacketSize); 63*5113495bSYour Name 64*5113495bSYour Name /* 65*5113495bSYour Name * TODO: Remove later 66*5113495bSYour Name * All the below definitions are not 67*5113495bSYour Name * required for Host Driver 2.0 68*5113495bSYour Name * once corresponding references are removed 69*5113495bSYour Name * from HDD and other layers 70*5113495bSYour Name * below code will be removed 71*5113495bSYour Name */ 72*5113495bSYour Name 73*5113495bSYour Name /** 74*5113495bSYour Name * cds_packet_alloc() - Allocate a network buffer for TX 75*5113495bSYour Name * @size: size of the packet 76*5113495bSYour Name * @data: packet payload 77*5113495bSYour Name * @ppPacket: pointer to return allocated packet 78*5113495bSYour Name * 79*5113495bSYour Name * Allocates a packet of the indicated @size, populates it with the 80*5113495bSYour Name * @data payload, and returns the pointer via @ppPacket. Caller is 81*5113495bSYour Name * responsible for calling cds_packet_free() after the packet has been 82*5113495bSYour Name * sent to reclaim the packet. 83*5113495bSYour Name * 84*5113495bSYour Name * Return: QDF_STATUS_SUCCESS if a packet is allocated, otherwise a 85*5113495bSYour Name * appropriate QDF_STATUS_E_* status code. 86*5113495bSYour Name */ 87*5113495bSYour Name #ifdef MEMORY_DEBUG 88*5113495bSYour Name #define cds_packet_alloc(size, data, ppPacket) \ 89*5113495bSYour Name cds_packet_alloc_debug(size, data, ppPacket, __func__, __LINE__) 90*5113495bSYour Name 91*5113495bSYour Name QDF_STATUS cds_packet_alloc_debug(uint16_t size, void **data, void **ppPacket, 92*5113495bSYour Name const char *func_name, uint32_t line_num); 93*5113495bSYour Name #else 94*5113495bSYour Name QDF_STATUS cds_packet_alloc(uint16_t size, void **data, void **ppPacket); 95*5113495bSYour Name #endif 96*5113495bSYour Name 97*5113495bSYour Name /** 98*5113495bSYour Name * cds_packet_free() - Free input network buffer 99*5113495bSYour Name * @pPacket: network buffer 100*5113495bSYour Name */ 101*5113495bSYour Name void cds_packet_free(void *pPacket); 102*5113495bSYour Name 103*5113495bSYour Name #endif /* !defined( __CDS_PKT_H ) */ 104