drivers/wlan/third_party/broadcom/brcmfmac/core.h

/*
 * Copyright (c) 2010 Broadcom Corporation
 *
 * 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.
 */

/****************
 * Common types *
 */

#ifndef BRCMFMAC_CORE_H
#define BRCMFMAC_CORE_H

#include <ddk/protocol/ethernet.h>
#include <netinet/if_ether.h>
#include <lib/sync/completion.h>
#include <wlan/protocol/if-impl.h>

#include <stdatomic.h>
#include <threads.h>

#include "fweh.h"
#include "linuxisms.h"
#include "netbuf.h"
#include "workqueue.h"

#define TOE_TX_CSUM_OL 0x00000001
#define TOE_RX_CSUM_OL 0x00000002

/* For supporting multiple interfaces */
#define BRCMF_MAX_IFS 16

/* Small, medium and maximum buffer size for dcmd
 */
#define BRCMF_DCMD_SMLEN 256
#define BRCMF_DCMD_MEDLEN 1536
#define BRCMF_DCMD_MAXLEN 8192

/* IOCTL from host to device are limited in length. A device can only handle
 * ethernet frame size. This limitation is to be applied by protocol layer.
 */
#define BRCMF_TX_IOCTL_MAX_MSG_SIZE (ETH_FRAME_LEN + ETH_FCS_LEN)

#define BRCMF_AMPDU_RX_REORDER_MAXFLOWS 256

/* Length of firmware version string stored for
 * ethtool driver info which uses 32 bytes as well.
 */
#define BRCMF_DRIVER_FIRMWARE_VERSION_LEN 32

#define NDOL_MAX_ENTRIES 8

/**
 * struct brcmf_ampdu_rx_reorder - AMPDU receive reorder info
 *
 * @pktslots: dynamic allocated array for ordering AMPDU packets.
 * @flow_id: AMPDU flow identifier.
 * @cur_idx: last AMPDU index from firmware.
 * @exp_idx: expected next AMPDU index.
 * @max_idx: maximum amount of packets per AMPDU.
 * @pend_pkts: number of packets currently in @pktslots.
 */
struct brcmf_ampdu_rx_reorder {
    struct brcmf_netbuf** pktslots;
    uint8_t flow_id;
    uint8_t cur_idx;
    uint8_t exp_idx;
    uint8_t max_idx;
    uint8_t pend_pkts;
};

/* Forward decls for struct brcmf_pub (see below) */
struct brcmf_proto;     /* device communication protocol info */
struct brcmf_fws_info;  /* firmware signalling info */
struct brcmf_mp_device; /* module paramateres, device specific */

/*
 * struct brcmf_rev_info
 *
 * The result field stores the error code of the
 * revision info request from firmware. For the
 * other fields see struct brcmf_rev_info_le in
 * fwil_types.h
 */
struct brcmf_rev_info {
    zx_status_t result;
    uint32_t vendorid;
    uint32_t deviceid;
    uint32_t radiorev;
    uint32_t chiprev;
    uint32_t corerev;
    uint32_t boardid;
    uint32_t boardvendor;
    uint32_t boardrev;
    uint32_t driverrev;
    uint32_t ucoderev;
    uint32_t bus;
    uint32_t chipnum;
    uint32_t phytype;
    uint32_t phyrev;
    uint32_t anarev;
    uint32_t chippkg;
    uint32_t nvramrev;
};

/* Common structure for module and instance linkage */
struct brcmf_pub {
    /* Linkage ponters */
    struct brcmf_bus* bus_if;
    struct brcmf_proto* proto;
    struct brcmf_cfg80211_info* config;

    /* Internal brcmf items */
    uint hdrlen; /* Total BRCMF header length (proto + bus) */

    /* Dongle media info */
    char fwver[BRCMF_DRIVER_FIRMWARE_VERSION_LEN];
    uint8_t mac[ETH_ALEN]; /* MAC address obtained from dongle */

    struct mac_address addresses[BRCMF_MAX_IFS];

    struct brcmf_if* iflist[BRCMF_MAX_IFS];
    int32_t if2bss[BRCMF_MAX_IFS];

    mtx_t proto_block;
    unsigned char proto_buf[BRCMF_DCMD_MAXLEN];

    struct brcmf_fweh_info fweh;

    struct brcmf_ampdu_rx_reorder* reorder_flows[BRCMF_AMPDU_RX_REORDER_MAXFLOWS];

