1/*-
2 * Copyright (c) 2002-2007 Sam Leffler, Errno Consulting
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer,
10 *    without modification.
11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13 *    redistribution must be conditioned upon including a substantially
14 *    similar Disclaimer requirement for further binary redistribution.
15 * 3. Neither the names of the above-listed copyright holders nor the names
16 *    of any contributors may be used to endorse or promote products derived
17 *    from this software without specific prior written permission.
18 *
19 * Alternatively, this software may be distributed under the terms of the
20 * GNU General Public License ("GPL") version 2 as published by the Free
21 * Software Foundation.
22 *
23 * NO WARRANTY
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
27 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
28 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
29 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
32 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
34 * THE POSSIBILITY OF SUCH DAMAGES.
35 *
36 */
37
38/*
39 * Definitions for the Atheros Wireless LAN controller driver.
40 */
41#ifndef _DEV_ATH5K_BASE_H
42#define _DEV_ATH5K_BASE_H
43
44struct ieee80211_vif;
45struct ieee80211_hw;
46struct ath5k_hw;
47struct ath5k_txq;
48struct ieee80211_channel;
49struct ath_bus_ops;
50struct ieee80211_tx_control;
51enum nl80211_iftype;
52
53enum ath5k_srev_type {
54	AR5K_VERSION_MAC,
55	AR5K_VERSION_RAD,
56};
57
58struct ath5k_srev_name {
59	const char		*sr_name;
60	enum ath5k_srev_type	sr_type;
61	u_int			sr_val;
62};
63
64struct ath5k_buf {
65	struct list_head		list;
66	struct ath5k_desc		*desc;		/* virtual addr of desc */
67	dma_addr_t			daddr;		/* physical addr of desc */
68	struct sk_buff			*skb;		/* skbuff for buf */
69	dma_addr_t			skbaddr;	/* physical addr of skb data */
70	struct ieee80211_tx_rate	rates[4];	/* number of multi-rate stages */
71};
72
73struct ath5k_vif {
74	bool			assoc; /* are we associated or not */
75	enum nl80211_iftype	opmode;
76	int			bslot;
77	struct ath5k_buf	*bbuf; /* beacon buffer */
78};
79
80struct ath5k_vif_iter_data {
81	const u8	*hw_macaddr;
82	u8		mask[ETH_ALEN];
83	u8		active_mac[ETH_ALEN]; /* first active MAC */
84	bool		need_set_hw_addr;
85	bool		found_active;
86	bool		any_assoc;
87	enum nl80211_iftype opmode;
88	int n_stas;
89};
90
91void ath5k_vif_iter(void *data, u8 *mac, struct ieee80211_vif *vif);
92bool ath5k_any_vif_assoc(struct ath5k_hw *ah);
93
94int ath5k_start(struct ieee80211_hw *hw);
95void ath5k_stop(struct ieee80211_hw *hw);
96
97void ath5k_beacon_update_timers(struct ath5k_hw *ah, u64 bc_tsf);
98int ath5k_beacon_update(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
99void ath5k_beacon_config(struct ath5k_hw *ah);
100void ath5k_set_beacon_filter(struct ieee80211_hw *hw, bool enable);
101
102void ath5k_update_bssid_mask_and_opmode(struct ath5k_hw *ah,
103					struct ieee80211_vif *vif);
104int ath5k_chan_set(struct ath5k_hw *ah, struct cfg80211_chan_def *chandef);
105void ath5k_txbuf_free_skb(struct ath5k_hw *ah, struct ath5k_buf *bf);
106void ath5k_rxbuf_free_skb(struct ath5k_hw *ah, struct ath5k_buf *bf);
107void ath5k_tx_queue(struct ieee80211_hw *hw, struct sk_buff *skb,
108		    struct ath5k_txq *txq, struct ieee80211_tx_control *control);
109
110const char *ath5k_chip_name(enum ath5k_srev_type type, u_int16_t val);
111
112int ath5k_init_ah(struct ath5k_hw *ah, const struct ath_bus_ops *bus_ops);
113void ath5k_deinit_ah(struct ath5k_hw *ah);
114
115/* Check whether BSSID mask is supported */
116#define ath5k_hw_hasbssidmask(_ah) (ah->ah_version == AR5K_AR5212)
117
118/* Check whether virtual EOL is supported */
119#define ath5k_hw_hasveol(_ah) (ah->ah_version != AR5K_AR5210)
120
121#endif	/* _DEV_ATH5K_BASE_H */
122