/* SPDX-License-Identifier: GPL-2.0-or-later */
|
/*
|
Copyright (C) 2004 - 2009 Ivo van Doorn <IvDoorn@gmail.com>
|
<http://rt2x00.serialmonkey.com>
|
|
*/
|
|
/*
|
Module: rt2x00
|
Abstract: rt2x00 generic register information.
|
*/
|
|
#ifndef RT2X00REG_H
|
#define RT2X00REG_H
|
|
/*
|
* RX crypto status
|
*/
|
enum rx_crypto {
|
RX_CRYPTO_SUCCESS = 0,
|
RX_CRYPTO_FAIL_ICV = 1,
|
RX_CRYPTO_FAIL_MIC = 2,
|
RX_CRYPTO_FAIL_KEY = 3,
|
};
|
|
/*
|
* Antenna values
|
*/
|
enum antenna {
|
ANTENNA_SW_DIVERSITY = 0,
|
ANTENNA_A = 1,
|
ANTENNA_B = 2,
|
ANTENNA_HW_DIVERSITY = 3,
|
};
|
|
/*
|
* Led mode values.
|
*/
|
enum led_mode {
|
LED_MODE_DEFAULT = 0,
|
LED_MODE_TXRX_ACTIVITY = 1,
|
LED_MODE_SIGNAL_STRENGTH = 2,
|
LED_MODE_ASUS = 3,
|
LED_MODE_ALPHA = 4,
|
};
|
|
/*
|
* TSF sync values
|
*/
|
enum tsf_sync {
|
TSF_SYNC_NONE = 0,
|
TSF_SYNC_INFRA = 1,
|
TSF_SYNC_ADHOC = 2,
|
TSF_SYNC_AP_NONE = 3,
|
};
|
|
/*
|
* Device states
|
*/
|
enum dev_state {
|
STATE_DEEP_SLEEP = 0,
|
STATE_SLEEP = 1,
|
STATE_STANDBY = 2,
|
STATE_AWAKE = 3,
|
|
/*
|
* Additional device states, these values are
|
* not strict since they are not directly passed
|
* into the device.
|
*/
|
STATE_RADIO_ON,
|
STATE_RADIO_OFF,
|
STATE_RADIO_IRQ_ON,
|
STATE_RADIO_IRQ_OFF,
|
};
|
|
/*
|
* IFS backoff values
|
*/
|
enum ifs {
|
IFS_BACKOFF = 0,
|
IFS_SIFS = 1,
|
IFS_NEW_BACKOFF = 2,
|
IFS_NONE = 3,
|
};
|
|
/*
|
* IFS backoff values for HT devices
|
*/
|
enum txop {
|
TXOP_HTTXOP = 0,
|
TXOP_PIFS = 1,
|
TXOP_SIFS = 2,
|
TXOP_BACKOFF = 3,
|
};
|
|
/*
|
* Cipher types for hardware encryption
|
*/
|
enum cipher {
|
CIPHER_NONE = 0,
|
CIPHER_WEP64 = 1,
|
CIPHER_WEP128 = 2,
|
CIPHER_TKIP = 3,
|
CIPHER_AES = 4,
|
/*
|
* The following fields were added by rt61pci and rt73usb.
|
*/
|
CIPHER_CKIP64 = 5,
|
CIPHER_CKIP128 = 6,
|
CIPHER_TKIP_NO_MIC = 7, /* Don't send to device */
|
|
/*
|
* Max cipher type.
|
* Note that CIPHER_NONE isn't counted, and CKIP64 and CKIP128
|
* are excluded due to limitations in mac80211.
|
*/
|
CIPHER_MAX = 4,
|
};
|
|
/*
|
* Rate modulations
|
*/
|
enum rate_modulation {
|
RATE_MODE_CCK = 0,
|
RATE_MODE_OFDM = 1,
|
RATE_MODE_HT_MIX = 2,
|
RATE_MODE_HT_GREENFIELD = 3,
|
};
|
|
/*
|
* Firmware validation error codes
|
*/
|
enum firmware_errors {
|
FW_OK,
|
FW_BAD_CRC,
|
FW_BAD_LENGTH,
|
FW_BAD_VERSION,
|
};
|
|
/*
|
* Register handlers.
|
* We store the position of a register field inside a field structure,
|
* This will simplify the process of setting and reading a certain field
|
* inside the register while making sure the process remains byte order safe.
|
*/
|
struct rt2x00_field8 {
|
u8 bit_offset;
|
u8 bit_mask;
|
};
|
|
struct rt2x00_field16 {
|
u16 bit_offset;
|
u16 bit_mask;
|
};
|
|
struct rt2x00_field32 {
|
u32 bit_offset;
|
u32 bit_mask;
|
};
|
|
/*
|
* Power of two check, this will check
|
* if the mask that has been given contains and contiguous set of bits.
|
* Note that we cannot use the is_power_of_2() function since this
|
* check must be done at compile-time.
|
*/
|
#define is_power_of_two(x) ( !((x) & ((x)-1)) )
|
#define low_bit_mask(x) ( ((x)-1) & ~(x) )
|
#define is_valid_mask(x) is_power_of_two(1LU + (x) + low_bit_mask(x))
|
|
/*
|
* Macros to find first set bit in a variable.
|
* These macros behave the same as the __ffs() functions but
|
* the most important difference that this is done during
|
* compile-time rather then run-time.
|
*/
|
#define compile_ffs2(__x) \
|
__builtin_choose_expr(((__x) & 0x1), 0, 1)
|
|
#define compile_ffs4(__x) \
|
__builtin_choose_expr(((__x) & 0x3), \
|
(compile_ffs2((__x))), \
|
(compile_ffs2((__x) >> 2) + 2))
|
|
#define compile_ffs8(__x) \
|
__builtin_choose_expr(((__x) & 0xf), \
|
(compile_ffs4((__x))), \
|
(compile_ffs4((__x) >> 4) + 4))
|
|
#define compile_ffs16(__x) \
|
__builtin_choose_expr(((__x) & 0xff), \
|
(compile_ffs8((__x))), \
|
(compile_ffs8((__x) >> 8) + 8))
|
|
#define compile_ffs32(__x) \
|
__builtin_choose_expr(((__x) & 0xffff), \
|
(compile_ffs16((__x))), \
|
(compile_ffs16((__x) >> 16) + 16))
|
|
/*
|
* This macro will check the requirements for the FIELD{8,16,32} macros
|
* The mask should be a constant non-zero contiguous set of bits which
|
* does not exceed the given typelimit.
|
*/
|
#define FIELD_CHECK(__mask, __type) \
|
BUILD_BUG_ON(!(__mask) || \
|
!is_valid_mask(__mask) || \
|
(__mask) != (__type)(__mask)) \
|
|
#define FIELD8(__mask) \
|
({ \
|
FIELD_CHECK(__mask, u8); \
|
(struct rt2x00_field8) { \
|
compile_ffs8(__mask), (__mask) \
|
}; \
|
})
|
|
#define FIELD16(__mask) \
|
({ \
|
FIELD_CHECK(__mask, u16); \
|
(struct rt2x00_field16) { \
|
compile_ffs16(__mask), (__mask) \
|
}; \
|
})
|
|
#define FIELD32(__mask) \
|
({ \
|
FIELD_CHECK(__mask, u32); \
|
(struct rt2x00_field32) { \
|
compile_ffs32(__mask), (__mask) \
|
}; \
|
})
|
|
#define SET_FIELD(__reg, __type, __field, __value)\
|
({ \
|
typecheck(__type, __field); \
|
*(__reg) &= ~((__field).bit_mask); \
|
*(__reg) |= ((__value) << \
|
((__field).bit_offset)) & \
|
((__field).bit_mask); \
|
})
|
|
#define GET_FIELD(__reg, __type, __field) \
|
({ \
|
typecheck(__type, __field); \
|
((__reg) & ((__field).bit_mask)) >> \
|
((__field).bit_offset); \
|
})
|
|
#define rt2x00_set_field32(__reg, __field, __value) \
|
SET_FIELD(__reg, struct rt2x00_field32, __field, __value)
|
#define rt2x00_get_field32(__reg, __field) \
|
GET_FIELD(__reg, struct rt2x00_field32, __field)
|
|
#define rt2x00_set_field16(__reg, __field, __value) \
|
SET_FIELD(__reg, struct rt2x00_field16, __field, __value)
|
#define rt2x00_get_field16(__reg, __field) \
|
GET_FIELD(__reg, struct rt2x00_field16, __field)
|
|
#define rt2x00_set_field8(__reg, __field, __value) \
|
SET_FIELD(__reg, struct rt2x00_field8, __field, __value)
|
#define rt2x00_get_field8(__reg, __field) \
|
GET_FIELD(__reg, struct rt2x00_field8, __field)
|
|
#endif /* RT2X00REG_H */
|
