[mirror_ubuntu-hirsute-kernel.git] / drivers / net / wireless / realtek / rtl818x / rtl8187 / rtl8187.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Definitions for RTL8187 hardware
 *
 * Copyright 2007 Michael Wu <flamingice@sourmilk.net>
 * Copyright 2007 Andrea Merello <andrea.merello@gmail.com>
 *
 * Based on the r8187 driver, which is:
 * Copyright 2005 Andrea Merello <andrea.merello@gmail.com>, et al.
 */

#ifndef RTL8187_H
#define RTL8187_H

#include <linux/cache.h>

#include "rtl818x.h"
#include "leds.h"

#define RTL8187_EEPROM_TXPWR_BASE	0x05
#define RTL8187_EEPROM_MAC_ADDR		0x07
#define RTL8187_EEPROM_TXPWR_CHAN_1	0x16	/* 3 channels */
#define RTL8187_EEPROM_TXPWR_CHAN_6	0x1B	/* 2 channels */
#define RTL8187_EEPROM_TXPWR_CHAN_4	0x3D	/* 2 channels */
#define RTL8187_EEPROM_SELECT_GPIO	0x3B

#define RTL8187_REQT_READ	0xC0
#define RTL8187_REQT_WRITE	0x40
#define RTL8187_REQ_GET_REG	0x05
#define RTL8187_REQ_SET_REG	0x05

#define RTL8187_MAX_RX		0x9C4

#define RFKILL_MASK_8187_89_97	0x2
#define RFKILL_MASK_8198	0x4

#define RETRY_COUNT		7

struct rtl8187_rx_info {
	struct urb *urb;
	struct ieee80211_hw *dev;
};

struct rtl8187_rx_hdr {
	__le32 flags;
	u8 noise;
	u8 signal;
	u8 agc;
	u8 reserved;
	__le64 mac_time;
} __packed;

struct rtl8187b_rx_hdr {
	__le32 flags;
	__le64 mac_time;
	u8 sq;
	u8 rssi;
	u8 agc;
	u8 flags2;
	__le16 snr_long2end;
	s8 pwdb_g12;
	u8 fot;
} __packed;

/* {rtl8187,rtl8187b}_tx_info is in skb */

struct rtl8187_tx_hdr {
	__le32 flags;
	__le16 rts_duration;
	__le16 len;
	__le32 retry;
} __packed;

struct rtl8187b_tx_hdr {
	__le32 flags;
	__le16 rts_duration;
	__le16 len;
	__le32 unused_1;
	__le16 unused_2;
	__le16 tx_duration;
	__le32 unused_3;
	__le32 retry;
	__le32 unused_4[2];
} __packed;

enum {
	DEVICE_RTL8187,
	DEVICE_RTL8187B
};

struct rtl8187_vif {
	struct ieee80211_hw *dev;

	/* beaconing */
	struct delayed_work beacon_work;
	bool enable_beacon;
};

struct rtl8187_priv {
	/* common between rtl818x drivers */
	struct rtl818x_csr *map;
	const struct rtl818x_rf_ops *rf;
	struct ieee80211_vif *vif;

	/* The mutex protects the TX loopback state.
	 * Any attempt to set channels concurrently locks the device.
	 */
	struct mutex conf_mutex;

	/* rtl8187 specific */
	struct ieee80211_channel channels[14];
	struct ieee80211_rate rates[12];
	struct ieee80211_supported_band band;
	struct usb_device *udev;
	u32 rx_conf;
	struct usb_anchor anchored;
	struct delayed_work work;
	struct ieee80211_hw *dev;
#ifdef CONFIG_RTL8187_LEDS
	struct rtl8187_led led_radio;
	struct rtl8187_led led_tx;
	struct rtl8187_led led_rx;
	struct delayed_work led_on;
	struct delayed_work led_off;
#endif
	u16 txpwr_base;
	u8 asic_rev;
	u8 is_rtl8187b;
	enum {
		RTL8187BvB,
		RTL8187BvD,
		RTL8187BvE
	} hw_rev;
	struct sk_buff_head rx_queue;
	u8 signal;
	u8 noise;
	u8 slot_time;
	u8 aifsn[4];
	u8 rfkill_mask;
	struct {
		union {
			__le64 buf;
			u8 dummy1[L1_CACHE_BYTES];
		} ____cacheline_aligned;
		struct sk_buff_head queue;
	} b_tx_status; /* This queue is used by both -b and non-b devices */
	struct mutex io_mutex;
	union {
		u8 bits8;
		__le16 bits16;
		__le32 bits32;
		u8 dummy2[L1_CACHE_BYTES];
	} *io_dmabuf ____cacheline_aligned;
	bool rfkill_off;
	u16 seqno;
};

