[mirror_ubuntu-zesty-kernel.git] / drivers / net / wireless / brcm80211 / brcmsmac / mac80211_if.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 _BRCM_MAC80211_IF_H_
#define _BRCM_MAC80211_IF_H_

#include <linux/timer.h>
#include <linux/interrupt.h>
#include <linux/workqueue.h>
#include <linux/leds.h>

#include "ucode_loader.h"
#include "led.h"
/*
 * Starting index for 5G rates in the
 * legacy rate table.
 */
#define BRCMS_LEGACY_5G_RATE_OFFSET	4

/* softmac ioctl definitions */
#define BRCMS_SET_SHORTSLOT_OVERRIDE		146

struct brcms_timer {
	struct delayed_work dly_wrk;
	struct brcms_info *wl;
	void (*fn) (void *);	/* function called upon expiration */
	void *arg;		/* fixed argument provided to called function */
	uint ms;
	bool periodic;
	bool set;		/* indicates if timer is active */
	struct brcms_timer *next;	/* for freeing on unload */
#ifdef DEBUG
	char *name;		/* Description of the timer */
#endif
};

struct brcms_if {
	uint subunit;		/* WDS/BSS unit */
	struct pci_dev *pci_dev;
};

#define MAX_FW_IMAGES		4
struct brcms_firmware {
	u32 fw_cnt;
	const struct firmware *fw_bin[MAX_FW_IMAGES];
	const struct firmware *fw_hdr[MAX_FW_IMAGES];
	u32 hdr_num_entries[MAX_FW_IMAGES];
};

struct brcms_info {
	struct brcms_pub *pub;		/* pointer to public wlc state */
	struct brcms_c_info *wlc;	/* pointer to private common data */
	u32 magic;

	int irq;

	spinlock_t lock;	/* per-device perimeter lock */
	spinlock_t isr_lock;	/* per-device ISR synchronization lock */

	/* tx flush */
	wait_queue_head_t tx_flush_wq;

	/* timer related fields */
	atomic_t callbacks;	/* # outstanding callback functions */
	struct brcms_timer *timers;	/* timer cleanup queue */

	struct tasklet_struct tasklet;	/* dpc tasklet */
	bool resched;		/* dpc needs to be and is rescheduled */
	struct brcms_firmware fw;
	struct wiphy *wiphy;
	struct brcms_ucode ucode;
	bool mute_tx;
	struct brcms_led radio_led;
	struct led_classdev led_dev;
};

/* misc callbacks */
extern void brcms_init(struct brcms_info *wl);
extern uint brcms_reset(struct brcms_info *wl);
extern void brcms_intrson(struct brcms_info *wl);
extern u32 brcms_intrsoff(struct brcms_info *wl);
extern void brcms_intrsrestore(struct brcms_info *wl, u32 macintmask);
extern int brcms_up(struct brcms_info *wl);
extern void brcms_down(struct brcms_info *wl);
extern void brcms_txflowcontrol(struct brcms_info *wl, struct brcms_if *wlif,
				bool state, int prio);
extern bool brcms_rfkill_set_hw_state(struct brcms_info *wl);

/* timer functions */
extern struct brcms_timer *brcms_init_timer(struct brcms_info *wl,
				      void (*fn) (void *arg), void *arg,
				      const char *name);
extern void brcms_free_timer(struct brcms_timer *timer);
extern void brcms_add_timer(struct brcms_timer *timer, uint ms, int periodic);
extern bool brcms_del_timer(struct brcms_timer *timer);
extern void brcms_dpc(unsigned long data);
extern void brcms_timer(struct brcms_timer *t);
extern void brcms_fatal_error(struct brcms_info *wl);

#endif				/* _BRCM_MAC80211_IF_H_ */
Commit	Line	Data
5b435de0 AS	1	/*
	2	* Copyright (c) 2010 Broadcom Corporation
	3	*
	4	* Permission to use, copy, modify, and/or distribute this software for any
	5	* purpose with or without fee is hereby granted, provided that the above
	6	* copyright notice and this permission notice appear in all copies.
	7	*
	8	* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
	9	* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
	10	* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
	11	* SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
	12	* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
	13	* OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
	14	* CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
	15	*/
	16
	17	#ifndef _BRCM_MAC80211_IF_H_
	18	#define _BRCM_MAC80211_IF_H_
	19
	20	#include <linux/timer.h>
	21	#include <linux/interrupt.h>
