core/cds/inc/cds_packet.h

/*
 * Copyright (c) 2014-2015 The Linux Foundation. All rights reserved.
 *
 * Previously licensed under the ISC license by Qualcomm Atheros, Inc.
 *
 *
 * Permission to use, copy, modify, and/or distribute this software for
 * any purpose with or without fee is hereby granted, provided that the
 * above copyright notice and this permission notice appear in all
 * copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
 * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
 * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
 * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */

/*
 * This file was originally distributed by Qualcomm Atheros, Inc.
 * under proprietary terms before Copyright ownership was assigned
 * to the Linux Foundation.
 */

#if !defined( __CDS_PKT_H )
#define __CDS_PKT_H

/**=========================================================================

   \file        cds_packet.h

   \brief       Connectivity driver services (CDS) network Packet APIs

   Network Protocol packet/buffer support interfaces

   ========================================================================*/

/*--------------------------------------------------------------------------
   Include Files
   ------------------------------------------------------------------------*/
#include <cdf_types.h>
#include <cdf_status.h>

/*--------------------------------------------------------------------------
   Preprocessor definitions and constants
   ------------------------------------------------------------------------*/

/*--------------------------------------------------------------------------
   Type declarations
   ------------------------------------------------------------------------*/
struct cds_pkt_t;
typedef struct cds_pkt_t cds_pkt_t;

#include "cdf_nbuf.h"

#define CDS_PKT_TRAC_TYPE_EAPOL   NBUF_PKT_TRAC_TYPE_EAPOL
#define CDS_PKT_TRAC_TYPE_DHCP    NBUF_PKT_TRAC_TYPE_DHCP
#define CDS_PKT_TRAC_TYPE_MGMT_ACTION    NBUF_PKT_TRAC_TYPE_MGMT_ACTION /* Managment action frame */

#define CDS_PKT_TRAC_DUMP_CMD     9999

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

* brief cds_pkt_get_proto_type() -
      Find protoco type from packet contents

* skb Packet Pointer
* tracking_map packet type want to track
* dot11_type, frame type when the frame is in dot11 format

   ---------------------------------------------------------------------------*/
uint8_t cds_pkt_get_proto_type
	(struct sk_buff *skb, uint8_t tracking_map, uint8_t dot11_type);

#ifdef QCA_PKT_PROTO_TRACE
/*---------------------------------------------------------------------------

* brief cds_pkt_trace_buf_update() -
      Update storage buffer with interest event string

* event_string Event String may packet type or outstanding event

   ---------------------------------------------------------------------------*/
void cds_pkt_trace_buf_update(char *event_string);

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

* brief cds_pkt_trace_buf_dump() -
      Dump stored information into kernel log

   ---------------------------------------------------------------------------*/
void cds_pkt_trace_buf_dump(void);

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

* brief cds_pkt_proto_trace_init() -
      Initialize protocol trace functionality, allocate required resource

   ---------------------------------------------------------------------------*/
void cds_pkt_proto_trace_init(void);

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

* brief cds_pkt_proto_trace_close() -
      Free required resource

   ---------------------------------------------------------------------------*/
void cds_pkt_proto_trace_close(void);
#endif /* QCA_PKT_PROTO_TRACE */

/**
 * cds_pkt_return_packet  Free the cds Packet
 * @ cds Packet
 */
CDF_STATUS cds_pkt_return_packet(cds_pkt_t *packet);

/**
 * cds_pkt_get_packet_length  Returns the packet length
 * @ cds Packet
 */
CDF_STATUS cds_pkt_get_packet_length(cds_pkt_t *pPacket,
				     uint16_t *pPacketSize);

/*
 * TODO: Remove later
 * All the below difinitions are not
 * required for Host Driver 2.0
 * once corresponding references are removed
 * from HDD and other layers
 * below code will be removed
 */
/* The size of AMSDU frame per spec can be a max of 3839 bytes
   in BD/PDUs that means 30 (one BD = 128 bytes)
   we must add the size of the 802.11 header to that */
#define CDS_PKT_SIZE_BUFFER  ((30 * 128) + 32)

/* cds Packet Types */
typedef enum {
	/* cds Packet is used to transmit 802.11 Management frames. */
	CDS_PKT_TYPE_TX_802_11_MGMT,

	/* cds Packet is used to transmit 802.11 Data frames. */
	CDS_PKT_TYPE_TX_802_11_DATA,

	/* cds Packet is used to transmit 802.3 Data frames. */
	CDS_PKT_TYPE_TX_802_3_DATA,

	/* cds Packet contains Received data of an unknown frame type */
	CDS_PKT_TYPE_RX_RAW,

	/* Invalid sentinel value */
	CDS_PKT_TYPE_MAXIMUM
} CDS_PKT_TYPE;

/* user IDs.   These IDs are needed on the cds_pkt_get/set_user_data_ptr()
   to identify the user area in the cds Packet. */
typedef enum {
	CDS_PKT_USER_DATA_ID_TL = 0,
	CDS_PKT_USER_DATA_ID_BAL,
	CDS_PKT_USER_DATA_ID_WMA,
	CDS_PKT_USER_DATA_ID_HDD,
	CDS_PKT_USER_DATA_ID_BSL,

	CDS_PKT_USER_DATA_ID_MAX
} CDS_PKT_USER_DATA_ID;

#ifdef MEMORY_DEBUG
#define cds_packet_alloc(s, d, p)	\
	cds_packet_alloc_debug(s, d, p, __FILE__, __LINE__)

CDF_STATUS cds_packet_alloc_debug(uint16_t size, void **data, void **ppPacket,
				  uint8_t *file_name, uint32_t line_num);
#else
CDF_STATUS cds_packet_alloc(uint16_t size, void **data, void **ppPacket);
#endif

void cds_packet_free(void *pPacket);

typedef CDF_STATUS (*cds_pkt_get_packet_callback)(cds_pkt_t *pPacket,
						  void *userData);

#endif /* !defined( __CDS_PKT_H ) */