Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Copyright (c) 2014 - 2017 Jes Sorensen <Jes.Sorensen@gmail.com>
0004  *
0005  * Register definitions taken from original Realtek rtl8723au driver
0006  */
0007 
0008 #include <asm/byteorder.h>
0009 
0010 #define RTL8XXXU_DEBUG_REG_WRITE    0x01
0011 #define RTL8XXXU_DEBUG_REG_READ     0x02
0012 #define RTL8XXXU_DEBUG_RFREG_WRITE  0x04
0013 #define RTL8XXXU_DEBUG_RFREG_READ   0x08
0014 #define RTL8XXXU_DEBUG_CHANNEL      0x10
0015 #define RTL8XXXU_DEBUG_TX       0x20
0016 #define RTL8XXXU_DEBUG_TX_DUMP      0x40
0017 #define RTL8XXXU_DEBUG_RX       0x80
0018 #define RTL8XXXU_DEBUG_RX_DUMP      0x100
0019 #define RTL8XXXU_DEBUG_USB      0x200
0020 #define RTL8XXXU_DEBUG_KEY      0x400
0021 #define RTL8XXXU_DEBUG_H2C      0x800
0022 #define RTL8XXXU_DEBUG_ACTION       0x1000
0023 #define RTL8XXXU_DEBUG_EFUSE        0x2000
0024 #define RTL8XXXU_DEBUG_INTERRUPT    0x4000
0025 
0026 #define RTW_USB_CONTROL_MSG_TIMEOUT 500
0027 #define RTL8XXXU_MAX_REG_POLL       500
0028 #define USB_INTR_CONTENT_LENGTH     56
0029 
0030 #define RTL8XXXU_OUT_ENDPOINTS      4
0031 
0032 #define REALTEK_USB_READ        0xc0
0033 #define REALTEK_USB_WRITE       0x40
0034 #define REALTEK_USB_CMD_REQ     0x05
0035 #define REALTEK_USB_CMD_IDX     0x00
0036 
0037 #define TX_TOTAL_PAGE_NUM       0xf8
0038 #define TX_TOTAL_PAGE_NUM_8192E     0xf3
0039 #define TX_TOTAL_PAGE_NUM_8723B     0xf7
0040 /* (HPQ + LPQ + NPQ + PUBQ) = TX_TOTAL_PAGE_NUM */
0041 #define TX_PAGE_NUM_PUBQ        0xe7
0042 #define TX_PAGE_NUM_HI_PQ       0x0c
0043 #define TX_PAGE_NUM_LO_PQ       0x02
0044 #define TX_PAGE_NUM_NORM_PQ     0x02
0045 
0046 #define TX_PAGE_NUM_PUBQ_8192E      0xe7
0047 #define TX_PAGE_NUM_HI_PQ_8192E     0x08
0048 #define TX_PAGE_NUM_LO_PQ_8192E     0x0c
0049 #define TX_PAGE_NUM_NORM_PQ_8192E   0x00
0050 
0051 #define TX_PAGE_NUM_PUBQ_8723B      0xe7
0052 #define TX_PAGE_NUM_HI_PQ_8723B     0x0c
0053 #define TX_PAGE_NUM_LO_PQ_8723B     0x02
0054 #define TX_PAGE_NUM_NORM_PQ_8723B   0x02
0055 
0056 #define RTL_FW_PAGE_SIZE        4096
0057 #define RTL8XXXU_FIRMWARE_POLL_MAX  1000
0058 
0059 #define RTL8723A_CHANNEL_GROUPS     3
0060 #define RTL8723A_MAX_RF_PATHS       2
0061 #define RTL8723B_CHANNEL_GROUPS     6
0062 #define RTL8723B_TX_COUNT       4
0063 #define RTL8723B_MAX_RF_PATHS       4
0064 #define RTL8XXXU_MAX_CHANNEL_GROUPS 6
0065 #define RF6052_MAX_TX_PWR       0x3f
0066 
0067 #define EFUSE_MAP_LEN           512
0068 #define EFUSE_MAX_SECTION_8723A     64
0069 #define EFUSE_REAL_CONTENT_LEN_8723A    512
0070 #define EFUSE_BT_MAP_LEN_8723A      1024
0071 #define EFUSE_MAX_WORD_UNIT     4
0072 
0073 enum rtl8xxxu_rtl_chip {
0074     RTL8192S = 0x81920,
0075     RTL8191S = 0x81910,
0076     RTL8192C = 0x8192c,
0077     RTL8191C = 0x8191c,
0078     RTL8188C = 0x8188c,
0079     RTL8188R = 0x81889,
0080     RTL8192D = 0x8192d,
0081     RTL8723A = 0x8723a,
0082     RTL8188E = 0x8188e,
0083     RTL8812  = 0x88120,
0084     RTL8821  = 0x88210,
0085     RTL8192E = 0x8192e,
0086     RTL8191E = 0x8191e,
0087     RTL8723B = 0x8723b,
0088     RTL8814A = 0x8814a,
0089     RTL8881A = 0x8881a,
0090     RTL8821B = 0x8821b,
0091     RTL8822B = 0x8822b,
0092     RTL8703B = 0x8703b,
0093     RTL8195A = 0x8195a,
0094     RTL8188F = 0x8188f
0095 };
0096 
0097 enum rtl8xxxu_rx_type {
0098     RX_TYPE_DATA_PKT = 0,
0099     RX_TYPE_C2H = 1,
0100     RX_TYPE_ERROR = -1
0101 };
0102 
0103 struct rtl8xxxu_rxdesc16 {
0104 #ifdef __LITTLE_ENDIAN
0105     u32 pktlen:14;
0106     u32 crc32:1;
0107     u32 icverr:1;
0108     u32 drvinfo_sz:4;
0109     u32 security:3;
0110     u32 qos:1;
0111     u32 shift:2;
0112     u32 phy_stats:1;
0113     u32 swdec:1;
0114     u32 ls:1;
0115     u32 fs:1;
0116     u32 eor:1;
0117     u32 own:1;
0118 
0119     u32 macid:5;
0120     u32 tid:4;
0121     u32 hwrsvd:4;
0122     u32 amsdu:1;
0123     u32 paggr:1;
0124     u32 faggr:1;
0125     u32 a1fit:4;
0126     u32 a2fit:4;
0127     u32 pam:1;
0128     u32 pwr:1;
0129     u32 md:1;
0130     u32 mf:1;
0131     u32 type:2;
0132     u32 mc:1;
0133     u32 bc:1;
0134 
0135     u32 seq:12;
0136     u32 frag:4;
0137     u32 pkt_cnt:8;
0138     u32 reserved:6;
0139     u32 nextind:1;
0140     u32 reserved0:1;
0141 
0142     u32 rxmcs:6;
0143     u32 rxht:1;
0144     u32 gf:1;
0145     u32 splcp:1;
0146     u32 bw:1;
0147     u32 htc:1;
0148     u32 eosp:1;
0149     u32 bssidfit:2;
0150     u32 reserved1:16;
0151     u32 unicastwake:1;
0152     u32 magicwake:1;
0153 
0154     u32 pattern0match:1;
0155     u32 pattern1match:1;
0156     u32 pattern2match:1;
0157     u32 pattern3match:1;
0158     u32 pattern4match:1;
0159     u32 pattern5match:1;
0160     u32 pattern6match:1;
0161     u32 pattern7match:1;
0162     u32 pattern8match:1;
0163     u32 pattern9match:1;
0164     u32 patternamatch:1;
0165     u32 patternbmatch:1;
0166     u32 patterncmatch:1;
0167     u32 reserved2:19;
0168 #else
0169     u32 own:1;
0170     u32 eor:1;
0171     u32 fs:1;
0172     u32 ls:1;
0173     u32 swdec:1;
0174     u32 phy_stats:1;
0175     u32 shift:2;
0176     u32 qos:1;
0177     u32 security:3;
0178     u32 drvinfo_sz:4;
0179     u32 icverr:1;
0180     u32 crc32:1;
0181     u32 pktlen:14;
0182 
0183     u32 bc:1;
0184     u32 mc:1;
0185     u32 type:2;
0186     u32 mf:1;
0187     u32 md:1;
0188     u32 pwr:1;
0189     u32 pam:1;
0190     u32 a2fit:4;
0191     u32 a1fit:4;
0192     u32 faggr:1;
0193     u32 paggr:1;
0194     u32 amsdu:1;
0195     u32 hwrsvd:4;
0196     u32 tid:4;
0197     u32 macid:5;
0198 
0199     u32 reserved0:1;
0200     u32 nextind:1;
0201     u32 reserved:6;
0202     u32 pkt_cnt:8;
0203     u32 frag:4;
0204     u32 seq:12;
0205 
0206     u32 magicwake:1;
0207     u32 unicastwake:1;
0208     u32 reserved1:16;
0209     u32 bssidfit:2;
0210     u32 eosp:1;
0211     u32 htc:1;
0212     u32 bw:1;
0213     u32 splcp:1;
0214     u32 gf:1;
0215     u32 rxht:1;
0216     u32 rxmcs:6;
0217 
0218     u32 reserved2:19;
0219     u32 patterncmatch:1;
0220     u32 patternbmatch:1;
0221     u32 patternamatch:1;
0222     u32 pattern9match:1;
0223     u32 pattern8match:1;
0224     u32 pattern7match:1;
0225     u32 pattern6match:1;
0226     u32 pattern5match:1;
0227     u32 pattern4match:1;
0228     u32 pattern3match:1;
0229     u32 pattern2match:1;
0230     u32 pattern1match:1;
0231     u32 pattern0match:1;
0232 #endif
0233     u32 tsfl;
0234 #if 0
0235     u32 bassn:12;
0236     u32 bavld:1;
0237     u32 reserved3:19;
0238 #endif
0239 };
0240 
0241 struct rtl8xxxu_rxdesc24 {
0242 #ifdef __LITTLE_ENDIAN
0243     u32 pktlen:14;
0244     u32 crc32:1;
0245     u32 icverr:1;
0246     u32 drvinfo_sz:4;
0247     u32 security:3;
0248     u32 qos:1;
0249     u32 shift:2;
0250     u32 phy_stats:1;
0251     u32 swdec:1;
0252     u32 ls:1;
0253     u32 fs:1;
0254     u32 eor:1;
0255     u32 own:1;
0256 
0257     u32 macid:7;
0258     u32 dummy1_0:1;
0259     u32 tid:4;
0260     u32 dummy1_1:1;
0261     u32 amsdu:1;
0262     u32 rxid_match:1;
0263     u32 paggr:1;
0264     u32 a1fit:4;    /* 16 */
0265     u32 chkerr:1;
0266     u32 ipver:1;
0267     u32 tcpudp:1;
0268     u32 chkvld:1;
0269     u32 pam:1;
0270     u32 pwr:1;
0271     u32 more_data:1;
0272     u32 more_frag:1;
0273     u32 type:2;
0274     u32 mc:1;
0275     u32 bc:1;
0276 
0277     u32 seq:12;
0278     u32 frag:4;
0279     u32 rx_is_qos:1;    /* 16 */
0280     u32 dummy2_0:1;
0281     u32 wlanhd_iv_len:6;
0282     u32 dummy2_1:4;
0283     u32 rpt_sel:1;
0284     u32 dummy2_2:3;
0285 
0286     u32 rxmcs:7;
0287     u32 dummy3_0:3;
0288     u32 htc:1;
0289     u32 eosp:1;
0290     u32 bssidfit:2;
0291     u32 dummy3_1:2;
0292     u32 usb_agg_pktnum:8;   /* 16 */
0293     u32 dummy3_2:5;
0294     u32 pattern_match:1;
0295     u32 unicast_match:1;
0296     u32 magic_match:1;
0297 
0298     u32 splcp:1;
0299     u32 ldcp:1;
0300     u32 stbc:1;
0301     u32 dummy4_0:1;
0302     u32 bw:2;
0303     u32 dummy4_1:26;
0304 #else
0305     u32 own:1;
0306     u32 eor:1;
0307     u32 fs:1;
0308     u32 ls:1;
0309     u32 swdec:1;
0310     u32 phy_stats:1;
0311     u32 shift:2;
0312     u32 qos:1;
0313     u32 security:3;
0314     u32 drvinfo_sz:4;
0315     u32 icverr:1;
0316     u32 crc32:1;
0317     u32 pktlen:14;
0318 
0319     u32 bc:1;
0320     u32 mc:1;
0321     u32 type:2;
0322     u32 mf:1;
0323     u32 md:1;
0324     u32 pwr:1;
0325     u32 pam:1;
0326     u32 a2fit:4;
0327     u32 a1fit:4;
0328     u32 faggr:1;
0329     u32 paggr:1;
0330     u32 amsdu:1;
0331     u32 hwrsvd:4;
0332     u32 tid:4;
0333     u32 macid:5;
0334 
0335     u32 dummy2_2:3;
0336     u32 rpt_sel:1;
0337     u32 dummy2_1:4;
0338     u32 wlanhd_iv_len:6;
0339     u32 dummy2_0:1;
0340     u32 rx_is_qos:1;
0341     u32 frag:4;     /* 16 */
0342     u32 seq:12;
0343 
0344     u32 magic_match:1;
0345     u32 unicast_match:1;
0346     u32 pattern_match:1;
0347     u32 dummy3_2:5;
0348     u32 usb_agg_pktnum:8;
0349     u32 dummy3_1:2;     /* 16 */
0350     u32 bssidfit:2;
0351     u32 eosp:1;
0352     u32 htc:1;
0353     u32 dummy3_0:3;
0354     u32 rxmcs:7;
0355 
0356     u32 dumm4_1:26;
0357     u32 bw:2;
0358     u32 dummy4_0:1;
0359     u32 stbc:1;
0360     u32 ldcp:1;
0361     u32 splcp:1;
0362 #endif
0363     u32 tsfl;
0364 };
0365 
0366 struct rtl8xxxu_txdesc32 {
0367     __le16 pkt_size;
0368     u8 pkt_offset;
0369     u8 txdw0;
0370     __le32 txdw1;
0371     __le32 txdw2;
0372     __le32 txdw3;
0373     __le32 txdw4;
0374     __le32 txdw5;
0375     __le32 txdw6;
0376     __le16 csum;
0377     __le16 txdw7;
0378 };
0379 
0380 struct rtl8xxxu_txdesc40 {
0381     __le16 pkt_size;
0382     u8 pkt_offset;
0383     u8 txdw0;
0384     __le32 txdw1;
0385     __le32 txdw2;
0386     __le32 txdw3;
0387     __le32 txdw4;
0388     __le32 txdw5;
0389     __le32 txdw6;
0390     __le16 csum;
0391     __le16 txdw7;
0392     __le32 txdw8;
0393     __le32 txdw9;
0394 };
0395 
0396 /*  CCK Rates, TxHT = 0 */
0397 #define DESC_RATE_1M            0x00
0398 #define DESC_RATE_2M            0x01
0399 #define DESC_RATE_5_5M          0x02
0400 #define DESC_RATE_11M           0x03
0401 
0402 /*  OFDM Rates, TxHT = 0 */
0403 #define DESC_RATE_6M            0x04
0404 #define DESC_RATE_9M            0x05
0405 #define DESC_RATE_12M           0x06
0406 #define DESC_RATE_18M           0x07
0407 #define DESC_RATE_24M           0x08
0408 #define DESC_RATE_36M           0x09
0409 #define DESC_RATE_48M           0x0a
0410 #define DESC_RATE_54M           0x0b
0411 
0412 /*  MCS Rates, TxHT = 1 */
0413 #define DESC_RATE_MCS0          0x0c
0414 #define DESC_RATE_MCS1          0x0d
0415 #define DESC_RATE_MCS2          0x0e
0416 #define DESC_RATE_MCS3          0x0f
0417 #define DESC_RATE_MCS4          0x10
0418 #define DESC_RATE_MCS5          0x11
0419 #define DESC_RATE_MCS6          0x12
0420 #define DESC_RATE_MCS7          0x13
0421 #define DESC_RATE_MCS8          0x14
0422 #define DESC_RATE_MCS9          0x15
0423 #define DESC_RATE_MCS10         0x16
0424 #define DESC_RATE_MCS11         0x17
0425 #define DESC_RATE_MCS12         0x18
0426 #define DESC_RATE_MCS13         0x19
0427 #define DESC_RATE_MCS14         0x1a
0428 #define DESC_RATE_MCS15         0x1b
0429 #define DESC_RATE_MCS15_SG      0x1c
0430 #define DESC_RATE_MCS32         0x20
0431 
0432 #define TXDESC_OFFSET_SZ        0
0433 #define TXDESC_OFFSET_SHT       16
0434 #if 0
0435 #define TXDESC_BMC          BIT(24)
0436 #define TXDESC_LSG          BIT(26)
0437 #define TXDESC_FSG          BIT(27)
0438 #define TXDESC_OWN          BIT(31)
0439 #else
0440 #define TXDESC_BROADMULTICAST       BIT(0)
0441 #define TXDESC_HTC          BIT(1)
0442 #define TXDESC_LAST_SEGMENT     BIT(2)
0443 #define TXDESC_FIRST_SEGMENT        BIT(3)
0444 #define TXDESC_LINIP            BIT(4)
0445 #define TXDESC_NO_ACM           BIT(5)
0446 #define TXDESC_GF           BIT(6)
0447 #define TXDESC_OWN          BIT(7)
0448 #endif
0449 
0450 /* Word 1 */
0451 /*
0452  * Bits 0-7 differ dependent on chip generation. For 8723au bits 5/6 are
0453  * aggregation enable and break respectively. For 8723bu, bits 0-7 are macid.
0454  */
0455 #define TXDESC_PKT_OFFSET_SZ        0
0456 #define TXDESC32_AGG_ENABLE     BIT(5)
0457 #define TXDESC32_AGG_BREAK      BIT(6)
0458 #define TXDESC40_MACID_SHIFT        0
0459 #define TXDESC40_MACID_MASK     0x00f0
0460 #define TXDESC_QUEUE_SHIFT      8
0461 #define TXDESC_QUEUE_MASK       0x1f00
0462 #define TXDESC_QUEUE_BK         0x2
0463 #define TXDESC_QUEUE_BE         0x0
0464 #define TXDESC_QUEUE_VI         0x5
0465 #define TXDESC_QUEUE_VO         0x7
0466 #define TXDESC_QUEUE_BEACON     0x10
0467 #define TXDESC_QUEUE_HIGH       0x11
0468 #define TXDESC_QUEUE_MGNT       0x12
0469 #define TXDESC_QUEUE_CMD        0x13
0470 #define TXDESC_QUEUE_MAX        (TXDESC_QUEUE_CMD + 1)
0471 #define TXDESC40_RDG_NAV_EXT        BIT(13)
0472 #define TXDESC40_LSIG_TXOP_ENABLE   BIT(14)
0473 #define TXDESC40_PIFS           BIT(15)
0474 
0475 #define DESC_RATE_ID_SHIFT      16
0476 #define DESC_RATE_ID_MASK       0xf
0477 #define TXDESC_NAVUSEHDR        BIT(20)
0478 #define TXDESC_SEC_RC4          0x00400000
0479 #define TXDESC_SEC_AES          0x00c00000
0480 #define TXDESC_PKT_OFFSET_SHIFT     26
0481 #define TXDESC_AGG_EN           BIT(29)
0482 #define TXDESC_HWPC         BIT(31)
0483 
0484 /* Word 2 */
0485 #define TXDESC40_PAID_SHIFT     0
0486 #define TXDESC40_PAID_MASK      0x1ff
0487 #define TXDESC40_CCA_RTS_SHIFT      10
0488 #define TXDESC40_CCA_RTS_MASK       0xc00
0489 #define TXDESC40_AGG_ENABLE     BIT(12)
0490 #define TXDESC40_RDG_ENABLE     BIT(13)
0491 #define TXDESC40_AGG_BREAK      BIT(16)
0492 #define TXDESC40_MORE_FRAG      BIT(17)
0493 #define TXDESC40_RAW            BIT(18)
0494 #define TXDESC32_ACK_REPORT     BIT(19)
0495 #define TXDESC40_SPE_RPT        BIT(19)
0496 #define TXDESC_AMPDU_DENSITY_SHIFT  20
0497 #define TXDESC40_BT_INT         BIT(23)
0498 #define TXDESC40_GID_SHIFT      24
0499 
0500 /* Word 3 */
0501 #define TXDESC40_USE_DRIVER_RATE    BIT(8)
0502 #define TXDESC40_CTS_SELF_ENABLE    BIT(11)
0503 #define TXDESC40_RTS_CTS_ENABLE     BIT(12)
0504 #define TXDESC40_HW_RTS_ENABLE      BIT(13)
0505 #define TXDESC32_SEQ_SHIFT      16
0506 #define TXDESC32_SEQ_MASK       0x0fff0000
0507 
0508 /* Word 4 */
0509 #define TXDESC32_RTS_RATE_SHIFT     0
0510 #define TXDESC32_RTS_RATE_MASK      0x3f
0511 #define TXDESC32_QOS            BIT(6)
0512 #define TXDESC32_HW_SEQ_ENABLE      BIT(7)
0513 #define TXDESC32_USE_DRIVER_RATE    BIT(8)
0514 #define TXDESC_DISABLE_DATA_FB      BIT(10)
0515 #define TXDESC32_CTS_SELF_ENABLE    BIT(11)
0516 #define TXDESC32_RTS_CTS_ENABLE     BIT(12)
0517 #define TXDESC32_HW_RTS_ENABLE      BIT(13)
0518 #define TXDESC_PRIME_CH_OFF_LOWER   BIT(20)
0519 #define TXDESC_PRIME_CH_OFF_UPPER   BIT(21)
0520 #define TXDESC32_SHORT_PREAMBLE     BIT(24)
0521 #define TXDESC_DATA_BW          BIT(25)
0522 #define TXDESC_RTS_DATA_BW      BIT(27)
0523 #define TXDESC_RTS_PRIME_CH_OFF_LOWER   BIT(28)
0524 #define TXDESC_RTS_PRIME_CH_OFF_UPPER   BIT(29)
0525 #define TXDESC40_DATA_RATE_FB_SHIFT 8
0526 #define TXDESC40_DATA_RATE_FB_MASK  0x00001f00
0527 #define TXDESC40_RETRY_LIMIT_ENABLE BIT(17)
0528 #define TXDESC40_RETRY_LIMIT_SHIFT  18
0529 #define TXDESC40_RETRY_LIMIT_MASK   0x00fc0000
0530 #define TXDESC40_RTS_RATE_SHIFT     24
0531 #define TXDESC40_RTS_RATE_MASK      0x3f000000
0532 
0533 /* Word 5 */
0534 #define TXDESC40_SHORT_PREAMBLE     BIT(4)
0535 #define TXDESC32_SHORT_GI       BIT(6)
0536 #define TXDESC_CCX_TAG          BIT(7)
0537 #define TXDESC32_RETRY_LIMIT_ENABLE BIT(17)
0538 #define TXDESC32_RETRY_LIMIT_SHIFT  18
0539 #define TXDESC32_RETRY_LIMIT_MASK   0x00fc0000
0540 
0541 /* Word 6 */
0542 #define TXDESC_MAX_AGG_SHIFT        11
0543 
0544 /* Word 8 */
0545 #define TXDESC40_HW_SEQ_ENABLE      BIT(15)
0546 
0547 /* Word 9 */
0548 #define TXDESC40_SEQ_SHIFT      12
0549 #define TXDESC40_SEQ_MASK       0x00fff000
0550 
0551 struct phy_rx_agc_info {
0552 #ifdef __LITTLE_ENDIAN
0553     u8  gain:7, trsw:1;
0554 #else
0555     u8  trsw:1, gain:7;
0556 #endif
0557 };
0558 
0559 struct rtl8723au_phy_stats {
0560     struct phy_rx_agc_info path_agc[RTL8723A_MAX_RF_PATHS];
0561     u8  ch_corr[RTL8723A_MAX_RF_PATHS];
0562     u8  cck_sig_qual_ofdm_pwdb_all;
0563     u8  cck_agc_rpt_ofdm_cfosho_a;
0564     u8  cck_rpt_b_ofdm_cfosho_b;
0565     u8  reserved_1;
0566     u8  noise_power_db_msb;
0567     u8  path_cfotail[RTL8723A_MAX_RF_PATHS];
0568     u8  pcts_mask[RTL8723A_MAX_RF_PATHS];
0569     s8  stream_rxevm[RTL8723A_MAX_RF_PATHS];
0570     u8  path_rxsnr[RTL8723A_MAX_RF_PATHS];
0571     u8  noise_power_db_lsb;
0572     u8  reserved_2[3];
0573     u8  stream_csi[RTL8723A_MAX_RF_PATHS];
0574     u8  stream_target_csi[RTL8723A_MAX_RF_PATHS];
0575     s8  sig_evm;
0576     u8  reserved_3;
0577 
0578 #ifdef __LITTLE_ENDIAN
0579     u8  antsel_rx_keep_2:1; /* ex_intf_flg:1; */
0580     u8  sgi_en:1;
0581     u8  rxsc:2;
0582     u8  idle_long:1;
0583     u8  r_ant_train_en:1;
0584     u8  antenna_select_b:1;
0585     u8  antenna_select:1;
0586 #else   /*  _BIG_ENDIAN_ */
0587     u8  antenna_select:1;
0588     u8  antenna_select_b:1;
0589     u8  r_ant_train_en:1;
0590     u8  idle_long:1;
0591     u8  rxsc:2;
0592     u8  sgi_en:1;
0593     u8  antsel_rx_keep_2:1; /* ex_intf_flg:1; */
0594 #endif
0595 };
0596 
0597 /*
0598  * Regs to backup
0599  */
0600 #define RTL8XXXU_ADDA_REGS      16
0601 #define RTL8XXXU_MAC_REGS       4
0602 #define RTL8XXXU_BB_REGS        9
0603 
0604 struct rtl8xxxu_firmware_header {
0605     __le16  signature;      /*  92C0: test chip; 92C,
0606                         88C0: test chip;
0607                         88C1: MP A-cut;
0608                         92C1: MP A-cut */
0609     u8  category;       /*  AP/NIC and USB/PCI */
0610     u8  function;
0611 
0612     __le16  major_version;      /*  FW Version */
0613     u8  minor_version;      /*  FW Subversion, default 0x00 */
0614     u8  reserved1;
0615 
0616     u8  month;          /*  Release time Month field */
0617     u8  date;           /*  Release time Date field */
0618     u8  hour;           /*  Release time Hour field */
0619     u8  minute;         /*  Release time Minute field */
0620 
0621     __le16  ramcodesize;        /*  Size of RAM code */
0622     u16 reserved2;
0623 
0624     __le32  svn_idx;        /*  SVN entry index */
0625     u32 reserved3;
0626 
0627     u32 reserved4;
0628     u32 reserved5;
0629 
0630     u8  data[];
0631 };
0632 
0633 /*
0634  * 8723au/8192cu/8188ru required base power index offset tables.
0635  */
0636 struct rtl8xxxu_power_base {
0637     u32 reg_0e00;
0638     u32 reg_0e04;
0639     u32 reg_0e08;
0640     u32 reg_086c;
0641 
0642     u32 reg_0e10;
0643     u32 reg_0e14;
0644     u32 reg_0e18;
0645     u32 reg_0e1c;
0646 
0647     u32 reg_0830;
0648     u32 reg_0834;
0649     u32 reg_0838;
0650     u32 reg_086c_2;
0651 
0652     u32 reg_083c;
0653     u32 reg_0848;
0654     u32 reg_084c;
0655     u32 reg_0868;
0656 };
0657 
0658 /*
0659  * The 8723au has 3 channel groups: 1-3, 4-9, and 10-14
0660  */
0661 struct rtl8723au_idx {
0662 #ifdef __LITTLE_ENDIAN
0663     int a:4;
0664     int b:4;
0665 #else
0666     int b:4;
0667     int a:4;
0668 #endif
0669 } __attribute__((packed));
0670 
0671 struct rtl8723au_efuse {
0672     __le16 rtl_id;
0673     u8 res0[0xe];
0674     u8 cck_tx_power_index_A[3]; /* 0x10 */
0675     u8 cck_tx_power_index_B[3];
0676     u8 ht40_1s_tx_power_index_A[3]; /* 0x16 */
0677     u8 ht40_1s_tx_power_index_B[3];
0678     /*
0679      * The following entries are half-bytes split as:
0680      * bits 0-3: path A, bits 4-7: path B, all values 4 bits signed
0681      */
0682     struct rtl8723au_idx ht20_tx_power_index_diff[3];
0683     struct rtl8723au_idx ofdm_tx_power_index_diff[3];
0684     struct rtl8723au_idx ht40_max_power_offset[3];
0685     struct rtl8723au_idx ht20_max_power_offset[3];
0686     u8 channel_plan;        /* 0x28 */
0687     u8 tssi_a;
0688     u8 thermal_meter;
0689     u8 rf_regulatory;
0690     u8 rf_option_2;
0691     u8 rf_option_3;
0692     u8 rf_option_4;
0693     u8 res7;
0694     u8 version          /* 0x30 */;
0695     u8 customer_id_major;
0696     u8 customer_id_minor;
0697     u8 xtal_k;
0698     u8 chipset;         /* 0x34 */
0699     u8 res8[0x82];
0700     u8 vid;             /* 0xb7 */
0701     u8 res9;
0702     u8 pid;             /* 0xb9 */
0703     u8 res10[0x0c];
0704     u8 mac_addr[ETH_ALEN];      /* 0xc6 */
0705     u8 res11[2];
0706     u8 vendor_name[7];
0707     u8 res12[2];
0708     u8 device_name[0x29];       /* 0xd7 */
0709 };
0710 
0711 struct rtl8192cu_efuse {
0712     __le16 rtl_id;
0713     __le16 hpon;
0714     u8 res0[2];
0715     __le16 clk;
0716     __le16 testr;
0717     __le16 vid;
0718     __le16 did;
0719     __le16 svid;
0720     __le16 smid;                        /* 0x10 */
0721     u8 res1[4];
0722     u8 mac_addr[ETH_ALEN];                  /* 0x16 */
0723     u8 res2[2];
0724     u8 vendor_name[7];
0725     u8 res3[3];
0726     u8 device_name[0x14];                   /* 0x28 */
0727     u8 res4[0x1e];                      /* 0x3c */
0728     u8 cck_tx_power_index_A[3];             /* 0x5a */
0729     u8 cck_tx_power_index_B[3];
0730     u8 ht40_1s_tx_power_index_A[3];             /* 0x60 */
0731     u8 ht40_1s_tx_power_index_B[3];
0732     /*
0733      * The following entries are half-bytes split as:
0734      * bits 0-3: path A, bits 4-7: path B, all values 4 bits signed
0735      */
0736     struct rtl8723au_idx ht40_2s_tx_power_index_diff[3];
0737     struct rtl8723au_idx ht20_tx_power_index_diff[3];   /* 0x69 */
0738     struct rtl8723au_idx ofdm_tx_power_index_diff[3];
0739     struct rtl8723au_idx ht40_max_power_offset[3];      /* 0x6f */
0740     struct rtl8723au_idx ht20_max_power_offset[3];
0741     u8 channel_plan;                    /* 0x75 */
0742     u8 tssi_a;
0743     u8 tssi_b;
0744     u8 thermal_meter;   /* xtal_k */            /* 0x78 */
0745     u8 rf_regulatory;
0746     u8 rf_option_2;
0747     u8 rf_option_3;
0748     u8 rf_option_4;
0749     u8 res5[1];                     /* 0x7d */
0750     u8 version;
0751     u8 customer_id;
0752 };
0753 
0754 struct rtl8723bu_pwr_idx {
0755 #ifdef __LITTLE_ENDIAN
0756     int ht20:4;
0757     int ht40:4;
0758     int ofdm:4;
0759     int cck:4;
0760 #else
0761     int cck:4;
0762     int ofdm:4;
0763     int ht40:4;
0764     int ht20:4;
0765 #endif
0766 } __attribute__((packed));
0767 
0768 struct rtl8723bu_efuse_tx_power {
0769     u8 cck_base[6];
0770     u8 ht40_base[5];
0771     struct rtl8723au_idx ht20_ofdm_1s_diff;
0772     struct rtl8723bu_pwr_idx pwr_diff[3];
0773     u8 dummy5g[24]; /* max channel group (14) + power diff offset (10) */
0774 };
0775 
0776 struct rtl8723bu_efuse {
0777     __le16 rtl_id;
0778     u8 res0[0x0e];
0779     struct rtl8723bu_efuse_tx_power tx_power_index_A;   /* 0x10 */
0780     struct rtl8723bu_efuse_tx_power tx_power_index_B;   /* 0x3a */
0781     struct rtl8723bu_efuse_tx_power tx_power_index_C;   /* 0x64 */
0782     struct rtl8723bu_efuse_tx_power tx_power_index_D;   /* 0x8e */
0783     u8 channel_plan;        /* 0xb8 */
0784     u8 xtal_k;
0785     u8 thermal_meter;
0786     u8 iqk_lck;
0787     u8 pa_type;         /* 0xbc */
0788     u8 lna_type_2g;         /* 0xbd */
0789     u8 res2[3];
0790     u8 rf_board_option;
0791     u8 rf_feature_option;
0792     u8 rf_bt_setting;
0793     u8 eeprom_version;
0794     u8 eeprom_customer_id;
0795     u8 res3[2];
0796     u8 tx_pwr_calibrate_rate;
0797     u8 rf_antenna_option;       /* 0xc9 */
0798     u8 rfe_option;
0799     u8 res4[9];
0800     u8 usb_optional_function;
0801     u8 res5[0x1e];
0802     u8 res6[2];
0803     u8 serial[0x0b];        /* 0xf5 */
0804     u8 vid;             /* 0x100 */
0805     u8 res7;
0806     u8 pid;
0807     u8 res8[4];
0808     u8 mac_addr[ETH_ALEN];      /* 0x107 */
0809     u8 res9[2];
0810     u8 vendor_name[0x07];
0811     u8 res10[2];
0812     u8 device_name[0x14];
0813     u8 res11[0xcf];
0814     u8 package_type;        /* 0x1fb */
0815     u8 res12[0x4];
0816 };
0817 
0818 struct rtl8192eu_efuse_tx_power {
0819     u8 cck_base[6];
0820     u8 ht40_base[5];
0821     struct rtl8723au_idx ht20_ofdm_1s_diff;
0822     struct rtl8723bu_pwr_idx pwr_diff[3];
0823     u8 dummy5g[24]; /* max channel group (14) + power diff offset (10) */
0824 };
0825 
0826 struct rtl8192eu_efuse {
0827     __le16 rtl_id;
0828     u8 res0[0x0e];
0829     struct rtl8192eu_efuse_tx_power tx_power_index_A;   /* 0x10 */
0830     struct rtl8192eu_efuse_tx_power tx_power_index_B;   /* 0x3a */
0831     u8 res2[0x54];
0832     u8 channel_plan;        /* 0xb8 */
0833     u8 xtal_k;
0834     u8 thermal_meter;
0835     u8 iqk_lck;
0836     u8 pa_type;         /* 0xbc */
0837     u8 lna_type_2g;         /* 0xbd */
0838     u8 res3[1];
0839     u8 lna_type_5g;         /* 0xbf */
0840     u8 res4[1];
0841     u8 rf_board_option;
0842     u8 rf_feature_option;
0843     u8 rf_bt_setting;
0844     u8 eeprom_version;
0845     u8 eeprom_customer_id;
0846     u8 res5[3];
0847     u8 rf_antenna_option;       /* 0xc9 */
0848     u8 res6[6];
0849     u8 vid;             /* 0xd0 */
0850     u8 res7[1];
0851     u8 pid;             /* 0xd2 */
0852     u8 res8[1];
0853     u8 usb_optional_function;
0854     u8 res9[2];
0855     u8 mac_addr[ETH_ALEN];      /* 0xd7 */
0856     u8 device_info[80];
0857     u8 res11[3];
0858     u8 unknown[0x0d];       /* 0x130 */
0859     u8 res12[0xc3];
0860 };
0861 
0862 struct rtl8xxxu_reg8val {
0863     u16 reg;
0864     u8 val;
0865 };
0866 
0867 struct rtl8xxxu_reg32val {
0868     u16 reg;
0869     u32 val;
0870 };
0871 
0872 struct rtl8xxxu_rfregval {
0873     u8 reg;
0874     u32 val;
0875 };
0876 
0877 enum rtl8xxxu_rfpath {
0878     RF_A = 0,
0879     RF_B = 1,
0880 };
0881 
0882 struct rtl8xxxu_rfregs {
0883     u16 hssiparm1;
0884     u16 hssiparm2;
0885     u16 lssiparm;
0886     u16 hspiread;
0887     u16 lssiread;
0888     u16 rf_sw_ctrl;
0889 };
0890 
0891 #define H2C_MAX_MBOX            4
0892 #define H2C_EXT             BIT(7)
0893 #define  H2C_JOIN_BSS_DISCONNECT    0
0894 #define  H2C_JOIN_BSS_CONNECT       1
0895 
0896 /*
0897  * H2C (firmware) commands differ between the older generation chips
0898  * 8188[cr]u, 819[12]cu, and 8723au, and the more recent chips 8723bu,
0899  * 8192[de]u, 8192eu, and 8812.
0900  */
0901 enum h2c_cmd_8723a {
0902     H2C_SET_POWER_MODE = 1,
0903     H2C_JOIN_BSS_REPORT = 2,
0904     H2C_SET_RSSI = 5,
0905     H2C_SET_RATE_MASK = (6 | H2C_EXT),
0906 };
0907 
0908 enum h2c_cmd_8723b {
0909     /*
0910      * Common Class: 000
0911      */
0912     H2C_8723B_RSVD_PAGE = 0x00,
0913     H2C_8723B_MEDIA_STATUS_RPT = 0x01,
0914     H2C_8723B_SCAN_ENABLE = 0x02,
0915     H2C_8723B_KEEP_ALIVE = 0x03,
0916     H2C_8723B_DISCON_DECISION = 0x04,
0917     H2C_8723B_PSD_OFFLOAD = 0x05,
0918     H2C_8723B_AP_OFFLOAD = 0x08,
0919     H2C_8723B_BCN_RSVDPAGE = 0x09,
0920     H2C_8723B_PROBERSP_RSVDPAGE = 0x0A,
0921     H2C_8723B_FCS_RSVDPAGE = 0x10,
0922     H2C_8723B_FCS_INFO = 0x11,
0923     H2C_8723B_AP_WOW_GPIO_CTRL = 0x13,
0924 
0925     /*
0926      * PoweSave Class: 001
0927      */
0928     H2C_8723B_SET_PWR_MODE = 0x20,
0929     H2C_8723B_PS_TUNING_PARA = 0x21,
0930     H2C_8723B_PS_TUNING_PARA2 = 0x22,
0931     H2C_8723B_P2P_LPS_PARAM = 0x23,
0932     H2C_8723B_P2P_PS_OFFLOAD = 0x24,
0933     H2C_8723B_PS_SCAN_ENABLE = 0x25,
0934     H2C_8723B_SAP_PS_ = 0x26,
0935     H2C_8723B_INACTIVE_PS_ = 0x27,
0936     H2C_8723B_FWLPS_IN_IPS_ = 0x28,
0937 
0938     /*
0939      * Dynamic Mechanism Class: 010
0940      */
0941     H2C_8723B_MACID_CFG_RAID = 0x40,
0942     H2C_8723B_TXBF = 0x41,
0943     H2C_8723B_RSSI_SETTING = 0x42,
0944     H2C_8723B_AP_REQ_TXRPT = 0x43,
0945     H2C_8723B_INIT_RATE_COLLECT = 0x44,
0946 
0947     /*
0948      * BT Class: 011
0949      */
0950     H2C_8723B_B_TYPE_TDMA = 0x60,
0951     H2C_8723B_BT_INFO = 0x61,
0952     H2C_8723B_FORCE_BT_TXPWR = 0x62,
0953     H2C_8723B_BT_IGNORE_WLANACT = 0x63,
0954     H2C_8723B_DAC_SWING_VALUE = 0x64,
0955     H2C_8723B_ANT_SEL_RSV = 0x65,
0956     H2C_8723B_WL_OPMODE = 0x66,
0957     H2C_8723B_BT_MP_OPER = 0x67,
0958     H2C_8723B_BT_CONTROL = 0x68,
0959     H2C_8723B_BT_WIFI_CTRL = 0x69,
0960     H2C_8723B_BT_FW_PATCH = 0x6a,
0961     H2C_8723B_BT_WLAN_CALIBRATION = 0x6d,
0962     H2C_8723B_BT_GRANT = 0x6e,
0963 
0964     /*
0965      * WOWLAN Class: 100
0966      */
0967     H2C_8723B_WOWLAN = 0x80,
0968     H2C_8723B_REMOTE_WAKE_CTRL = 0x81,
0969     H2C_8723B_AOAC_GLOBAL_INFO = 0x82,
0970     H2C_8723B_AOAC_RSVD_PAGE = 0x83,
0971     H2C_8723B_AOAC_RSVD_PAGE2 = 0x84,
0972     H2C_8723B_D0_SCAN_OFFLOAD_CTRL = 0x85,
0973     H2C_8723B_D0_SCAN_OFFLOAD_INFO = 0x86,
0974     H2C_8723B_CHNL_SWITCH_OFFLOAD = 0x87,
0975 
0976     H2C_8723B_RESET_TSF = 0xC0,
0977 };
0978 
0979 
0980 struct h2c_cmd {
0981     union {
0982         struct {
0983             u8 cmd;
0984             u8 data[7];
0985         } __packed cmd;
0986         struct {
0987             __le32 data;
0988             __le16 ext;
0989         } __packed raw;
0990         struct {
0991             __le32 data;
0992             __le32 ext;
0993         } __packed raw_wide;
0994         struct {
0995             u8 cmd;
0996             u8 data;
0997         } __packed joinbss;
0998         struct {
0999             u8 cmd;
1000             __le16 mask_hi;
1001             u8 arg;
1002             __le16 mask_lo;
1003         } __packed ramask;
1004         struct {
1005             u8 cmd;
1006             u8 parm;
1007             u8 macid;
1008             u8 macid_end;
1009         } __packed media_status_rpt;
1010         struct {
1011             u8 cmd;
1012             u8 macid;
1013             /*
1014              * [0:4] - RAID
1015              * [7]   - SGI
1016              */
1017             u8 data1;
1018             /*
1019              * [0:1] - Bandwidth
1020              * [3]   - No Update
1021              * [4:5] - VHT enable
1022              * [6]   - DISPT
1023              * [7]   - DISRA
1024              */
1025             u8 data2;
1026             u8 ramask0;
1027             u8 ramask1;
1028             u8 ramask2;
1029             u8 ramask3;
1030         } __packed b_macid_cfg;
1031         struct {
1032             u8 cmd;
1033             u8 data1;
1034             u8 data2;
1035             u8 data3;
1036             u8 data4;
1037             u8 data5;
1038         } __packed b_type_dma;
1039         struct {
1040             u8 cmd;
1041             u8 data;
1042         } __packed bt_info;
1043         struct {
1044             u8 cmd;
1045             u8 operreq;
1046             u8 opcode;
1047             u8 data;
1048             u8 addr;
1049         } __packed bt_mp_oper;
1050         struct {
1051             u8 cmd;
1052             u8 data;
1053         } __packed bt_wlan_calibration;
1054         struct {
1055             u8 cmd;
1056             u8 data;
1057         } __packed ignore_wlan;
1058         struct {
1059             u8 cmd;
1060             u8 ant_inverse;
1061             u8 int_switch_type;
1062         } __packed ant_sel_rsv;
1063         struct {
1064             u8 cmd;
1065             u8 data;
1066         } __packed bt_grant;
1067     };
1068 };
1069 
1070 enum c2h_evt_8723b {
1071     C2H_8723B_DEBUG = 0,
1072     C2H_8723B_TSF = 1,
1073     C2H_8723B_AP_RPT_RSP = 2,
1074     C2H_8723B_CCX_TX_RPT = 3,
1075     C2H_8723B_BT_RSSI = 4,
1076     C2H_8723B_BT_OP_MODE = 5,
1077     C2H_8723B_EXT_RA_RPT = 6,
1078     C2H_8723B_BT_INFO = 9,
1079     C2H_8723B_HW_INFO_EXCH = 0x0a,
1080     C2H_8723B_BT_MP_INFO = 0x0b,
1081     C2H_8723B_RA_REPORT = 0x0c,
1082     C2H_8723B_FW_DEBUG = 0xff,
1083 };
1084 
1085 enum bt_info_src_8723b {
1086     BT_INFO_SRC_8723B_WIFI_FW = 0x0,
1087         BT_INFO_SRC_8723B_BT_RSP = 0x1,
1088         BT_INFO_SRC_8723B_BT_ACTIVE_SEND = 0x2,
1089 };
1090 
1091 enum bt_mp_oper_opcode_8723b {
1092     BT_MP_OP_GET_BT_VERSION = 0x00,
1093     BT_MP_OP_RESET = 0x01,
1094     BT_MP_OP_TEST_CTRL = 0x02,
1095     BT_MP_OP_SET_BT_MODE = 0x03,
1096     BT_MP_OP_SET_CHNL_TX_GAIN = 0x04,
1097     BT_MP_OP_SET_PKT_TYPE_LEN = 0x05,
1098     BT_MP_OP_SET_PKT_CNT_L_PL_TYPE = 0x06,
1099     BT_MP_OP_SET_PKT_CNT_H_PKT_INTV = 0x07,
1100     BT_MP_OP_SET_PKT_HEADER = 0x08,
1101     BT_MP_OP_SET_WHITENCOEFF = 0x09,
1102     BT_MP_OP_SET_BD_ADDR_L = 0x0a,
1103     BT_MP_OP_SET_BD_ADDR_H = 0x0b,
1104     BT_MP_OP_WRITE_REG_ADDR = 0x0c,
1105     BT_MP_OP_WRITE_REG_VALUE = 0x0d,
1106     BT_MP_OP_GET_BT_STATUS = 0x0e,
1107     BT_MP_OP_GET_BD_ADDR_L = 0x0f,
1108     BT_MP_OP_GET_BD_ADDR_H = 0x10,
1109     BT_MP_OP_READ_REG = 0x11,
1110     BT_MP_OP_SET_TARGET_BD_ADDR_L = 0x12,
1111     BT_MP_OP_SET_TARGET_BD_ADDR_H = 0x13,
1112     BT_MP_OP_SET_TX_POWER_CALIBRATION = 0x14,
1113     BT_MP_OP_GET_RX_PKT_CNT_L = 0x15,
1114     BT_MP_OP_GET_RX_PKT_CNT_H = 0x16,
1115     BT_MP_OP_GET_RX_ERROR_BITS_L = 0x17,
1116     BT_MP_OP_GET_RX_ERROR_BITS_H = 0x18,
1117     BT_MP_OP_GET_RSSI = 0x19,
1118     BT_MP_OP_GET_CFO_HDR_QUALITY_L = 0x1a,
1119     BT_MP_OP_GET_CFO_HDR_QUALITY_H = 0x1b,
1120     BT_MP_OP_GET_TARGET_BD_ADDR_L = 0x1c,
1121     BT_MP_OP_GET_TARGET_BD_ADDR_H = 0x1d,
1122     BT_MP_OP_GET_AFH_MAP_L = 0x1e,
1123     BT_MP_OP_GET_AFH_MAP_M = 0x1f,
1124     BT_MP_OP_GET_AFH_MAP_H = 0x20,
1125     BT_MP_OP_GET_AFH_STATUS = 0x21,
1126     BT_MP_OP_SET_TRACKING_INTERVAL = 0x22,
1127     BT_MP_OP_SET_THERMAL_METER = 0x23,
1128     BT_MP_OP_ENABLE_CFO_TRACKING = 0x24,
1129 };
1130 
1131 enum rtl8xxxu_bw_mode {
1132     RTL8XXXU_CHANNEL_WIDTH_20 = 0,
1133     RTL8XXXU_CHANNEL_WIDTH_40 = 1,
1134     RTL8XXXU_CHANNEL_WIDTH_80 = 2,
1135     RTL8XXXU_CHANNEL_WIDTH_160 = 3,
1136     RTL8XXXU_CHANNEL_WIDTH_80_80 = 4,
1137     RTL8XXXU_CHANNEL_WIDTH_MAX = 5,
1138 };
1139 
1140 struct rtl8723bu_c2h {
1141     u8 id;
1142     u8 seq;
1143     union {
1144         struct {
1145             u8 payload[0];
1146         } __packed raw;
1147         struct {
1148             u8 ext_id;
1149             u8 status:4;
1150             u8 retlen:4;
1151             u8 opcode_ver:4;
1152             u8 req_num:4;
1153             u8 payload[2];
1154         } __packed bt_mp_info;
1155         struct {
1156             u8 response_source:4;
1157             u8 dummy0_0:4;
1158 
1159             u8 bt_info;
1160 
1161             u8 retry_count:4;
1162             u8 dummy2_0:1;
1163             u8 bt_page:1;
1164             u8 tx_rx_mask:1;
1165             u8 dummy2_2:1;
1166 
1167             u8 rssi;
1168 
1169             u8 basic_rate:1;
1170             u8 bt_has_reset:1;
1171             u8 dummy4_1:1;
1172             u8 ignore_wlan:1;
1173             u8 auto_report:1;
1174             u8 dummy4_2:3;
1175 
1176             u8 a4;
1177             u8 a5;
1178         } __packed bt_info;
1179         struct {
1180             u8 rate:7;
1181             u8 sgi:1;
1182             u8 macid;
1183             u8 ldpc:1;
1184             u8 txbf:1;
1185             u8 noisy_state:1;
1186             u8 dummy2_0:5;
1187             u8 dummy3_0;
1188             u8 dummy4_0;
1189             u8 dummy5_0;
1190             u8 bw;
1191         } __packed ra_report;
1192     };
1193 };
1194 
1195 struct rtl8xxxu_fileops;
1196 
1197 /*mlme related.*/
1198 enum wireless_mode {
1199     WIRELESS_MODE_UNKNOWN = 0,
1200     /* Sub-Element */
1201     WIRELESS_MODE_B = BIT(0),
1202     WIRELESS_MODE_G = BIT(1),
1203     WIRELESS_MODE_A = BIT(2),
1204     WIRELESS_MODE_N_24G = BIT(3),
1205     WIRELESS_MODE_N_5G = BIT(4),
1206     WIRELESS_AUTO = BIT(5),
1207     WIRELESS_MODE_AC = BIT(6),
1208     WIRELESS_MODE_MAX = 0x7F,
1209 };
1210 
1211 /* from rtlwifi/wifi.h */
1212 enum ratr_table_mode_new {
1213     RATEID_IDX_BGN_40M_2SS = 0,
1214     RATEID_IDX_BGN_40M_1SS = 1,
1215     RATEID_IDX_BGN_20M_2SS_BN = 2,
1216     RATEID_IDX_BGN_20M_1SS_BN = 3,
1217     RATEID_IDX_GN_N2SS = 4,
1218     RATEID_IDX_GN_N1SS = 5,
1219     RATEID_IDX_BG = 6,
1220     RATEID_IDX_G = 7,
1221     RATEID_IDX_B = 8,
1222     RATEID_IDX_VHT_2SS = 9,
1223     RATEID_IDX_VHT_1SS = 10,
1224     RATEID_IDX_MIX1 = 11,
1225     RATEID_IDX_MIX2 = 12,
1226     RATEID_IDX_VHT_3SS = 13,
1227     RATEID_IDX_BGN_3SS = 14,
1228 };
1229 
1230 #define BT_INFO_8723B_1ANT_B_FTP        BIT(7)
1231 #define BT_INFO_8723B_1ANT_B_A2DP       BIT(6)
1232 #define BT_INFO_8723B_1ANT_B_HID        BIT(5)
1233 #define BT_INFO_8723B_1ANT_B_SCO_BUSY       BIT(4)
1234 #define BT_INFO_8723B_1ANT_B_ACL_BUSY       BIT(3)
1235 #define BT_INFO_8723B_1ANT_B_INQ_PAGE       BIT(2)
1236 #define BT_INFO_8723B_1ANT_B_SCO_ESCO       BIT(1)
1237 #define BT_INFO_8723B_1ANT_B_CONNECTION BIT(0)
1238 
1239 enum _BT_8723B_1ANT_STATUS {
1240     BT_8723B_1ANT_STATUS_NON_CONNECTED_IDLE      = 0x0,
1241     BT_8723B_1ANT_STATUS_CONNECTED_IDLE          = 0x1,
1242     BT_8723B_1ANT_STATUS_INQ_PAGE                = 0x2,
1243     BT_8723B_1ANT_STATUS_ACL_BUSY                = 0x3,
1244     BT_8723B_1ANT_STATUS_SCO_BUSY                = 0x4,
1245     BT_8723B_1ANT_STATUS_ACL_SCO_BUSY            = 0x5,
1246     BT_8723B_1ANT_STATUS_MAX
1247 };
1248 
1249 struct rtl8xxxu_btcoex {
1250     u8      bt_status;
1251     bool    bt_busy;
1252     bool    has_sco;
1253     bool    has_a2dp;
1254     bool    has_hid;
1255     bool    has_pan;
1256     bool    hid_only;
1257     bool    a2dp_only;
1258     bool    c2h_bt_inquiry;
1259 };
1260 
1261 #define RTL8XXXU_RATR_STA_INIT 0
1262 #define RTL8XXXU_RATR_STA_HIGH 1
1263 #define RTL8XXXU_RATR_STA_MID  2
1264 #define RTL8XXXU_RATR_STA_LOW  3
1265 
1266 #define RTL8XXXU_NOISE_FLOOR_MIN    -100
1267 #define RTL8XXXU_SNR_THRESH_HIGH    50
1268 #define RTL8XXXU_SNR_THRESH_LOW 20
1269 
1270 struct rtl8xxxu_ra_report {
1271     struct rate_info txrate;
1272     u32 bit_rate;
1273     u8 desc_rate;
1274 };
1275 
1276 struct rtl8xxxu_priv {
1277     struct ieee80211_hw *hw;
1278     struct usb_device *udev;
1279     struct rtl8xxxu_fileops *fops;
1280 
1281     spinlock_t tx_urb_lock;
1282     struct list_head tx_urb_free_list;
1283     int tx_urb_free_count;
1284     bool tx_stopped;
1285 
1286     spinlock_t rx_urb_lock;
1287     struct list_head rx_urb_pending_list;
1288     int rx_urb_pending_count;
1289     bool shutdown;
1290     struct work_struct rx_urb_wq;
1291 
1292     u8 mac_addr[ETH_ALEN];
1293     char chip_name[8];
1294     char chip_vendor[8];
1295     u8 cck_tx_power_index_A[RTL8XXXU_MAX_CHANNEL_GROUPS];
1296     u8 cck_tx_power_index_B[RTL8XXXU_MAX_CHANNEL_GROUPS];
1297     u8 ht40_1s_tx_power_index_A[RTL8XXXU_MAX_CHANNEL_GROUPS];
1298     u8 ht40_1s_tx_power_index_B[RTL8XXXU_MAX_CHANNEL_GROUPS];
1299     /*
1300      * The following entries are half-bytes split as:
1301      * bits 0-3: path A, bits 4-7: path B, all values 4 bits signed
1302      */
1303     struct rtl8723au_idx ht40_2s_tx_power_index_diff[
1304         RTL8723A_CHANNEL_GROUPS];
1305     struct rtl8723au_idx ht20_tx_power_index_diff[RTL8723A_CHANNEL_GROUPS];
1306     struct rtl8723au_idx ofdm_tx_power_index_diff[RTL8723A_CHANNEL_GROUPS];
1307     struct rtl8723au_idx ht40_max_power_offset[RTL8723A_CHANNEL_GROUPS];
1308     struct rtl8723au_idx ht20_max_power_offset[RTL8723A_CHANNEL_GROUPS];
1309     /*
1310      * Newer generation chips only keep power diffs per TX count,
1311      * not per channel group.
1312      */
1313     struct rtl8723au_idx ofdm_tx_power_diff[RTL8723B_TX_COUNT];
1314     struct rtl8723au_idx ht20_tx_power_diff[RTL8723B_TX_COUNT];
1315     struct rtl8723au_idx ht40_tx_power_diff[RTL8723B_TX_COUNT];
1316     struct rtl8xxxu_power_base *power_base;
1317     u32 chip_cut:4;
1318     u32 rom_rev:4;
1319     u32 is_multi_func:1;
1320     u32 has_wifi:1;
1321     u32 has_bluetooth:1;
1322     u32 enable_bluetooth:1;
1323     u32 has_gps:1;
1324     u32 hi_pa:1;
1325     u32 vendor_umc:1;
1326     u32 vendor_smic:1;
1327     u32 has_polarity_ctrl:1;
1328     u32 has_eeprom:1;
1329     u32 boot_eeprom:1;
1330     u32 usb_interrupts:1;
1331     u32 ep_tx_high_queue:1;
1332     u32 ep_tx_normal_queue:1;
1333     u32 ep_tx_low_queue:1;
1334     u32 has_xtalk:1;
1335     u32 rx_buf_aggregation:1;
1336     u8 xtalk;
1337     unsigned int pipe_interrupt;
1338     unsigned int pipe_in;
1339     unsigned int pipe_out[TXDESC_QUEUE_MAX];
1340     u8 out_ep[RTL8XXXU_OUT_ENDPOINTS];
1341     u8 ep_tx_count;
1342     u8 rf_paths;
1343     u8 rx_paths;
1344     u8 tx_paths;
1345     u32 rege94;
1346     u32 rege9c;
1347     u32 regeb4;
1348     u32 regebc;
1349     int next_mbox;
1350     int nr_out_eps;
1351 
1352     struct mutex h2c_mutex;
1353 
1354     struct usb_anchor rx_anchor;
1355     struct usb_anchor tx_anchor;
1356     struct usb_anchor int_anchor;
1357     struct rtl8xxxu_firmware_header *fw_data;
1358     size_t fw_size;
1359     struct mutex usb_buf_mutex;
1360     union {
1361         __le32 val32;
1362         __le16 val16;
1363         u8 val8;
1364     } usb_buf;
1365     union {
1366         u8 raw[EFUSE_MAP_LEN];
1367         struct rtl8723au_efuse efuse8723;
1368         struct rtl8723bu_efuse efuse8723bu;
1369         struct rtl8192cu_efuse efuse8192;
1370         struct rtl8192eu_efuse efuse8192eu;
1371     } efuse_wifi;
1372     u32 adda_backup[RTL8XXXU_ADDA_REGS];
1373     u32 mac_backup[RTL8XXXU_MAC_REGS];
1374     u32 bb_backup[RTL8XXXU_BB_REGS];
1375     u32 bb_recovery_backup[RTL8XXXU_BB_REGS];
1376     enum rtl8xxxu_rtl_chip rtl_chip;
1377     u8 pi_enabled:1;
1378     u8 no_pape:1;
1379     u8 int_buf[USB_INTR_CONTENT_LENGTH];
1380     u8 rssi_level;
1381     DECLARE_BITMAP(tx_aggr_started, IEEE80211_NUM_TIDS);
1382     DECLARE_BITMAP(tid_tx_operational, IEEE80211_NUM_TIDS);
1383     /*
1384      * Only one virtual interface permitted because only STA mode
1385      * is supported and no iface_combinations are provided.
1386      */
1387     struct ieee80211_vif *vif;
1388     struct delayed_work ra_watchdog;
1389     struct work_struct c2hcmd_work;
1390     struct sk_buff_head c2hcmd_queue;
1391     struct rtl8xxxu_btcoex bt_coex;
1392     struct rtl8xxxu_ra_report ra_report;
1393 };
1394 
1395 struct rtl8xxxu_rx_urb {
1396     struct urb urb;
1397     struct ieee80211_hw *hw;
1398     struct list_head list;
1399 };
1400 
1401 struct rtl8xxxu_tx_urb {
1402     struct urb urb;
1403     struct ieee80211_hw *hw;
1404     struct list_head list;
1405 };
1406 
1407 struct rtl8xxxu_fileops {
1408     int (*parse_efuse) (struct rtl8xxxu_priv *priv);
1409     int (*load_firmware) (struct rtl8xxxu_priv *priv);
1410     int (*power_on) (struct rtl8xxxu_priv *priv);
1411     void (*power_off) (struct rtl8xxxu_priv *priv);
1412     void (*reset_8051) (struct rtl8xxxu_priv *priv);
1413     int (*llt_init) (struct rtl8xxxu_priv *priv);
1414     void (*init_phy_bb) (struct rtl8xxxu_priv *priv);
1415     int (*init_phy_rf) (struct rtl8xxxu_priv *priv);
1416     void (*phy_init_antenna_selection) (struct rtl8xxxu_priv *priv);
1417     void (*phy_iq_calibrate) (struct rtl8xxxu_priv *priv);
1418     void (*config_channel) (struct ieee80211_hw *hw);
1419     int (*parse_rx_desc) (struct rtl8xxxu_priv *priv, struct sk_buff *skb);
1420     void (*init_aggregation) (struct rtl8xxxu_priv *priv);
1421     void (*init_statistics) (struct rtl8xxxu_priv *priv);
1422     void (*enable_rf) (struct rtl8xxxu_priv *priv);
1423     void (*disable_rf) (struct rtl8xxxu_priv *priv);
1424     void (*usb_quirks) (struct rtl8xxxu_priv *priv);
1425     void (*set_tx_power) (struct rtl8xxxu_priv *priv, int channel,
1426                   bool ht40);
1427     void (*update_rate_mask) (struct rtl8xxxu_priv *priv,
1428                   u32 ramask, u8 rateid, int sgi);
1429     void (*report_connect) (struct rtl8xxxu_priv *priv,
1430                 u8 macid, bool connect);
1431     void (*fill_txdesc) (struct ieee80211_hw *hw, struct ieee80211_hdr *hdr,
1432                  struct ieee80211_tx_info *tx_info,
1433                  struct rtl8xxxu_txdesc32 *tx_desc, bool sgi,
1434                  bool short_preamble, bool ampdu_enable,
1435                  u32 rts_rate);
1436     int writeN_block_size;
1437     int rx_agg_buf_size;
1438     char tx_desc_size;
1439     char rx_desc_size;
1440     u8 has_s0s1:1;
1441     u8 has_tx_report:1;
1442     u8 gen2_thermal_meter:1;
1443     u8 needs_full_init:1;
1444     u32 adda_1t_init;
1445     u32 adda_1t_path_on;
1446     u32 adda_2t_path_on_a;
1447     u32 adda_2t_path_on_b;
1448     u16 trxff_boundary;
1449     u8 pbp_rx;
1450     u8 pbp_tx;
1451     struct rtl8xxxu_reg8val *mactable;
1452     u8 total_page_num;
1453     u8 page_num_hi;
1454     u8 page_num_lo;
1455     u8 page_num_norm;
1456 };
1457 
1458 extern int rtl8xxxu_debug;
1459 
1460 extern struct rtl8xxxu_reg8val rtl8xxxu_gen1_mac_init_table[];
1461 extern const u32 rtl8xxxu_iqk_phy_iq_bb_reg[];
1462 u8 rtl8xxxu_read8(struct rtl8xxxu_priv *priv, u16 addr);
1463 u16 rtl8xxxu_read16(struct rtl8xxxu_priv *priv, u16 addr);
1464 u32 rtl8xxxu_read32(struct rtl8xxxu_priv *priv, u16 addr);
1465 int rtl8xxxu_write8(struct rtl8xxxu_priv *priv, u16 addr, u8 val);
1466 int rtl8xxxu_write16(struct rtl8xxxu_priv *priv, u16 addr, u16 val);
1467 int rtl8xxxu_write32(struct rtl8xxxu_priv *priv, u16 addr, u32 val);
1468 u32 rtl8xxxu_read_rfreg(struct rtl8xxxu_priv *priv,
1469             enum rtl8xxxu_rfpath path, u8 reg);
1470 int rtl8xxxu_write_rfreg(struct rtl8xxxu_priv *priv,
1471              enum rtl8xxxu_rfpath path, u8 reg, u32 data);
1472 void rtl8xxxu_save_regs(struct rtl8xxxu_priv *priv, const u32 *regs,
1473             u32 *backup, int count);
1474 void rtl8xxxu_restore_regs(struct rtl8xxxu_priv *priv, const u32 *regs,
1475                u32 *backup, int count);
1476 void rtl8xxxu_save_mac_regs(struct rtl8xxxu_priv *priv,
1477                 const u32 *reg, u32 *backup);
1478 void rtl8xxxu_restore_mac_regs(struct rtl8xxxu_priv *priv,
1479                    const u32 *reg, u32 *backup);
1480 void rtl8xxxu_path_adda_on(struct rtl8xxxu_priv *priv, const u32 *regs,
1481                bool path_a_on);
1482 void rtl8xxxu_mac_calibration(struct rtl8xxxu_priv *priv,
1483                   const u32 *regs, u32 *backup);
1484 void rtl8xxxu_fill_iqk_matrix_a(struct rtl8xxxu_priv *priv, bool iqk_ok,
1485                 int result[][8], int candidate, bool tx_only);
1486 void rtl8xxxu_fill_iqk_matrix_b(struct rtl8xxxu_priv *priv, bool iqk_ok,
1487                 int result[][8], int candidate, bool tx_only);
1488 int rtl8xxxu_init_phy_rf(struct rtl8xxxu_priv *priv,
1489              struct rtl8xxxu_rfregval *table,
1490              enum rtl8xxxu_rfpath path);
1491 int rtl8xxxu_init_phy_regs(struct rtl8xxxu_priv *priv,
1492                struct rtl8xxxu_reg32val *array);
1493 int rtl8xxxu_load_firmware(struct rtl8xxxu_priv *priv, char *fw_name);
1494 void rtl8xxxu_firmware_self_reset(struct rtl8xxxu_priv *priv);
1495 void rtl8xxxu_power_off(struct rtl8xxxu_priv *priv);
1496 void rtl8xxxu_reset_8051(struct rtl8xxxu_priv *priv);
1497 int rtl8xxxu_auto_llt_table(struct rtl8xxxu_priv *priv);
1498 void rtl8xxxu_gen2_prepare_calibrate(struct rtl8xxxu_priv *priv, u8 start);
1499 int rtl8xxxu_flush_fifo(struct rtl8xxxu_priv *priv);
1500 int rtl8xxxu_gen2_h2c_cmd(struct rtl8xxxu_priv *priv,
1501               struct h2c_cmd *h2c, int len);
1502 int rtl8xxxu_active_to_lps(struct rtl8xxxu_priv *priv);
1503 void rtl8xxxu_disabled_to_emu(struct rtl8xxxu_priv *priv);
1504 int rtl8xxxu_init_llt_table(struct rtl8xxxu_priv *priv);
1505 void rtl8xxxu_gen1_phy_iq_calibrate(struct rtl8xxxu_priv *priv);
1506 void rtl8xxxu_gen1_init_phy_bb(struct rtl8xxxu_priv *priv);
1507 void rtl8xxxu_gen1_set_tx_power(struct rtl8xxxu_priv *priv,
1508                 int channel, bool ht40);
1509 void rtl8xxxu_gen1_config_channel(struct ieee80211_hw *hw);
1510 void rtl8xxxu_gen2_config_channel(struct ieee80211_hw *hw);
1511 void rtl8xxxu_gen1_usb_quirks(struct rtl8xxxu_priv *priv);
1512 void rtl8xxxu_gen2_usb_quirks(struct rtl8xxxu_priv *priv);
1513 void rtl8xxxu_update_rate_mask(struct rtl8xxxu_priv *priv,
1514                    u32 ramask, u8 rateid, int sgi);
1515 void rtl8xxxu_gen2_update_rate_mask(struct rtl8xxxu_priv *priv,
1516                     u32 ramask, u8 rateid, int sgi);
1517 void rtl8xxxu_gen1_report_connect(struct rtl8xxxu_priv *priv,
1518                   u8 macid, bool connect);
1519 void rtl8xxxu_gen2_report_connect(struct rtl8xxxu_priv *priv,
1520                   u8 macid, bool connect);
1521 void rtl8xxxu_gen1_init_aggregation(struct rtl8xxxu_priv *priv);
1522 void rtl8xxxu_gen1_enable_rf(struct rtl8xxxu_priv *priv);
1523 void rtl8xxxu_gen1_disable_rf(struct rtl8xxxu_priv *priv);
1524 void rtl8xxxu_gen2_disable_rf(struct rtl8xxxu_priv *priv);
1525 int rtl8xxxu_parse_rxdesc16(struct rtl8xxxu_priv *priv, struct sk_buff *skb);
1526 int rtl8xxxu_parse_rxdesc24(struct rtl8xxxu_priv *priv, struct sk_buff *skb);
1527 int rtl8xxxu_gen2_channel_to_group(int channel);
1528 bool rtl8xxxu_gen2_simularity_compare(struct rtl8xxxu_priv *priv,
1529                       int result[][8], int c1, int c2);
1530 void rtl8xxxu_fill_txdesc_v1(struct ieee80211_hw *hw, struct ieee80211_hdr *hdr,
1531                  struct ieee80211_tx_info *tx_info,
1532                  struct rtl8xxxu_txdesc32 *tx_desc, bool sgi,
1533                  bool short_preamble, bool ampdu_enable,
1534                  u32 rts_rate);
1535 void rtl8xxxu_fill_txdesc_v2(struct ieee80211_hw *hw, struct ieee80211_hdr *hdr,
1536                  struct ieee80211_tx_info *tx_info,
1537                  struct rtl8xxxu_txdesc32 *tx_desc32, bool sgi,
1538                  bool short_preamble, bool ampdu_enable,
1539                  u32 rts_rate);
1540 void rtl8723bu_set_ps_tdma(struct rtl8xxxu_priv *priv,
1541                u8 arg1, u8 arg2, u8 arg3, u8 arg4, u8 arg5);
1542 
1543 extern struct rtl8xxxu_fileops rtl8192cu_fops;
1544 extern struct rtl8xxxu_fileops rtl8192eu_fops;
1545 extern struct rtl8xxxu_fileops rtl8723au_fops;
1546 extern struct rtl8xxxu_fileops rtl8723bu_fops;