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>
22 #include <linux/workqueue.h>
23 
24 #include "ucode_loader.h"
25 /*
26  * Starting index for 5G rates in the
27  * legacy rate table.
28  */
29 #define BRCMS_LEGACY_5G_RATE_OFFSET	4
30 
31 /* softmac ioctl definitions */
32 #define BRCMS_SET_SHORTSLOT_OVERRIDE		146
33 
34 struct brcms_timer {
35 	struct delayed_work dly_wrk;
36 	struct brcms_info *wl;
37 	void (*fn) (void *);	/* function called upon expiration */
38 	void *arg;		/* fixed argument provided to called function */
39 	uint ms;
40 	bool periodic;
41 	bool set;		/* indicates if timer is active */
42 	struct brcms_timer *next;	/* for freeing on unload */
43 #ifdef DEBUG
44 	char *name;		/* Description of the timer */
45 #endif
46 };
47 
48 struct brcms_if {
49 	uint subunit;		/* WDS/BSS unit */
50 	struct pci_dev *pci_dev;
51 };
52 
53 #define MAX_FW_IMAGES		4
54 struct brcms_firmware {
55 	u32 fw_cnt;
56 	const struct firmware *fw_bin[MAX_FW_IMAGES];
57 	const struct firmware *fw_hdr[MAX_FW_IMAGES];
58 	u32 hdr_num_entries[MAX_FW_IMAGES];
59 };
60 
61 struct brcms_info {
62 	struct brcms_pub *pub;		/* pointer to public wlc state */
63 	struct brcms_c_info *wlc;	/* pointer to private common data */
64 	u32 magic;
65 
66 	int irq;
67 
68 	spinlock_t lock;	/* per-device perimeter lock */
69 	spinlock_t isr_lock;	/* per-device ISR synchronization lock */
70 
71 
72 	/* timer related fields */
73 	atomic_t callbacks;	/* # outstanding callback functions */
74 	struct brcms_timer *timers;	/* timer cleanup queue */
75 
76 	struct tasklet_struct tasklet;	/* dpc tasklet */
77 	bool resched;		/* dpc needs to be and is rescheduled */
78 	struct brcms_firmware fw;
79 	struct wiphy *wiphy;
80 	struct brcms_ucode ucode;
81 	bool mute_tx;
82 };
83 
84 /* misc callbacks */
85 extern void brcms_init(struct brcms_info *wl);
86 extern uint brcms_reset(struct brcms_info *wl);
87 extern void brcms_intrson(struct brcms_info *wl);
88 extern u32 brcms_intrsoff(struct brcms_info *wl);
89 extern void brcms_intrsrestore(struct brcms_info *wl, u32 macintmask);
90 extern int brcms_up(struct brcms_info *wl);
91 extern void brcms_down(struct brcms_info *wl);
92 extern void brcms_txflowcontrol(struct brcms_info *wl, struct brcms_if *wlif,
93 				bool state, int prio);
94 extern bool brcms_rfkill_set_hw_state(struct brcms_info *wl);
95 
96 /* timer functions */
97 extern struct brcms_timer *brcms_init_timer(struct brcms_info *wl,
98 				      void (*fn) (void *arg), void *arg,
99 				      const char *name);
100 extern void brcms_free_timer(struct brcms_timer *timer);
101 extern void brcms_add_timer(struct brcms_timer *timer, uint ms, int periodic);
102 extern bool brcms_del_timer(struct brcms_timer *timer);
103 extern void brcms_msleep(struct brcms_info *wl, uint ms);
104 extern void brcms_dpc(unsigned long data);
105 extern void brcms_timer(struct brcms_timer *t);
106 extern void brcms_fatal_error(struct brcms_info *wl);
107 
108 #endif				/* _BRCM_MAC80211_IF_H_ */
109