Home | History | Annotate | Line # | Download | only in ic
rtwphyio.c revision 1.4
      1 /* $NetBSD: rtwphyio.c,v 1.4 2004/12/25 06:58:37 dyoung Exp $ */
      2 /*-
      3  * Copyright (c) 2004, 2005 David Young.  All rights reserved.
      4  *
      5  * Programmed for NetBSD by David Young.
      6  *
      7  * Redistribution and use in source and binary forms, with or without
      8  * modification, are permitted provided that the following conditions
      9  * are met:
     10  * 1. Redistributions of source code must retain the above copyright
     11  *    notice, this list of conditions and the following disclaimer.
     12  * 2. Redistributions in binary form must reproduce the above copyright
     13  *    notice, this list of conditions and the following disclaimer in the
     14  *    documentation and/or other materials provided with the distribution.
     15  * 3. The name of David Young may not be used to endorse or promote
     16  *    products derived from this software without specific prior
     17  *    written permission.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY David Young ``AS IS'' AND ANY
     20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
     21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
     22  * PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL David
     23  * Young BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
     25  * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
     27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
     28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
     30  * OF SUCH DAMAGE.
     31  */
     32 /*
     33  * Control input/output with the Philips SA2400 RF front-end and
     34  * the baseband processor built into the Realtek RTL8180.
     35  */
     36 
     37 #include <sys/cdefs.h>
     38 __KERNEL_RCSID(0, "$NetBSD: rtwphyio.c,v 1.4 2004/12/25 06:58:37 dyoung Exp $");
     39 
     40 #include <sys/param.h>
     41 #include <sys/systm.h>
     42 #include <sys/types.h>
     43 
     44 #include <machine/bus.h>
     45 
     46 #include <net/if.h>
     47 #include <net/if_media.h>
     48 #include <net/if_ether.h>
     49 
     50 #include <net80211/ieee80211_var.h>
     51 #include <net80211/ieee80211_compat.h>
     52 #include <net80211/ieee80211_radiotap.h>
     53 
     54 #include <dev/ic/rtwreg.h>
     55 #include <dev/ic/max2820reg.h>
     56 #include <dev/ic/sa2400reg.h>
     57 #include <dev/ic/si4136reg.h>
     58 #include <dev/ic/rtwvar.h>
     59 #include <dev/ic/rtwphyio.h>
     60 #include <dev/ic/rtwphy.h>
     61 
     62 static int rtw_macbangbits_timeout = 100;
     63 
     64 u_int8_t
     65 rtw_bbp_read(struct rtw_regs *regs, u_int addr)
     66 {
     67 	KASSERT((addr & ~PRESHIFT(RTW_BB_ADDR_MASK)) == 0);
     68 	RTW_WRITE(regs, RTW_BB,
     69 	    LSHIFT(addr, RTW_BB_ADDR_MASK) | RTW_BB_RD_MASK | RTW_BB_WR_MASK);
     70 	delay(10);	/* XXX */
     71 	RTW_WBR(regs, RTW_BB, RTW_BB);
     72 	return MASK_AND_RSHIFT(RTW_READ(regs, RTW_BB), RTW_BB_RD_MASK);
     73 }
     74 
     75 int
     76 rtw_bbp_write(struct rtw_regs *regs, u_int addr, u_int val)
     77 {
     78 #define	BBP_WRITE_ITERS	50
     79 #define	BBP_WRITE_DELAY	1
     80 	int i;
     81 	uint32_t wrbbp, rdbbp;
     82 
     83 	RTW_DPRINTF(RTW_DEBUG_PHYIO,
     84 	    ("%s: bbp[%u] <- %u\n", __func__, addr, val));
     85 
     86 	KASSERT((addr & ~PRESHIFT(RTW_BB_ADDR_MASK)) == 0);
     87 	KASSERT((val & ~PRESHIFT(RTW_BB_WR_MASK)) == 0);
     88 
     89 	wrbbp = LSHIFT(addr, RTW_BB_ADDR_MASK) | RTW_BB_WREN |
     90 	    LSHIFT(val, RTW_BB_WR_MASK) | RTW_BB_RD_MASK,
     91 
     92 	rdbbp = LSHIFT(addr, RTW_BB_ADDR_MASK) |
     93 	    RTW_BB_WR_MASK | RTW_BB_RD_MASK;
     94 
     95 	RTW_DPRINTF(RTW_DEBUG_PHYIO,
     96 	    ("%s: rdbbp = %#08x, wrbbp = %#08x\n", __func__, rdbbp, wrbbp));
     97 
     98 	for (i = BBP_WRITE_ITERS; --i >= 0; ) {
     99 		RTW_RBW(regs, RTW_BB, RTW_BB);
    100 		RTW_WRITE(regs, RTW_BB, wrbbp);
    101 		RTW_SYNC(regs, RTW_BB, RTW_BB);
    102 		RTW_WRITE(regs, RTW_BB, rdbbp);
    103 		RTW_SYNC(regs, RTW_BB, RTW_BB);
    104 		delay(BBP_WRITE_DELAY);	/* 1 microsecond */
    105 		if (MASK_AND_RSHIFT(RTW_READ(regs, RTW_BB),
    106 		                    RTW_BB_RD_MASK) == val) {
    107 			RTW_DPRINTF(RTW_DEBUG_PHYIO,
    108 			    ("%s: finished in %dus\n", __func__,
    109 			    BBP_WRITE_DELAY * (BBP_WRITE_ITERS - i)));
    110 			return 0;
    111 		}
    112 		delay(BBP_WRITE_DELAY);	/* again */
    113 	}
    114 	printf("%s: timeout\n", __func__);
    115 	return -1;
    116 }
    117 
    118 /* Help rtw_rf_hostwrite bang bits to RF over 3-wire interface. */
    119 static __inline void
    120 rtw_rf_hostbangbits(struct rtw_regs *regs, u_int32_t bits, int lo_to_hi,
    121     u_int nbits)
    122 {
    123 	int i;
    124 	u_int32_t mask, reg;
    125 
    126 	KASSERT(nbits <= 32);
    127 
    128 	RTW_DPRINTF(RTW_DEBUG_PHYIO,
    129 	    ("%s: %u bits, %#08x, %s\n", __func__, nbits, bits,
    130 	    (lo_to_hi) ? "lo to hi" : "hi to lo"));
    131 
    132 	reg = RTW_PHYCFG_HST;
    133 	RTW_WRITE(regs, RTW_PHYCFG, reg);
    134 	RTW_SYNC(regs, RTW_PHYCFG, RTW_PHYCFG);
    135 
    136 	if (lo_to_hi)
    137 		mask = 0x1;
    138 	else
    139 		mask = 1 << (nbits - 1);
    140 
    141 	for (i = 0; i < nbits; i++) {
    142 		RTW_DPRINTF(RTW_DEBUG_PHYBITIO,
    143 		    ("%s: bits %#08x mask %#08x -> bit %#08x\n",
    144 		    __func__, bits, mask, bits & mask));
    145 
    146 		if ((bits & mask) != 0)
    147 			reg |= RTW_PHYCFG_HST_DATA;
    148 		else
    149 			reg &= ~RTW_PHYCFG_HST_DATA;
    150 
    151 		reg |= RTW_PHYCFG_HST_CLK;
    152 		RTW_WRITE(regs, RTW_PHYCFG, reg);
    153 		RTW_SYNC(regs, RTW_PHYCFG, RTW_PHYCFG);
    154 
    155 		DELAY(2);	/* arbitrary delay */
    156 
    157 		reg &= ~RTW_PHYCFG_HST_CLK;
    158 		RTW_WRITE(regs, RTW_PHYCFG, reg);
    159 		RTW_SYNC(regs, RTW_PHYCFG, RTW_PHYCFG);
    160 
    161 		if (lo_to_hi)
    162 			mask <<= 1;
    163 		else
    164 			mask >>= 1;
    165 	}
    166 
    167 	reg |= RTW_PHYCFG_HST_EN;
    168 	KASSERT((reg & RTW_PHYCFG_HST_CLK) == 0);
    169 	RTW_WRITE(regs, RTW_PHYCFG, reg);
    170 	RTW_SYNC(regs, RTW_PHYCFG, RTW_PHYCFG);
    171 }
    172 
    173 /* Help rtw_rf_macwrite: tell MAC to bang bits to RF over the 3-wire
    174  * interface.
    175  */
    176 static __inline int
    177 rtw_rf_macbangbits(struct rtw_regs *regs, u_int32_t reg)
    178 {
    179 	int i;
    180 
    181 	RTW_DPRINTF(RTW_DEBUG_PHY, ("%s: %#08x\n", __func__, reg));
    182 
    183 	RTW_WRITE(regs, RTW_PHYCFG, RTW_PHYCFG_MAC_POLL | reg);
    184 
    185 	RTW_WBR(regs, RTW_PHYCFG, RTW_PHYCFG);
    186 
    187 	if (rtw_flush_rfio)
    188 		RTW_READ(regs, RTW_PHYADDR);
    189 
    190 	if (rtw_rfio_delay > 0)
    191 		DELAY(rtw_rfio_delay);
    192 
    193 	for (i = rtw_macbangbits_timeout; --i >= 0; delay(1)) {
    194 		if ((RTW_READ(regs, RTW_PHYCFG) & RTW_PHYCFG_MAC_POLL) == 0) {
    195 			RTW_DPRINTF(RTW_DEBUG_PHY,
    196 			    ("%s: finished in %dus\n", __func__,
    197 			    rtw_macbangbits_timeout - i));
    198 			return 0;
    199 		}
    200 		RTW_RBR(regs, RTW_PHYCFG, RTW_PHYCFG);	/* XXX paranoia? */
    201 	}
    202 
    203 	printf("%s: RTW_PHYCFG_MAC_POLL still set.\n", __func__);
    204 	return -1;
    205 }
    206 
    207 static u_int32_t
    208 rtw_grf5101_host_crypt(u_int addr, u_int32_t val)
    209 {
    210 	/* TBD */
    211 	return 0;
    212 }
    213 
    214 static u_int32_t
    215 rtw_grf5101_mac_crypt(u_int addr, u_int32_t val)
    216 {
    217 	u_int32_t data_and_addr;
    218 #define EXTRACT_NIBBLE(d, which) (((d) >> (4 * (which))) & 0xf)
    219 	static u_int8_t caesar[16] = {0x0, 0x8, 0x4, 0xc,
    220 	                              0x2, 0xa, 0x6, 0xe,
    221 				      0x1, 0x9, 0x5, 0xd,
    222 				      0x3, 0xb, 0x7, 0xf};
    223 
    224 	data_and_addr =  caesar[EXTRACT_NIBBLE(val, 2)] |
    225 	                (caesar[EXTRACT_NIBBLE(val, 1)] <<  4) |
    226 	                (caesar[EXTRACT_NIBBLE(val, 0)] <<  8) |
    227 	                (caesar[(addr >> 1) & 0xf]      << 12) |
    228 	                ((addr & 0x1)                   << 16) |
    229 	                (caesar[EXTRACT_NIBBLE(val, 3)] << 24);
    230 	return LSHIFT(data_and_addr,
    231 	    RTW_PHYCFG_MAC_PHILIPS_ADDR_MASK|RTW_PHYCFG_MAC_PHILIPS_DATA_MASK);
    232 #undef EXTRACT_NIBBLE
    233 }
    234 
    235 static __inline const char *
    236 rtw_rfchipid_string(enum rtw_rfchipid rfchipid)
    237 {
    238 	switch (rfchipid) {
    239 	case RTW_RFCHIPID_MAXIM:
    240 		return "Maxim";
    241 	case RTW_RFCHIPID_PHILIPS:
    242 		return "Philips";
    243 	case RTW_RFCHIPID_GCT:
    244 		return "GCT";
    245 	case RTW_RFCHIPID_RFMD:
    246 		return "RFMD";
    247 	case RTW_RFCHIPID_INTERSIL:
    248 		return "Intersil";
    249 	default:
    250 		return "unknown";
    251 	}
    252 }
    253 
    254 /* Bang bits over the 3-wire interface. */
    255 int
    256 rtw_rf_hostwrite(struct rtw_regs *regs, enum rtw_rfchipid rfchipid,
    257     u_int addr, u_int32_t val)
    258 {
    259 	u_int nbits;
    260 	int lo_to_hi;
    261 	u_int32_t bits;
    262 
    263 	RTW_DPRINTF(RTW_DEBUG_PHYIO, ("%s: %s[%u] <- %#08x\n", __func__,
    264 	    rtw_rfchipid_string(rfchipid), addr, val));
    265 
    266 	switch (rfchipid) {
    267 	case RTW_RFCHIPID_MAXIM:
    268 		nbits = 16;
    269 		lo_to_hi = 0;
    270 		bits = LSHIFT(val, MAX2820_TWI_DATA_MASK) |
    271 		       LSHIFT(addr, MAX2820_TWI_ADDR_MASK);
    272 		break;
    273 	case RTW_RFCHIPID_PHILIPS:
    274 		KASSERT((addr & ~PRESHIFT(SA2400_TWI_ADDR_MASK)) == 0);
    275 		KASSERT((val & ~PRESHIFT(SA2400_TWI_DATA_MASK)) == 0);
    276 		bits = LSHIFT(val, SA2400_TWI_DATA_MASK) |
    277 		       LSHIFT(addr, SA2400_TWI_ADDR_MASK) | SA2400_TWI_WREN;
    278 		nbits = 32;
    279 		lo_to_hi = 1;
    280 		break;
    281 	case RTW_RFCHIPID_GCT:
    282 	case RTW_RFCHIPID_RFMD:
    283 		KASSERT((addr & ~PRESHIFT(SI4126_TWI_ADDR_MASK)) == 0);
    284 		KASSERT((val & ~PRESHIFT(SI4126_TWI_DATA_MASK)) == 0);
    285 		if (rfchipid == RTW_RFCHIPID_GCT)
    286 			bits = rtw_grf5101_host_crypt(addr, val);
    287 		else {
    288 			bits = LSHIFT(val, SI4126_TWI_DATA_MASK) |
    289 			       LSHIFT(addr, SI4126_TWI_ADDR_MASK);
    290 		}
    291 		nbits = 22;
    292 		lo_to_hi = 0;
    293 		break;
    294 	case RTW_RFCHIPID_INTERSIL:
    295 	default:
    296 		printf("%s: unknown rfchipid %d\n", __func__, rfchipid);
    297 		return -1;
    298 	}
    299 
    300 	rtw_rf_hostbangbits(regs, bits, lo_to_hi, nbits);
    301 
    302 	return 0;
    303 }
    304 
    305 static uint32_t
    306 rtw_maxim_swizzle(u_int addr, uint32_t val)
    307 {
    308 	uint32_t hidata, lodata;
    309 
    310 	KASSERT((val & ~(RTW_MAXIM_LODATA_MASK|RTW_MAXIM_HIDATA_MASK)) == 0);
    311 	lodata = MASK_AND_RSHIFT(val, RTW_MAXIM_LODATA_MASK);
    312 	hidata = MASK_AND_RSHIFT(val, RTW_MAXIM_HIDATA_MASK);
    313 	return LSHIFT(lodata, RTW_PHYCFG_MAC_MAXIM_LODATA_MASK) |
    314 	    LSHIFT(hidata, RTW_PHYCFG_MAC_MAXIM_HIDATA_MASK) |
    315 	    LSHIFT(addr, RTW_PHYCFG_MAC_MAXIM_ADDR_MASK);
    316 }
    317 
    318 /* Tell the MAC what to bang over the 3-wire interface. */
    319 int
    320 rtw_rf_macwrite(struct rtw_regs *regs, enum rtw_rfchipid rfchipid,
    321     u_int addr, u_int32_t val)
    322 {
    323 	uint32_t reg;
    324 
    325 	RTW_DPRINTF(RTW_DEBUG_PHYIO, ("%s: %s[%u] <- %#08x\n", __func__,
    326 	    rtw_rfchipid_string(rfchipid), addr, val));
    327 
    328 	switch (rfchipid) {
    329 	case RTW_RFCHIPID_GCT:
    330 		reg = rtw_grf5101_mac_crypt(addr, val);
    331 		break;
    332 	case RTW_RFCHIPID_MAXIM:
    333 		reg = rtw_maxim_swizzle(addr, val);
    334 		break;
    335 	default:		/* XXX */
    336 	case RTW_RFCHIPID_PHILIPS:
    337 		KASSERT(
    338 		    (addr & ~PRESHIFT(RTW_PHYCFG_MAC_PHILIPS_ADDR_MASK)) == 0);
    339 		KASSERT(
    340 		    (val & ~PRESHIFT(RTW_PHYCFG_MAC_PHILIPS_DATA_MASK)) == 0);
    341 
    342 		reg = LSHIFT(addr, RTW_PHYCFG_MAC_PHILIPS_ADDR_MASK) |
    343 		      LSHIFT(val, RTW_PHYCFG_MAC_PHILIPS_DATA_MASK);
    344 	}
    345 
    346 	switch (rfchipid) {
    347 	case RTW_RFCHIPID_GCT:
    348 	case RTW_RFCHIPID_MAXIM:
    349 	case RTW_RFCHIPID_RFMD:
    350 		reg |= RTW_PHYCFG_MAC_RFTYPE_RFMD;
    351 		break;
    352 	case RTW_RFCHIPID_INTERSIL:
    353 		reg |= RTW_PHYCFG_MAC_RFTYPE_INTERSIL;
    354 		break;
    355 	case RTW_RFCHIPID_PHILIPS:
    356 		reg |= RTW_PHYCFG_MAC_RFTYPE_PHILIPS;
    357 		break;
    358 	default:
    359 		printf("%s: unknown rfchipid %d\n", __func__, rfchipid);
    360 		return -1;
    361 	}
    362 
    363 	return rtw_rf_macbangbits(regs, reg);
    364 }
    365