cregit-Linux how code gets into the kernel

Release 4.11 drivers/net/wireless/broadcom/brcm80211/brcmfmac/bus.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.
 */

#ifndef BRCMFMAC_BUS_H

#define BRCMFMAC_BUS_H

#include "debug.h"

/* IDs of the 6 default common rings of msgbuf protocol */

#define BRCMF_H2D_MSGRING_CONTROL_SUBMIT	0

#define BRCMF_H2D_MSGRING_RXPOST_SUBMIT		1

#define BRCMF_H2D_MSGRING_FLOWRING_IDSTART	2

#define BRCMF_D2H_MSGRING_CONTROL_COMPLETE	2

#define BRCMF_D2H_MSGRING_TX_COMPLETE		3

#define BRCMF_D2H_MSGRING_RX_COMPLETE		4



#define BRCMF_NROF_H2D_COMMON_MSGRINGS		2

#define BRCMF_NROF_D2H_COMMON_MSGRINGS		3

#define BRCMF_NROF_COMMON_MSGRINGS	(BRCMF_NROF_H2D_COMMON_MSGRINGS + \
                                         BRCMF_NROF_D2H_COMMON_MSGRINGS)

/* The level of bus communication with the dongle */

enum brcmf_bus_state {
	
BRCMF_BUS_DOWN,		/* Not ready for frame transfers */
	
BRCMF_BUS_UP		/* Ready for frame transfers */
};

/* The level of bus communication with the dongle */

enum brcmf_bus_protocol_type {
	
BRCMF_PROTO_BCDC,
	
BRCMF_PROTO_MSGBUF
};

struct brcmf_mp_device;


struct brcmf_bus_dcmd {
	
char *name;
	
char *param;
	
int param_len;
	
struct list_head list;
};

/**
 * struct brcmf_bus_ops - bus callback operations.
 *
 * @preinit: execute bus/device specific dongle init commands (optional).
 * @init: prepare for communication with dongle.
 * @stop: clear pending frames, disable data flow.
 * @txdata: send a data frame to the dongle. When the data
 *      has been transferred, the common driver must be
 *      notified using brcmf_txcomplete(). The common
 *      driver calls this function with interrupts
 *      disabled.
 * @txctl: transmit a control request message to dongle.
 * @rxctl: receive a control response message from dongle.
 * @gettxq: obtain a reference of bus transmit queue (optional).
 * @wowl_config: specify if dongle is configured for wowl when going to suspend
 * @get_ramsize: obtain size of device memory.
 * @get_memdump: obtain device memory dump in provided buffer.
 *
 * This structure provides an abstract interface towards the
 * bus specific driver. For control messages to common driver
 * will assure there is only one active transaction. Unless
 * indicated otherwise these callbacks are mandatory.
 */

struct brcmf_bus_ops {
	
int (*preinit)(struct device *dev);
	
void (*stop)(struct device *dev);
	
int (*txdata)(struct device *dev, struct sk_buff *skb);
	
int (*txctl)(struct device *dev, unsigned char *msg, uint len);
	
int (*rxctl)(struct device *dev, unsigned char *msg, uint len);
	
struct pktq * (*gettxq)(struct device *dev);
	
void (*wowl_config)(struct device *dev, bool enabled);
	
size_t (*get_ramsize)(struct device *dev);
	
int (*get_memdump)(struct device *dev, void *data, size_t len);
};


/**
 * struct brcmf_bus_msgbuf - bus ringbuf if in case of msgbuf.
 *
 * @commonrings: commonrings which are always there.
 * @flowrings: commonrings which are dynamically created and destroyed for data.
 * @rx_dataoffset: if set then all rx data has this this offset.
 * @max_rxbufpost: maximum number of buffers to post for rx.
 * @max_flowrings: maximum number of tx flow rings supported.
 * @max_submissionrings: maximum number of submission rings(h2d) supported.
 * @max_completionrings: maximum number of completion rings(d2h) supported.
 */

struct brcmf_bus_msgbuf {
	
struct brcmf_commonring *commonrings[BRCMF_NROF_COMMON_MSGRINGS];
	
struct brcmf_commonring **flowrings;
	
u32 rx_dataoffset;
	
u32 max_rxbufpost;
	
u16 max_flowrings;
	
u16 max_submissionrings;
	
u16 max_completionrings;
};


/**
 * struct brcmf_bus - interface structure between common and bus layer
 *
 * @bus_priv: pointer to private bus device.
 * @proto_type: protocol type, bcdc or msgbuf
 * @dev: device pointer of bus device.
 * @drvr: public driver information.
 * @state: operational state of the bus interface.
 * @maxctl: maximum size for rxctl request message.
 * @tx_realloc: number of tx packets realloced for headroom.
 * @dstats: dongle-based statistical data.
 * @dcmd_list: bus/device specific dongle initialization commands.
 * @chip: device identifier of the dongle chip.
 * @wowl_supported: is wowl supported by bus driver.
 * @chiprev: revision of the dongle chip.
 */

struct brcmf_bus {
	union {
		
struct brcmf_sdio_dev *sdio;
		
struct brcmf_usbdev *usb;
		
struct brcmf_pciedev *pcie;
	} 
bus_priv;
	
enum brcmf_bus_protocol_type proto_type;
	
struct device *dev;
	
struct brcmf_pub *drvr;
	
enum brcmf_bus_state state;
	
uint maxctl;
	
unsigned long tx_realloc;
	
u32 chip;
	
u32 chiprev;
	
bool always_use_fws_queue;
	
bool wowl_supported;

	
const struct brcmf_bus_ops *ops;
	
struct brcmf_bus_msgbuf *msgbuf;
};