void rtl8187_write_phy(struct ieee80211_hw *dev, u8 addr, u32 data);

u8 rtl818x_ioread8_idx(struct rtl8187_priv *priv,
				u8 *addr, u8 idx);

static inline u8 rtl818x_ioread8(struct rtl8187_priv *priv, u8 *addr)
{
	return rtl818x_ioread8_idx(priv, addr, 0);
}

u16 rtl818x_ioread16_idx(struct rtl8187_priv *priv,
				__le16 *addr, u8 idx);

static inline u16 rtl818x_ioread16(struct rtl8187_priv *priv, __le16 *addr)
{
	return rtl818x_ioread16_idx(priv, addr, 0);
}

u32 rtl818x_ioread32_idx(struct rtl8187_priv *priv,
				__le32 *addr, u8 idx);

static inline u32 rtl818x_ioread32(struct rtl8187_priv *priv, __le32 *addr)
{
	return rtl818x_ioread32_idx(priv, addr, 0);
}

void rtl818x_iowrite8_idx(struct rtl8187_priv *priv,
				u8 *addr, u8 val, u8 idx);

static inline void rtl818x_iowrite8(struct rtl8187_priv *priv, u8 *addr, u8 val)
{
	rtl818x_iowrite8_idx(priv, addr, val, 0);
}

void rtl818x_iowrite16_idx(struct rtl8187_priv *priv,
				__le16 *addr, u16 val, u8 idx);

static inline void rtl818x_iowrite16(struct rtl8187_priv *priv, __le16 *addr,
				     u16 val)
{
	rtl818x_iowrite16_idx(priv, addr, val, 0);
}

void rtl818x_iowrite32_idx(struct rtl8187_priv *priv,
				__le32 *addr, u32 val, u8 idx);

static inline void rtl818x_iowrite32(struct rtl8187_priv *priv, __le32 *addr,
				     u32 val)
{
	rtl818x_iowrite32_idx(priv, addr, val, 0);
}

#endif /* RTL8187_H */
Commit	Line	Data
d2912cb1	1	/* SPDX-License-Identifier: GPL-2.0-only */
0aec00ae JL	2	/*
	3	* Definitions for RTL8187 hardware
	4	*
	5	* Copyright 2007 Michael Wu <flamingice@sourmilk.net>
93ba2a85	6	* Copyright 2007 Andrea Merello <andrea.merello@gmail.com>
0aec00ae JL	7	*
0aec00ae JL	8	* Based on the r8187 driver, which is:
93ba2a85	9	* Copyright 2005 Andrea Merello <andrea.merello@gmail.com>, et al.
0aec00ae JL	10	*/
0aec00ae JL	11
605bebe2 MW	12	#ifndef RTL8187_H
	13	#define RTL8187_H
	14
b6213e41 SG	15	#include <linux/cache.h>
b6213e41 SG	16
605bebe2	17	#include "rtl818x.h"
3cfeb0c3	18	#include "leds.h"
605bebe2 MW	19
	20	#define RTL8187_EEPROM_TXPWR_BASE 0x05
	21	#define RTL8187_EEPROM_MAC_ADDR 0x07
	22	#define RTL8187_EEPROM_TXPWR_CHAN_1 0x16 /* 3 channels */
	23	#define RTL8187_EEPROM_TXPWR_CHAN_6 0x1B /* 2 channels */
	24	#define RTL8187_EEPROM_TXPWR_CHAN_4 0x3D /* 2 channels */