2a7fc5b1	22	#include <linux/workqueue.h>
cd864522	23	#include <linux/leds.h>
2a7fc5b1	24
5b435de0	25	#include "ucode_loader.h"
cd864522	26	#include "led.h"
5b435de0 AS	27	/*
	28	* Starting index for 5G rates in the
	29	* legacy rate table.
	30	*/
	31	#define BRCMS_LEGACY_5G_RATE_OFFSET 4
	32
	33	/* softmac ioctl definitions */
	34	#define BRCMS_SET_SHORTSLOT_OVERRIDE 146
	35
	36	struct brcms_timer {
2a7fc5b1	37	struct delayed_work dly_wrk;
5b435de0	38	struct brcms_info *wl;
2a7fc5b1 RV	39	void (fn) (void ); /* function called upon expiration */
2a7fc5b1 RV	40	void arg; / fixed argument provided to called function */
5b435de0 AS	41	uint ms;
5b435de0 AS	42	bool periodic;
2a7fc5b1 RV	43	bool set; /* indicates if timer is active */
2a7fc5b1 RV	44	struct brcms_timer next; / for freeing on unload */
8ae74654	45	#ifdef DEBUG
5b435de0 AS	46	char name; / Description of the timer */
	47	#endif
	48	};
	49
	50	struct brcms_if {
	51	uint subunit; /* WDS/BSS unit */
	52	struct pci_dev *pci_dev;
	53	};
	54
	55	#define MAX_FW_IMAGES 4
	56	struct brcms_firmware {
	57	u32 fw_cnt;
	58	const struct firmware *fw_bin[MAX_FW_IMAGES];
	59	const struct firmware *fw_hdr[MAX_FW_IMAGES];
	60	u32 hdr_num_entries[MAX_FW_IMAGES];
	61	};
	62
	63	struct brcms_info {
	64	struct brcms_pub pub; / pointer to public wlc state */
	65	struct brcms_c_info wlc; / pointer to private common data */
	66	u32 magic;
	67
	68	int irq;
	69
	70	spinlock_t lock; /* per-device perimeter lock */
	71	spinlock_t isr_lock; /* per-device ISR synchronization lock */
	72
7b2385b9 AS	73	/* tx flush */
7b2385b9 AS	74	wait_queue_head_t tx_flush_wq;
5b435de0 AS	75
	76	/* timer related fields */
	77	atomic_t callbacks; /* # outstanding callback functions */
	78	struct brcms_timer timers; / timer cleanup queue */
	79
	80	struct tasklet_struct tasklet; /* dpc tasklet */
	81	bool resched; /* dpc needs to be and is rescheduled */
	82	struct brcms_firmware fw;
	83	struct wiphy *wiphy;
	84	struct brcms_ucode ucode;
dc460127	85	bool mute_tx;
cd864522 PH	86	struct brcms_led radio_led;
cd864522 PH	87	struct led_classdev led_dev;
5b435de0 AS	88	};
	89
	90	/* misc callbacks */
	91	extern void brcms_init(struct brcms_info *wl);
	92	extern uint brcms_reset(struct brcms_info *wl);
	93	extern void brcms_intrson(struct brcms_info *wl);
	94	extern u32 brcms_intrsoff(struct brcms_info *wl);
	95	extern void brcms_intrsrestore(struct brcms_info *wl, u32 macintmask);
	96	extern int brcms_up(struct brcms_info *wl);
	97	extern void brcms_down(struct brcms_info *wl);
	98	extern void brcms_txflowcontrol(struct brcms_info wl, struct brcms_if wlif,
	99	bool state, int prio);
	100	extern bool brcms_rfkill_set_hw_state(struct brcms_info *wl);
	101
	102	/* timer functions */
	103	extern struct brcms_timer brcms_init_timer(struct brcms_info wl,
	104	void (fn) (void arg), void *arg,
	105	const char *name);
be69c4ef RV	106	extern void brcms_free_timer(struct brcms_timer *timer);
	107	extern void brcms_add_timer(struct brcms_timer *timer, uint ms, int periodic);
	108	extern bool brcms_del_timer(struct brcms_timer *timer);
5b435de0 AS	109	extern void brcms_dpc(unsigned long data);
5b435de0 AS	110	extern void brcms_timer(struct brcms_timer *t);
c261bdf8	111	extern void brcms_fatal_error(struct brcms_info *wl);
5b435de0 AS	112
5b435de0 AS	113	#endif /* _BRCM_MAC80211_IF_H_ */