/*
 * callback wrappers
 */

static inline int brcmf_bus_preinit(struct brcmf_bus *bus) { if (!bus->ops->preinit) return 0; return bus->ops->preinit(bus->dev); }

Contributors

PersonTokensPropCommitsCommitProp
Arend Van Spriel36100.00%1100.00%
Total36100.00%1100.00%


static inline void brcmf_bus_stop(struct brcmf_bus *bus) { bus->ops->stop(bus->dev); }

Contributors

PersonTokensPropCommitsCommitProp
Arend Van Spriel1982.61%150.00%
Franky Lin417.39%150.00%
Total23100.00%2100.00%


static inline int brcmf_bus_txdata(struct brcmf_bus *bus, struct sk_buff *skb) { return bus->ops->txdata(bus->dev, skb); }

Contributors

PersonTokensPropCommitsCommitProp
Arend Van Spriel2167.74%150.00%
Franky Lin1032.26%150.00%
Total31100.00%2100.00%


static inline int brcmf_bus_txctl(struct brcmf_bus *bus, unsigned char *msg, uint len) { return bus->ops->txctl(bus->dev, msg, len); }

Contributors

PersonTokensPropCommitsCommitProp
Arend Van Spriel2466.67%150.00%
Franky Lin1233.33%150.00%
Total36100.00%2100.00%


static inline int brcmf_bus_rxctl(struct brcmf_bus *bus, unsigned char *msg, uint len) { return bus->ops->rxctl(bus->dev, msg, len); }

Contributors

PersonTokensPropCommitsCommitProp
Arend Van Spriel2363.89%133.33%
Franky Lin1336.11%266.67%
Total36100.00%3100.00%


static inline struct pktq *brcmf_bus_gettxq(struct brcmf_bus *bus) { if (!bus->ops->gettxq) return ERR_PTR(-ENOENT); return bus->ops->gettxq(bus->dev); }

Contributors

PersonTokensPropCommitsCommitProp
Arend Van Spriel42100.00%1100.00%
Total42100.00%1100.00%


static inline void brcmf_bus_wowl_config(struct brcmf_bus *bus, bool enabled) { if (bus->ops->wowl_config) bus->ops->wowl_config(bus->dev, enabled); }

Contributors

PersonTokensPropCommitsCommitProp
Hante Meuleman36100.00%1100.00%
Total36100.00%1100.00%


static inline size_t brcmf_bus_get_ramsize(struct brcmf_bus *bus) { if (!bus->ops->get_ramsize) return 0; return bus->ops->get_ramsize(bus->dev); }

Contributors

PersonTokensPropCommitsCommitProp
Arend Van Spriel36100.00%1100.00%
Total36100.00%1100.00%


static inline int brcmf_bus_get_memdump(struct brcmf_bus *bus, void *data, size_t len) { if (!bus->ops->get_memdump) return -EOPNOTSUPP; return bus->ops->get_memdump(bus->dev, data, len); }

Contributors

PersonTokensPropCommitsCommitProp
Arend Van Spriel48100.00%1100.00%
Total48100.00%1100.00%

/* * interface functions from common layer */ /* Receive frame for delivery to OS. Callee disposes of rxp. */ void brcmf_rx_frame(struct device *dev, struct sk_buff *rxp, bool handle_event); /* Receive async event packet from firmware. Callee disposes of rxp. */ void brcmf_rx_event(struct device *dev, struct sk_buff *rxp); /* Indication from bus module regarding presence/insertion of dongle. */ int brcmf_attach(struct device *dev, struct brcmf_mp_device *settings); /* Indication from bus module regarding removal/absence of dongle */ void brcmf_detach(struct device *dev); /* Indication from bus module that dongle should be reset */ void brcmf_dev_reset(struct device *dev); /* Indication from bus module to change flow-control state */ void brcmf_txflowblock(struct device *dev, bool state); /* Notify the bus has transferred the tx packet to firmware */ void brcmf_txcomplete(struct device *dev, struct sk_buff *txp, bool success); /* Configure the "global" bus state used by upper layers */ void brcmf_bus_change_state(struct brcmf_bus *bus, enum brcmf_bus_state state); int brcmf_bus_started(struct device *dev); s32 brcmf_iovar_data_set(struct device *dev, char *name, void *data, u32 len); void brcmf_bus_add_txhdrlen(struct device *dev, uint len); #ifdef CONFIG_BRCMFMAC_SDIO void brcmf_sdio_exit(void); void brcmf_sdio_register(void); #endif #ifdef CONFIG_BRCMFMAC_USB void brcmf_usb_exit(void); void brcmf_usb_register(void); #endif #endif /* BRCMFMAC_BUS_H */

Overall Contributors

PersonTokensPropCommitsCommitProp
Arend Van Spriel50458.40%1745.95%
Franky Lin18821.78%718.92%
Hante Meuleman16919.58%1129.73%
Rafał Miłecki10.12%12.70%
Julia Lawall10.12%12.70%
Total863100.00%37100.00%
Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
Created with cregit.