70d57139	25	#define RTL8187_EEPROM_SELECT_GPIO 0x3B
605bebe2 MW	26
	27	#define RTL8187_REQT_READ 0xC0
	28	#define RTL8187_REQT_WRITE 0x40
	29	#define RTL8187_REQ_GET_REG 0x05
	30	#define RTL8187_REQ_SET_REG 0x05
	31
	32	#define RTL8187_MAX_RX 0x9C4
	33
70d57139 LF	34	#define RFKILL_MASK_8187_89_97 0x2
	35	#define RFKILL_MASK_8198 0x4
	36
6410db59 LF	37	#define RETRY_COUNT 7
6410db59 LF	38
605bebe2 MW	39	struct rtl8187_rx_info {
	40	struct urb *urb;
	41	struct ieee80211_hw *dev;
	42	};
	43
	44	struct rtl8187_rx_hdr {
4150c572	45	__le32 flags;
605bebe2 MW	46	u8 noise;
	47	u8 signal;
	48	u8 agc;
	49	u8 reserved;
	50	__le64 mac_time;
ba2d3587	51	} __packed;
605bebe2	52
c44ac0b9	53	struct rtl8187b_rx_hdr {
605bebe2	54	__le32 flags;
c44ac0b9	55	__le64 mac_time;
0ccd58fc LF	56	u8 sq;
0ccd58fc LF	57	u8 rssi;
c44ac0b9	58	u8 agc;
0ccd58fc LF	59	u8 flags2;
	60	__le16 snr_long2end;
	61	s8 pwdb_g12;
	62	u8 fot;
ba2d3587	63	} __packed;
c44ac0b9 HTL	64
	65	/* {rtl8187,rtl8187b}_tx_info is in skb */
	66
c44ac0b9 HTL	67	struct rtl8187_tx_hdr {
c44ac0b9 HTL	68	__le32 flags;
605bebe2 MW	69	__le16 rts_duration;
	70	__le16 len;
	71	__le32 retry;
ba2d3587	72	} __packed;
605bebe2	73
c44ac0b9 HTL	74	struct rtl8187b_tx_hdr {
	75	__le32 flags;
	76	__le16 rts_duration;
	77	__le16 len;
	78	__le32 unused_1;
	79	__le16 unused_2;
	80	__le16 tx_duration;
	81	__le32 unused_3;
	82	__le32 retry;
	83	__le32 unused_4[2];
ba2d3587	84	} __packed;
c44ac0b9 HTL	85
	86	enum {
	87	DEVICE_RTL8187,
	88	DEVICE_RTL8187B
	89	};
	90
41b58f18 AF	91	struct rtl8187_vif {
	92	struct ieee80211_hw *dev;
	93
	94	/* beaconing */
	95	struct delayed_work beacon_work;
	96	bool enable_beacon;
	97	};
	98