    uint32_t feat_flags;
    uint32_t chip_quirks;

    struct brcmf_rev_info revinfo;
#ifdef DEBUG
    zx_handle_t dbgfs_dir;
#endif

    struct notifier_block inetaddr_notifier;
    struct notifier_block inet6addr_notifier;
    struct brcmf_mp_device* settings;

    uint8_t clmver[BRCMF_DCMD_SMLEN];
};

/* forward declarations */
struct brcmf_cfg80211_vif;
struct brcmf_fws_mac_descriptor;

/**
 * enum brcmf_netif_stop_reason - reason for stopping netif queue.
 *
 * @BRCMF_NETIF_STOP_REASON_FWS_FC:
 *  netif stopped due to firmware signalling flow control.
 * @BRCMF_NETIF_STOP_REASON_FLOW:
 *  netif stopped due to flowring full.
 * @BRCMF_NETIF_STOP_REASON_DISCONNECTED:
 *  netif stopped due to not being connected (STA mode).
 */
enum brcmf_netif_stop_reason {
    BRCMF_NETIF_STOP_REASON_FWS_FC = BIT(0),
    BRCMF_NETIF_STOP_REASON_FLOW = BIT(1),
    BRCMF_NETIF_STOP_REASON_DISCONNECTED = BIT(2)
};

/**
 * struct brcmf_if - interface control information.
 *
 * @drvr: points to device related information.
 * @vif: points to cfg80211 specific interface information.
 * @ndev: associated network device.
 * @multicast_work: worker object for multicast provisioning.
 * @ndoffload_work: worker object for neighbor discovery offload configuration.
 * @fws_desc: interface specific firmware-signalling descriptor.
 * @ifidx: interface index in device firmware.
 * @bsscfgidx: index of bss associated with this interface.
 * @mac_addr: assigned mac address.
 * @netif_stop: bitmap indicates reason why netif queues are stopped.
 * //@netif_stop_lock: spinlock for update netif_stop from multiple sources.
 *  (replaced by irq_callback_lock)
 * @bss: information on current bss.
 * @pend_8021x_cnt: tracks outstanding number of 802.1x frames.
 * @pend_8021x_wait: used for signalling change in count.
 */
struct brcmf_if {
    struct brcmf_pub* drvr;
    struct brcmf_cfg80211_vif* vif;
    struct net_device* ndev;
    struct work_struct multicast_work;
    struct work_struct ndoffload_work;
    struct brcmf_fws_mac_descriptor* fws_desc;
    int ifidx;
    int32_t bsscfgidx;
    uint8_t mac_addr[ETH_ALEN];
    uint8_t netif_stop;
    struct wlanif_bss_description bss;
    //spinlock_t netif_stop_lock;
    atomic_int pend_8021x_cnt;
    sync_completion_t pend_8021x_wait;
    struct in6_addr ipv6_addr_tbl[NDOL_MAX_ENTRIES];
    uint8_t ipv6addr_idx;
};

void brcmf_netdev_wait_pend8021x(struct brcmf_if* ifp);

/* Return pointer to interface name */
char* brcmf_ifname(struct brcmf_if* ifp);
struct brcmf_if* brcmf_get_ifp(struct brcmf_pub* drvr, int ifidx);
void brcmf_configure_arp_nd_offload(struct brcmf_if* ifp, bool enable);
zx_status_t brcmf_net_attach(struct brcmf_if* ifp, bool rtnl_locked);
zx_status_t brcmf_add_if(struct brcmf_pub* drvr, int32_t bsscfgidx, int32_t ifidx, bool is_p2pdev,
                         const char* name, uint8_t* mac_addr, struct brcmf_if** if_out);
void brcmf_remove_interface(struct brcmf_if* ifp, bool rtnl_locked);
void brcmf_txflowblock_if(struct brcmf_if* ifp, enum brcmf_netif_stop_reason reason, bool state);
void brcmf_txfinalize(struct brcmf_if* ifp, struct brcmf_netbuf* txp, bool success);
void brcmf_netif_rx(struct brcmf_if* ifp, struct brcmf_netbuf* netbuf);
void brcmf_net_setcarrier(struct brcmf_if* ifp, bool on);
zx_status_t brcmf_core_init(zx_device_t* dev);
void brcmf_core_exit(void);
void brcmf_netdev_start_xmit(struct net_device* ndev, ethmac_netbuf_t* netbuf);

#endif /* BRCMFMAC_CORE_H */