4 /** (legal) claimer in README
5 ** Copyright (C) 2003 ACX100 Open Source Project
8 #include <linux/version.h>
9 #include "acx_commands.h"
11 /***********************************************************************
14 ** - Avoid SHOUTING needlessly. Avoid excessive verbosity.
15 ** Gradually remove messages which are old debugging aids.
17 ** - Use printk() for messages which are to be always logged.
18 ** Supply either 'acx:' or '<devname>:' prefix so that user
19 ** can figure out who's speaking among other kernel chatter.
20 ** acx: is for general issues (e.g. "acx: no firmware image!")
21 ** while <devname>: is related to a particular device
22 ** (think about multi-card setup). Double check that message
23 ** is not confusing to the average user.
25 ** - use printk KERN_xxx level only if message is not a WARNING
26 ** but is INFO, ERR etc.
28 ** - Use printk_ratelimited() for messages which may flood
29 ** (e.g. "rx DUP pkt!").
31 ** - Use log() for messages which may be omitted (and they
32 ** _will_ be omitted in non-debug builds). Note that
33 ** message levels may be disabled at compile-time selectively,
34 ** thus select them wisely. Example: L_DEBUG is the lowest
35 ** (most likely to be compiled out) -> use for less important stuff.
37 ** - Do not print important stuff with log(), or else people
38 ** will never build non-debug driver.
41 ** hex: capital letters, zero filled (e.g. 0x02AC)
42 ** str: dont start from capitals, no trailing periods ("tx: queue is stopped")
46 void log_fn_enter(const char *funcname
);
47 void log_fn_exit(const char *funcname
);
48 void log_fn_exit_v(const char *funcname
, int v
);
50 void acx_print_mac(const char *head
, const u8
*mac
, const char *tail
);
54 if (unlikely(acx_debug & L_FUNC)) { \
55 log_fn_enter(__func__); \
61 if (unlikely(acx_debug & L_FUNC)) { \
62 log_fn_exit_v(__func__, v); \
67 if (unlikely(acx_debug & L_FUNC)) { \
68 log_fn_exit(__func__); \
74 #define FN_ENTER do {} while(0)
75 #define FN_EXIT1(v) do {} while(0)
76 #define FN_EXIT0 do {} while(0)
78 #endif /* ACX_DEBUG > 1 */
83 #define log(chan, args...) \
85 if (acx_debug & (chan)) \
88 #define printk_ratelimited(args...) printk(args)
90 #else /* Non-debug build: */
92 #define log(chan, args...)
93 /* Standard way of log flood prevention */
94 #define printk_ratelimited(args...) \
96 if (printk_ratelimit()) \
100 #endif /* ACX_DEBUG */
102 /* Optimized out to nothing in non-debug build */
104 acxlog_mac(int level
, const char *head
, const u8
*mac
, const char *tail
)
106 if (acx_debug
& level
) {
107 acx_print_mac(head
, mac
, tail
);
112 /***********************************************************************
113 ** MAC address helpers
116 MAC_COPY(u8
*mac
, const u8
*src
)
118 memcpy(mac
, src
, ETH_ALEN
);
122 MAC_FILL(u8
*mac
, u8 val
)
124 memset(mac
, val
, ETH_ALEN
);
130 ((u16
*)mac
)[2] = *(u32
*)mac
= -1;
136 ((u16
*)mac
)[2] = *(u32
*)mac
= 0;
140 mac_is_equal(const u8
*a
, const u8
*b
)
142 /* can't beat this */
143 return memcmp(a
, b
, ETH_ALEN
) == 0;
147 mac_is_bcast(const u8
*mac
)
149 /* AND together 4 first bytes with sign-extended 2 last bytes
150 ** Only bcast address gives 0xffffffff. +1 gives 0 */
151 return ( *(s32
*)mac
& ((s16
*)mac
)[2] ) + 1 == 0;
155 mac_is_zero(const u8
*mac
)
157 return ( *(u32
*)mac
| ((u16
*)mac
)[2] ) == 0;
161 mac_is_directed(const u8
*mac
)
163 return (mac
[0] & 1)==0;
167 mac_is_mcast(const u8
*mac
)
169 return (mac
[0] & 1) && !mac_is_bcast(mac
);
172 #define MACSTR "%02X:%02X:%02X:%02X:%02X:%02X"
173 #define MAC(bytevector) \
174 ((unsigned char *)bytevector)[0], \
175 ((unsigned char *)bytevector)[1], \
176 ((unsigned char *)bytevector)[2], \
177 ((unsigned char *)bytevector)[3], \
178 ((unsigned char *)bytevector)[4], \
179 ((unsigned char *)bytevector)[5]
182 /***********************************************************************
185 #define TO_STRING(x) #x
186 #define STRING(x) TO_STRING(x)
188 #define CLEAR_BIT(val, mask) ((val) &= ~(mask))
189 #define SET_BIT(val, mask) ((val) |= (mask))
190 #define CHECK_BIT(val, mask) ((val) & (mask))
192 /* undefined if v==0 */
193 static inline unsigned int
197 while (!(v
& 0xf)) { v
>>=4; n
+=4; }
198 while (!(v
& 1)) { v
>>=1; n
++; }
202 /* undefined if v==0 */
203 static inline unsigned int
207 while (v
>0xf) { v
>>=4; n
+=4; }
208 while (v
>1) { v
>>=1; n
++; }
212 /* undefined if v==0 */
214 has_only_one_bit(u16 v
)
216 return ((v
-1) ^ v
) >= v
;
221 is_hidden_essid(char *essid
)
223 return (('\0' == essid
[0]) ||
224 ((' ' == essid
[0]) && ('\0' == essid
[1])));
227 /***********************************************************************
229 ** We have adev->sem and adev->spinlock.
231 ** We employ following naming convention in order to get locking right:
233 ** acx_e_xxxx - external entry points called from process context.
234 ** It is okay to sleep. adev->sem is to be taken on entry.
235 ** acx_i_xxxx - external entry points possibly called from atomic context.
236 ** Sleeping is not allowed (and thus down(sem) is not legal!)
237 ** acx_s_xxxx - potentially sleeping functions. Do not ever call under lock!
238 ** acx_l_xxxx - functions which expect lock to be already taken.
239 ** rest - non-sleeping functions which do not require locking
240 ** but may be run under lock
242 ** A small number of local helpers do not have acx_[eisl]_ prefix.
243 ** They are always close to caller and are to be reviewed locally.
245 ** Theory of operation:
247 ** All process-context entry points (_e_ functions) take sem
248 ** immediately. IRQ handler and other 'atomic-context' entry points
249 ** (_i_ functions) take lock immediately on entry, but dont take sem
250 ** because that might sleep.
252 ** Thus *all* code is either protected by sem or lock, or both.
254 ** Code which must not run concurrently with IRQ takes lock.
255 ** Such code is marked with _l_.
257 ** This results in the following rules of thumb useful in code review:
259 ** + If a function calls _s_ fn, it must be an _s_ itself.
260 ** + You can call _l_ fn only (a) from another _l_ fn
261 ** or (b) from _s_, _e_ or _i_ fn by taking lock, calling _l_,
262 ** and dropping lock.
263 ** + All IRQ code runs under lock.
264 ** + Any _s_ fn is running under sem.
265 ** + Code under sem can race only with IRQ code.
266 ** + Code under sem+lock cannot race with anything.
269 /* These functions *must* be inline or they will break horribly on SPARC, due
270 * to its weird semantics for save/restore flags */
272 #if defined(PARANOID_LOCKING) /* Lock debugging */
274 void acx_lock_debug(acx_device_t
*adev
, const char* where
);
275 void acx_unlock_debug(acx_device_t
*adev
, const char* where
);
276 void acx_down_debug(acx_device_t
*adev
, const char* where
);
277 void acx_up_debug(acx_device_t
*adev
, const char* where
);
278 void acx_lock_unhold(void);
279 void acx_sem_unhold(void);
282 acx_lock_helper(acx_device_t
*adev
, unsigned long *fp
, const char* where
)
284 acx_lock_debug(adev
, where
);
285 spin_lock_irqsave(&adev
->spinlock
, *fp
);
288 acx_unlock_helper(acx_device_t
*adev
, unsigned long *fp
, const char* where
)
290 acx_unlock_debug(adev
, where
);
291 spin_unlock_irqrestore(&adev
->spinlock
, *fp
);
293 #define acx_lock(adev, flags) acx_lock_helper(adev, &(flags), __FILE__ ":" STRING(__LINE__))
294 #define acx_unlock(adev, flags) acx_unlock_helper(adev, &(flags), __FILE__ ":" STRING(__LINE__))
295 #define acx_sem_lock(adev) mutex_lock(&(adev)->mutex)
296 #define acx_sem_unlock(adev) mutex_unlock(&(adev)->mutex)
298 #elif defined(DO_LOCKING)
300 #define acx_lock(adev, flags) spin_lock_irqsave(&adev->spinlock, flags)
301 #define acx_unlock(adev, flags) spin_unlock_irqrestore(&adev->spinlock, flags)
302 #define acx_sem_lock(adev) mutex_lock(&(adev)->mutex)
303 #define acx_sem_unlock(adev) mutex_unlock(&(adev)->mutex)
304 #define acx_lock_unhold() ((void)0)
305 #define acx_sem_unhold() ((void)0)
307 #else /* no locking! :( */
309 #define acx_lock(adev, flags) ((void)0)
310 #define acx_unlock(adev, flags) ((void)0)
311 #define acx_sem_lock(adev) ((void)0)
312 #define acx_sem_unlock(adev) ((void)0)
313 #define acx_lock_unhold() ((void)0)
314 #define acx_sem_unhold() ((void)0)
319 /***********************************************************************
322 /* Can race with rx path (which is not protected by sem):
323 ** rx -> process_[re]assocresp() -> set_status(ASSOCIATED) -> wake_queue()
324 ** Can race with tx_complete IRQ:
325 ** IRQ -> acxpci_l_clean_txdesc -> acx_wake_queue
326 ** Review carefully all callsites */
328 acx_stop_queue(struct ieee80211_hw
*hw
, const char *msg
)
330 if (netif_queue_stopped(ndev))
333 ieee80211_stop_queues(hw
);
335 log(L_BUFT
, "acx: tx: stop queue %s\n", msg
);
339 acx_queue_stopped(struct ieee80211_hw *ieee)
341 return netif_queue_stopped(ieee);
346 acx_start_queue(struct ieee80211_hw *hw, const char *msg)
348 ieee80211_start_queues(hw);
350 log(L_BUFT, "acx: tx: start queue %s\n", msg);
354 acx_wake_queue(struct ieee80211_hw
*hw
, const char *msg
)
356 ieee80211_wake_queues(hw
);
358 log(L_BUFT
, "acx: tx: wake queue %s\n", msg
);
362 acx_carrier_off(struct net_device *ndev, const char *msg)
364 netif_carrier_off(ndev);
366 log(L_BUFT, "acx: tx: carrier off %s\n", msg);
370 acx_carrier_on(struct net_device *ndev, const char *msg)
372 netif_carrier_on(ndev);
374 log(L_BUFT, "acx: tx: carrier on %s\n", msg);
380 /***********************************************************************
381 ** Communication with firmware
383 #define CMD_TIMEOUT_MS(n) (n)
384 #define ACX_CMD_TIMEOUT_DEFAULT CMD_TIMEOUT_MS(50)
388 /* We want to log cmd names */
389 int acxpci_s_issue_cmd_timeo_debug(acx_device_t
*adev
, unsigned cmd
, void *param
, unsigned len
, unsigned timeout
, const char* cmdstr
);
390 int acxusb_s_issue_cmd_timeo_debug(acx_device_t
*adev
, unsigned cmd
, void *param
, unsigned len
, unsigned timeout
, const char* cmdstr
);
392 acx_s_issue_cmd_timeo_debug(acx_device_t
*adev
, unsigned cmd
, void *param
, unsigned len
, unsigned timeout
, const char* cmdstr
)
395 return acxpci_s_issue_cmd_timeo_debug(adev
, cmd
, param
, len
, timeout
, cmdstr
);
396 return acxusb_s_issue_cmd_timeo_debug(adev
, cmd
, param
, len
, timeout
, cmdstr
);
398 #define acx_s_issue_cmd(adev,cmd,param,len) \
399 acx_s_issue_cmd_timeo_debug(adev,cmd,param,len,ACX_CMD_TIMEOUT_DEFAULT,#cmd)
400 #define acx_s_issue_cmd_timeo(adev,cmd,param,len,timeo) \
401 acx_s_issue_cmd_timeo_debug(adev,cmd,param,len,timeo,#cmd)
402 int acx_s_configure_debug(acx_device_t
*adev
, void *pdr
, int type
, const char* str
);
403 #define acx_s_configure(adev,pdr,type) \
404 acx_s_configure_debug(adev,pdr,type,#type)
405 int acx_s_interrogate_debug(acx_device_t
*adev
, void *pdr
, int type
, const char* str
);
406 #define acx_s_interrogate(adev,pdr,type) \
407 acx_s_interrogate_debug(adev,pdr,type,#type)
411 int acxpci_s_issue_cmd_timeo(acx_device_t
*adev
, unsigned cmd
, void *param
, unsigned len
, unsigned timeout
);
412 int acxusb_s_issue_cmd_timeo(acx_device_t
*adev
, unsigned cmd
, void *param
, unsigned len
, unsigned timeout
);
414 acx_s_issue_cmd_timeo(acx_device_t
*adev
, unsigned cmd
, void *param
, unsigned len
, unsigned timeout
)
417 return acxpci_s_issue_cmd_timeo(adev
, cmd
, param
, len
, timeout
);
418 return acxusb_s_issue_cmd_timeo(adev
, cmd
, param
, len
, timeout
);
421 acx_s_issue_cmd(acx_device_t
*adev
, unsigned cmd
, void *param
, unsigned len
)
424 return acxpci_s_issue_cmd_timeo(adev
, cmd
, param
, len
, ACX_CMD_TIMEOUT_DEFAULT
);
425 return acxusb_s_issue_cmd_timeo(adev
, cmd
, param
, len
, ACX_CMD_TIMEOUT_DEFAULT
);
427 int acx_s_configure(acx_device_t
*adev
, void *pdr
, int type
);
428 int acx_s_interrogate(acx_device_t
*adev
, void *pdr
, int type
);
432 void acx_s_cmd_start_scan(acx_device_t
*adev
);
435 /***********************************************************************
439 acx111pci_ioctl_info(
440 struct net_device *ndev,
441 struct iw_request_info *info,
442 struct iw_param *vwrq,
445 acx100pci_ioctl_set_phy_amp_bias(
446 struct net_device *ndev,
447 struct iw_request_info *info,
448 struct iw_param *vwrq,
452 /***********************************************************************
455 #ifdef CONFIG_PROC_FS
456 int acx_proc_register_entries(struct ieee80211_hw
*ieee
);
457 int acx_proc_unregister_entries(struct ieee80211_hw
*ieee
);
460 acx_proc_register_entries(const struct ieee80211_hw
*ieee
) { return OK
; }
462 acx_proc_unregister_entries(const struct ieee80211_hw
*ieee
) { return OK
; }
466 /***********************************************************************
468 firmware_image_t
*acx_s_read_fw(struct device
*dev
, const char *file
, u32
*size
);
469 int acxpci_s_upload_radio(acx_device_t
*adev
);
472 /***********************************************************************
475 int acxpci_s_read_phy_reg(acx_device_t
*adev
, u32 reg
, u8
*charbuf
);
476 int acxusb_s_read_phy_reg(acx_device_t
*adev
, u32 reg
, u8
*charbuf
);
478 acx_s_read_phy_reg(acx_device_t
*adev
, u32 reg
, u8
*charbuf
)
481 return acxpci_s_read_phy_reg(adev
, reg
, charbuf
);
482 return acxusb_s_read_phy_reg(adev
, reg
, charbuf
);
485 int acxpci_s_write_phy_reg(acx_device_t
*adev
, u32 reg
, u8 value
);
486 int acxusb_s_write_phy_reg(acx_device_t
*adev
, u32 reg
, u8 value
);
488 acx_s_write_phy_reg(acx_device_t
*adev
, u32 reg
, u8 value
)
491 return acxpci_s_write_phy_reg(adev
, reg
, value
);
492 return acxusb_s_write_phy_reg(adev
, reg
, value
);
495 tx_t
* acxpci_l_alloc_tx(acx_device_t
*adev
);
496 tx_t
* acxusb_l_alloc_tx(acx_device_t
*adev
);
498 acx_l_alloc_tx(acx_device_t
*adev
)
501 return acxpci_l_alloc_tx(adev
);
502 return acxusb_l_alloc_tx(adev
);
505 void acxusb_l_dealloc_tx(tx_t
*tx_opaque
);
507 acx_l_dealloc_tx(acx_device_t
*adev
, tx_t
*tx_opaque
)
510 acxusb_l_dealloc_tx(tx_opaque
);
513 void* acxpci_l_get_txbuf(acx_device_t
*adev
, tx_t
*tx_opaque
);
514 void* acxusb_l_get_txbuf(acx_device_t
*adev
, tx_t
*tx_opaque
);
516 acx_l_get_txbuf(acx_device_t
*adev
, tx_t
*tx_opaque
)
519 return acxpci_l_get_txbuf(adev
, tx_opaque
);
520 return acxusb_l_get_txbuf(adev
, tx_opaque
);
523 void acxpci_l_tx_data(acx_device_t
*adev
, tx_t
*tx_opaque
, int len
,
524 struct ieee80211_tx_control
*ieeectl
, struct sk_buff
*skb
);
525 void acxusb_l_tx_data(acx_device_t
*adev
, tx_t
*tx_opaque
, int len
, struct ieee80211_tx_control
*ieeectl
,
526 struct sk_buff
*skb
);
528 acx_l_tx_data(acx_device_t
*adev
, tx_t
*tx_opaque
, int len
,
529 struct ieee80211_tx_control
*ieeectl
, struct sk_buff
*skb
)
532 acxpci_l_tx_data(adev
, tx_opaque
, len
, ieeectl
,skb
);
534 acxusb_l_tx_data(adev
, tx_opaque
, len
, ieeectl
,skb
);
537 static inline struct ieee80211_hdr
*
538 acx_get_wlan_hdr(acx_device_t
*adev
, const rxbuffer_t
*rxbuf
)
540 return (struct ieee80211_hdr
*)((u8
*)&rxbuf
->hdr_a3
+ adev
->phy_header_len
);
542 void acxpci_l_power_led(acx_device_t
*adev
, int enable
);
543 int acxpci_read_eeprom_byte(acx_device_t
*adev
, u32 addr
, u8
*charbuf
);
544 unsigned int acxpci_l_clean_txdesc(acx_device_t
*adev
);
545 void acxpci_l_clean_txdesc_emergency(acx_device_t
*adev
);
546 int acxpci_s_create_hostdesc_queues(acx_device_t
*adev
);
547 void acxpci_create_desc_queues(acx_device_t
*adev
, u32 tx_queue_start
, u32 rx_queue_start
);
548 void acxpci_free_desc_queues(acx_device_t
*adev
);
549 char* acxpci_s_proc_diag_output(char *p
, acx_device_t
*adev
);
550 int acxpci_proc_eeprom_output(char *p
, acx_device_t
*adev
);
551 void acxpci_set_interrupt_mask(acx_device_t
*adev
);
552 int acx100pci_s_set_tx_level(acx_device_t
*adev
, u8 level_dbm
);
554 void acx_s_mwait(int ms
);
555 int acx_s_init_mac(acx_device_t
*adev
);
556 void acx_set_reg_domain(acx_device_t
*adev
, unsigned char reg_dom_id
);
557 void acx_update_capabilities(acx_device_t
*adev
);
558 void acx_s_start(acx_device_t
*adev
);
560 void acx_s_update_card_settings(acx_device_t
*adev
);
561 void acx_s_parse_configoption(acx_device_t
*adev
, const acx111_ie_configoption_t
*pcfg
);
562 void acx_l_update_ratevector(acx_device_t
*adev
);
564 void acx_init_task_scheduler(acx_device_t
*adev
);
565 void acx_schedule_task(acx_device_t
*adev
, unsigned int set_flag
);
567 int acx_e_ioctl_old(struct net_device
*ndev
, struct ifreq
*ifr
, int cmd
);
569 client_t
*acx_l_sta_list_get(acx_device_t
*adev
, const u8
*address
);
570 void acx_l_sta_list_del(acx_device_t
*adev
, client_t
*clt
);
572 void acx_i_timer(unsigned long a
);
574 struct sk_buff
*acx_rxbuf_to_ether(acx_device_t
*adev
, rxbuffer_t
*rxbuf
);
575 int acx_ether_to_txbuf(acx_device_t
*adev
, void *txbuf
, const struct sk_buff
*skb
);
577 u8
acx_signal_determine_quality(u8 signal
, u8 noise
);
579 void acx_l_process_rxbuf(acx_device_t
*adev
, rxbuffer_t
*rxbuf
);
580 void acx_l_handle_txrate_auto(acx_device_t
*adev
, struct client
*txc
,
581 u16 intended_rate
, u8 rate100
, u16 rate111
, u8 error
,
584 void acx_dump_bytes(const void *, int);
586 u8
acx_rate111to100(u16
);
588 void acx_s_set_defaults(acx_device_t
*adev
);
591 static inline const char* acx_get_packet_type_string(u16 fc
) { return ""; }
593 const char* acx_get_packet_type_string(u16 fc
);
595 const char* acx_cmd_status_str(unsigned int state
);
597 /*** Devicescape functions ***/
598 int acx_setup_modes(acx_device_t
*adev
);
599 void acx_free_modes(acx_device_t
*adev
);
600 int acx_i_start_xmit(struct ieee80211_hw
* ieee
,
602 struct ieee80211_tx_control
*ctl
);
603 int acx_add_interface(struct ieee80211_hw
* ieee
,
604 struct ieee80211_if_init_conf
*conf
);
605 void acx_remove_interface(struct ieee80211_hw
* ieee
,
606 struct ieee80211_if_init_conf
*conf
);
607 int acx_net_reset(struct ieee80211_hw
* ieee
);
608 int acx_net_set_key(struct ieee80211_hw
*hw
,
609 enum set_key_cmd cmd
,
610 const u8
*local_addr
, const u8
*addr
,
611 struct ieee80211_key_conf
*key
);
613 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
614 extern int acx_config_interface(struct ieee80211_hw
* ieee
,
615 struct ieee80211_vif
*vif
,
616 struct ieee80211_if_conf
*conf
);
618 int acx_config_interface(struct ieee80211_hw
* ieee
, int if_id
,
619 struct ieee80211_if_conf
*conf
);
622 int acx_net_config(struct ieee80211_hw
* ieee
, struct ieee80211_conf
*conf
);
623 int acx_net_get_tx_stats(struct ieee80211_hw
* ieee
, struct ieee80211_tx_queue_stats
*stats
);
624 int acx_net_conf_tx(struct ieee80211_hw
* ieee
, int queue
,
625 const struct ieee80211_tx_queue_params
*params
);
626 //int acx_passive_scan(struct net_device *net_dev, int state, struct ieee80211_scan_conf *conf);
627 //static void acx_netdev_init(struct net_device *ndev);
628 int acxpci_s_reset_dev(acx_device_t
*adev
);
629 void acx_e_after_interrupt_task(struct work_struct
* work
);
630 void acx_i_set_multicast_list(struct ieee80211_hw
*hw
,
631 unsigned int changed_flags
,
632 unsigned int *total_flags
,
633 int mc_count
, struct dev_addr_list
*mc_list
);
635 /*** End DeviceScape Functions **/
637 void great_inquisitor(acx_device_t
*adev
);
639 void acx_s_get_firmware_version(acx_device_t
*adev
);
640 void acx_display_hardware_details(acx_device_t
*adev
);
642 int acx_e_change_mtu(struct ieee80211_hw
*hw
, int mtu
);
643 int acx_e_get_stats(struct ieee80211_hw
*hw
, struct ieee80211_low_level_stats
*stats
);
644 struct iw_statistics
* acx_e_get_wireless_stats(struct ieee80211_hw
*hw
);
645 void acx_interrupt_tasklet(struct work_struct
*work
);
647 int __init
acxpci_e_init_module(void);
648 int __init
acxusb_e_init_module(void);
649 void __exit
acxpci_e_cleanup_module(void);
650 void __exit
acxusb_e_cleanup_module(void);
652 #endif /* _ACX_FUNC_H_ */