605bebe2 MW	99	struct rtl8187_priv {
	100	/* common between rtl818x drivers */
	101	struct rtl818x_csr *map;
f6532111	102	const struct rtl818x_rf_ops *rf;
32bfd35d	103	struct ieee80211_vif *vif;
d30506e0	104
7dcdd073 LF	105	/* The mutex protects the TX loopback state.
	106	* Any attempt to set channels concurrently locks the device.
	107	*/
	108	struct mutex conf_mutex;
605bebe2 MW	109
	110	/* rtl8187 specific */
	111	struct ieee80211_channel channels[14];
	112	struct ieee80211_rate rates[12];
8318d78a	113	struct ieee80211_supported_band band;
605bebe2	114	struct usb_device *udev;
4150c572	115	u32 rx_conf;
c1db52b9	116	struct usb_anchor anchored;
2f47690e LF	117	struct delayed_work work;
2f47690e LF	118	struct ieee80211_hw *dev;
a027087a	119	#ifdef CONFIG_RTL8187_LEDS
49d7590c	120	struct rtl8187_led led_radio;
a027087a LF	121	struct rtl8187_led led_tx;
	122	struct rtl8187_led led_rx;
	123	struct delayed_work led_on;
	124	struct delayed_work led_off;
	125	#endif
605bebe2 MW	126	u16 txpwr_base;
605bebe2 MW	127	u8 asic_rev;
c44ac0b9 HTL	128	u8 is_rtl8187b;
	129	enum {
	130	RTL8187BvB,
	131	RTL8187BvD,
	132	RTL8187BvE
	133	} hw_rev;
605bebe2	134	struct sk_buff_head rx_queue;
c44ac0b9	135	u8 signal;
c44ac0b9	136	u8 noise;
b4572a92 HRK	137	u8 slot_time;
b4572a92 HRK	138	u8 aifsn[4];
70d57139	139	u8 rfkill_mask;
3517afde	140	struct {
b6213e41 SG	141	union {
	142	__le64 buf;
	143	u8 dummy1[L1_CACHE_BYTES];
	144	} ____cacheline_aligned;
3517afde	145	struct sk_buff_head queue;
2f47690e	146	} b_tx_status; /* This queue is used by both -b and non-b devices */
9be6f0d4 JL	147	struct mutex io_mutex;
	148	union {
	149	u8 bits8;
	150	__le16 bits16;
	151	__le32 bits32;
b6213e41 SG	152	u8 dummy2[L1_CACHE_BYTES];
b6213e41 SG	153	} *io_dmabuf ____cacheline_aligned;
ca9152e3	154	bool rfkill_off;
41b58f18	155	u16 seqno;
605bebe2 MW	156	};
	157
	158	void rtl8187_write_phy(struct ieee80211_hw *dev, u8 addr, u32 data);
	159
aae555d3 DV	160	u8 rtl818x_ioread8_idx(struct rtl8187_priv *priv,
aae555d3 DV	161	u8 *addr, u8 idx);
605bebe2	162
c44ac0b9 HTL	163	static inline u8 rtl818x_ioread8(struct rtl8187_priv priv, u8 addr)
	164	{
	165	return rtl818x_ioread8_idx(priv, addr, 0);
	166	}
	167
aae555d3 DV	168	u16 rtl818x_ioread16_idx(struct rtl8187_priv *priv,
aae555d3 DV	169	__le16 *addr, u8 idx);
605bebe2	170
c44ac0b9 HTL	171	static inline u16 rtl818x_ioread16(struct rtl8187_priv priv, __le16 addr)
	172	{
	173	return rtl818x_ioread16_idx(priv, addr, 0);
	174	}
	175
aae555d3 DV	176	u32 rtl818x_ioread32_idx(struct rtl8187_priv *priv,
aae555d3 DV	177	__le32 *addr, u8 idx);
605bebe2	178
c44ac0b9 HTL	179	static inline u32 rtl818x_ioread32(struct rtl8187_priv priv, __le32 addr)
	180	{
	181	return rtl818x_ioread32_idx(priv, addr, 0);
	182	}
	183
aae555d3 DV	184	void rtl818x_iowrite8_idx(struct rtl8187_priv *priv,
aae555d3 DV	185	u8 *addr, u8 val, u8 idx);
c44ac0b9 HTL	186
	187	static inline void rtl818x_iowrite8(struct rtl8187_priv priv, u8 addr, u8 val)
	188	{
	189	rtl818x_iowrite8_idx(priv, addr, val, 0);
605bebe2 MW	190	}
605bebe2 MW	191
aae555d3 DV	192	void rtl818x_iowrite16_idx(struct rtl8187_priv *priv,
aae555d3 DV	193	__le16 *addr, u16 val, u8 idx);
605bebe2	194
c44ac0b9 HTL	195	static inline void rtl818x_iowrite16(struct rtl8187_priv priv, __le16 addr,
	196	u16 val)
	197	{
	198	rtl818x_iowrite16_idx(priv, addr, val, 0);
	199	}
	200
aae555d3 DV	201	void rtl818x_iowrite32_idx(struct rtl8187_priv *priv,
aae555d3 DV	202	__le32 *addr, u32 val, u8 idx);
c44ac0b9 HTL	203
	204	static inline void rtl818x_iowrite32(struct rtl8187_priv priv, __le32 addr,
	205	u32 val)
	206	{
	207	rtl818x_iowrite32_idx(priv, addr, val, 0);
605bebe2 MW	208	}
	209
	210	#endif /* RTL8187_H */