blob: 856e145db6a1a36a89bae1a7b3f4aa009d1e96c4 [file] [log] [blame]
* @file Header file describing the flow rings DHD interfaces.
* Flow rings are transmit traffic (=propagating towards antenna) related entities.
* Provides type definitions and function prototypes used to create, delete and manage flow rings at
* high level.
* Copyright 1999-2016, Broadcom Corporation
* All rights reserved,
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* This software is provided by the copyright holder "as is" and any express or
* implied warranties, including, but not limited to, the implied warranties of
* merchantability and fitness for a particular purpose are disclaimed. In no event
* shall copyright holder be liable for any direct, indirect, incidental, special,
* exemplary, or consequential damages (including, but not limited to, procurement
* of substitute goods or services; loss of use, data, or profits; or business
* interruption) however caused and on any theory of liability, whether in
* contract, strict liability, or tort (including negligence or otherwise) arising
* in any way out of the use of this software, even if advised of the possibility
* of such damage
* <<Broadcom-WL-IPTag/Open:>>
* $Id: dhd_flowring.h 591285 2015-10-07 11:56:29Z $
* Common types *
#ifndef _dhd_flowrings_h_
#define _dhd_flowrings_h_
/* Max pkts held in a flow ring's backup queue */
/* Number of H2D common rings */
/* Pkttag not compatible with PROP_TXSTATUS or WLFC */
typedef struct dhd_pkttag_fr {
uint16 flowid;
uint16 ifid;
int dataoff;
dmaaddr_t physaddr;
uint32 pa_len;
} dhd_pkttag_fr_t;
#define DHD_PKTTAG_SET_FLOWID(tag, flow) ((tag)->flowid = (uint16)(flow))
#define DHD_PKTTAG_SET_IFID(tag, idx) ((tag)->ifid = (uint16)(idx))
#define DHD_PKTTAG_SET_DATAOFF(tag, offset) ((tag)->dataoff = (int)(offset))
#define DHD_PKTTAG_SET_PA(tag, pa) ((tag)->physaddr = (pa))
#define DHD_PKTTAG_SET_PA_LEN(tag, palen) ((tag)->pa_len = (palen))
#define DHD_PKTTAG_FLOWID(tag) ((tag)->flowid)
#define DHD_PKTTAG_IFID(tag) ((tag)->ifid)
#define DHD_PKTTAG_DATAOFF(tag) ((tag)->dataoff)
#define DHD_PKTTAG_PA(tag) ((tag)->physaddr)
#define DHD_PKTTAG_PA_LEN(tag) ((tag)->pa_len)
/* Hashing a MacAddress for lkup into a per interface flow hash table */
#define DHD_FLOWRING_HASHINDEX(ea, prio) \
((((uint8 *)(ea))[3] ^ ((uint8 *)(ea))[4] ^ ((uint8 *)(ea))[5] ^ ((uint8)(prio))) \
#define DHD_IF_ROLE(pub, idx) (((if_flow_lkup_t *)(pub)->if_flow_lkup)[idx].role)
#define DHD_IF_ROLE_AP(pub, idx) (DHD_IF_ROLE(pub, idx) == WLC_E_IF_ROLE_AP)
#define DHD_IF_ROLE_STA(pub, idx) (DHD_IF_ROLE(pub, idx) == WLC_E_IF_ROLE_STA)
#define DHD_IF_ROLE_P2PGO(pub, idx) (DHD_IF_ROLE(pub, idx) == WLC_E_IF_ROLE_P2P_GO)
#define DHD_FLOW_RING(dhdp, flowid) \
(flow_ring_node_t *)&(((flow_ring_node_t *)((dhdp)->flow_ring_table))[flowid])
struct flow_queue;
/* Flow Ring Queue Enqueue overflow callback */
typedef int (*flow_queue_cb_t)(struct flow_queue * queue, void * pkt);
* Each flow ring has an associated (tx flow controlled) queue. 802.3 packets are transferred
* between queue and ring. A packet from the host stack is first added to the queue, and in a later
* stage transferred to the flow ring. Packets in the queue are dhd owned, whereas packets in the
* flow ring are device owned.
typedef struct flow_queue {
dll_t list; /* manage a flowring queue in a double linked list */
void * head; /* first packet in the queue */
void * tail; /* last packet in the queue */
uint16 len; /* number of packets in the queue */
uint16 max; /* maximum or min budget (used in cumm) */
uint32 threshold; /* parent's cummulative length threshold */
void * clen_ptr; /* parent's cummulative length counter */
uint32 failures; /* enqueue failures due to queue overflow */
flow_queue_cb_t cb; /* callback invoked on threshold crossing */
} flow_queue_t;
#define DHD_FLOW_QUEUE_LEN(queue) ((int)(queue)->len)
#define DHD_FLOW_QUEUE_MAX(queue) ((int)(queue)->max)
#define DHD_FLOW_QUEUE_THRESHOLD(queue) ((int)(queue)->threshold)
#define DHD_FLOW_QUEUE_EMPTY(queue) ((queue)->len == 0)
#define DHD_FLOW_QUEUE_FAILURES(queue) ((queue)->failures)
#define DHD_FLOW_QUEUE_AVAIL(queue) ((int)((queue)->max - (queue)->len))
#define DHD_FLOW_QUEUE_FULL(queue) ((queue)->len >= (queue)->max)
#define DHD_FLOW_QUEUE_OVFL(queue, budget) \
(((queue)->len) > budget)
#define DHD_FLOW_QUEUE_SET_MAX(queue, budget) \
((queue)->max) = ((budget) - 1)
/* Queue's cummulative threshold. */
#define DHD_FLOW_QUEUE_SET_THRESHOLD(queue, cumm_threshold) \
((queue)->threshold) = ((cumm_threshold) - 1)
/* Queue's cummulative length object accessor. */
#define DHD_FLOW_QUEUE_CLEN_PTR(queue) ((queue)->clen_ptr)
/* Set a queue's cumm_len point to a parent's cumm_ctr_t cummulative length */
#define DHD_FLOW_QUEUE_SET_CLEN(queue, parent_clen_ptr) \
((queue)->clen_ptr) = (void *)(parent_clen_ptr)
/* see wlfc_proto.h for tx status details */
#define DHD_FLOWRING_TXSTATUS_CNT_UPDATE(bus, flowid, txstatus)
/** each flow ring is dedicated to a tid/sa/da combination */
typedef struct flow_info {
uint8 tid;
uint8 ifindex;
char sa[ETHER_ADDR_LEN];
char da[ETHER_ADDR_LEN];
} flow_info_t;
/** a flow ring is used for outbound (towards antenna) 802.3 packets */
typedef struct flow_ring_node {
dll_t list; /* manage a constructed flowring in a dll, must be at first place */
flow_queue_t queue; /* queues packets before they enter the flow ring, flow control */
bool active;
uint8 status;
* flowid: unique ID of a flow ring, which can either be unicast or broadcast/multicast. For
* unicast flow rings, the flow id accelerates ARM 802.3->802.11 header translation.
uint16 flowid;
flow_info_t flow_info;
void *prot_info;
void *lock; /* lock for flowring access protection */
} flow_ring_node_t;
typedef flow_ring_node_t flow_ring_table_t;
typedef struct flow_hash_info {
uint16 flowid;
flow_info_t flow_info;
struct flow_hash_info *next;
} flow_hash_info_t;
typedef struct if_flow_lkup {
bool status;
uint8 role; /* Interface role: STA/AP */
flow_hash_info_t *fl_hash[DHD_FLOWRING_HASH_SIZE]; /* Lkup Hash table */
} if_flow_lkup_t;
static INLINE flow_ring_node_t *
dhd_constlist_to_flowring(dll_t *item)
return ((flow_ring_node_t *)item);
/* Exported API */
/* Flow ring's queue management functions */
extern flow_ring_node_t * dhd_flow_ring_node(dhd_pub_t *dhdp, uint16 flowid);
extern flow_queue_t * dhd_flow_queue(dhd_pub_t *dhdp, uint16 flowid);
extern void dhd_flow_queue_init(dhd_pub_t *dhdp, flow_queue_t *queue, int max);
extern void dhd_flow_queue_register(flow_queue_t *queue, flow_queue_cb_t cb);
extern int dhd_flow_queue_enqueue(dhd_pub_t *dhdp, flow_queue_t *queue, void *pkt);
extern void * dhd_flow_queue_dequeue(dhd_pub_t *dhdp, flow_queue_t *queue);
extern void dhd_flow_queue_reinsert(dhd_pub_t *dhdp, flow_queue_t *queue, void *pkt);
extern void dhd_flow_ring_config_thresholds(dhd_pub_t *dhdp, uint16 flowid,
int queue_budget, int cumm_threshold, void *cumm_ctr);
extern int dhd_flow_rings_init(dhd_pub_t *dhdp, uint32 num_flow_rings);
extern void dhd_flow_rings_deinit(dhd_pub_t *dhdp);
extern int dhd_flowid_update(dhd_pub_t *dhdp, uint8 ifindex, uint8 prio,
void *pktbuf);
extern void dhd_flowid_free(dhd_pub_t *dhdp, uint8 ifindex, uint16 flowid);
extern void dhd_flow_rings_delete(dhd_pub_t *dhdp, uint8 ifindex);
extern void dhd_flow_rings_delete_for_peer(dhd_pub_t *dhdp, uint8 ifindex,
char *addr);
/* Handle Interface ADD, DEL operations */
extern void dhd_update_interface_flow_info(dhd_pub_t *dhdp, uint8 ifindex,
uint8 op, uint8 role);
/* Handle a STA interface link status update */
extern int dhd_update_interface_link_status(dhd_pub_t *dhdp, uint8 ifindex,
uint8 status);
extern int dhd_flow_prio_map(dhd_pub_t *dhd, uint8 *map, bool set);
extern int dhd_update_flow_prio_map(dhd_pub_t *dhdp, uint8 map);
extern uint8 dhd_flow_rings_ifindex2role(dhd_pub_t *dhdp, uint8 ifindex);
#endif /* _dhd_flowrings_h_ */