sys/dev/netif/acx/acxcmd.c

   1 /*
   2  * Copyright (c) 2006 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Sepherosa Ziehau <sepherosa@gmail.com>
   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  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $DragonFly: src/sys/dev/netif/acx/acxcmd.c,v 1.10 2008/01/15 09:01:13 sephe Exp $
  35  */
  36
  37 #include <sys/param.h>
  38 #include <sys/bus.h>
  39 #include <sys/endian.h>
  40 #include <sys/kernel.h>
  41 #include <sys/rman.h>
  42 #include <sys/socket.h>
  43 #include <sys/sysctl.h>
  44
  45 #include <net/if.h>
  46 #include <net/if_arp.h>
  47 #include <net/if_media.h>
  48
  49 #include <netproto/802_11/ieee80211_var.h>
  50 #include <netproto/802_11/ieee80211_radiotap.h>
  51 #include <netproto/802_11/wlan_ratectl/amrr/ieee80211_amrr_param.h>
  52 #include <netproto/802_11/wlan_ratectl/onoe/ieee80211_onoe_param.h>
  53
  54 #define ACX_DEBUG
  55
  56 #include <dev/netif/acx/if_acxreg.h>
  57 #include <dev/netif/acx/if_acxvar.h>
  58 #include <dev/netif/acx/acxcmd.h>
  59
  60 #define CMDPRM_WRITE_REGION_1(sc, r, rlen)              \
  61         bus_space_write_region_1((sc)->sc_mem2_bt,      \
  62                                  (sc)->sc_mem2_bh,      \
  63                                  (sc)->sc_cmd_param,    \
  64                                  (const uint8_t *)(r), (rlen))
  65
  66 #define CMDPRM_READ_REGION_1(sc, r, rlen)                               \
  67         bus_space_read_region_1((sc)->sc_mem2_bt, (sc)->sc_mem2_bh,     \
  68                                 (sc)->sc_cmd_param, (uint8_t *)(r), (rlen))
  69
  70 /*
  71  * This will clear previous command's
  72  * execution status too
  73  */
  74 #define CMD_WRITE_4(sc, val)                                    \
  75         bus_space_write_4((sc)->sc_mem2_bt, (sc)->sc_mem2_bh,   \
  76                           (sc)->sc_cmd, (val))
  77 #define CMD_READ_4(sc)          \
  78         bus_space_read_4((sc)->sc_mem2_bt, (sc)->sc_mem2_bh, (sc)->sc_cmd)
  79
  80 /*
  81  * acx command register layerout:
  82  * upper 16bits are command execution status
  83  * lower 16bits are command to be executed
  84  */
  85 #define ACX_CMD_STATUS_SHIFT    16
  86 #define ACX_CMD_STATUS_OK       1
  87
  88 struct radio_init {
  89         uint32_t        radio_ofs;      /* radio firmware offset */
  90         uint32_t        radio_len;      /* radio firmware length */
  91 } __packed;
  92
  93 struct bss_join_hdr {
  94         uint8_t         bssid[IEEE80211_ADDR_LEN];
  95         uint16_t        beacon_intvl;
  96         uint8_t         chip_spec[3];
  97         uint8_t         ndata_txrate;   /* see ACX_NDATA_TXRATE_ */
  98         uint8_t         ndata_txopt;    /* see ACX_NDATA_TXOPT_ */
  99         uint8_t         mode;           /* see ACX_MODE_ */
 100         uint8_t         channel;
 101         uint8_t         esslen;
 102         char            essid[1];
 103 } __packed;
 104
 105 /*
 106  * non-data frame tx rate
 107  */
 108 #define ACX_NDATA_TXRATE_2              20      /* 2Mbits/s */
 109
 110 /*
 111  * non-data frame tx options
 112  */
 113 #define ACX_NDATA_TXOPT_PBCC            0x40
 114 #define ACX_NDATA_TXOPT_OFDM            0x20
 115 #define ACX_NDATA_TXOPT_SHORT_PREAMBLE  0x10
 116
 117 #define BSS_JOIN_BUFLEN         \
 118         (sizeof(struct bss_join_hdr) + IEEE80211_NWID_LEN)
 119 #define BSS_JOIN_PARAM_SIZE(bj) \
 120         (sizeof(struct bss_join_hdr) + (bj)->esslen)
 121
 122 void
 123 acx_init_cmd_reg(struct acx_softc *sc)
 124 {
 125         sc->sc_cmd = CSR_READ_4(sc, ACXREG_CMD_REG_OFFSET);
 126         sc->sc_cmd_param = sc->sc_cmd + ACX_CMD_REG_SIZE;
 127
 128         /* Clear command & status */
 129         CMD_WRITE_4(sc, 0);
 130 }
 131
 132 int
 133 acx_join_bss(struct acx_softc *sc, uint8_t mode, struct ieee80211_node *ni,
 134              struct ieee80211_channel *c)
 135 {
 136         uint8_t bj_buf[BSS_JOIN_BUFLEN];
 137         struct ieee80211com *ic = &sc->sc_ic;
 138         struct bss_join_hdr *bj;
 139         int i;
 140
 141         bzero(bj_buf, sizeof(bj_buf));
 142         bj = (struct bss_join_hdr *)bj_buf;
 143
 144         for (i = 0; i < IEEE80211_ADDR_LEN; ++i)
 145                 bj->bssid[i] = ni->ni_bssid[IEEE80211_ADDR_LEN - i - 1];
 146
 147         bj->beacon_intvl = htole16(ni->ni_intval);
 148
 149         sc->chip_set_bss_join_param(sc, bj->chip_spec, ic->ic_dtim_period);
 150
 151         bj->ndata_txrate = ACX_NDATA_TXRATE_2;
 152         bj->ndata_txopt = 0;
 153         bj->mode = mode;
 154         bj->channel = ieee80211_chan2ieee(ic, c);
 155         bj->esslen = ni->ni_esslen;
 156         bcopy(ni->ni_essid, bj->essid, ni->ni_esslen);
 157
 158         DPRINTF((&ic->ic_if, "join BSS/IBSS on channel %d\n", bj->channel));
 159         return acx_exec_command(sc, ACXCMD_JOIN_BSS,
 160                                 bj, BSS_JOIN_PARAM_SIZE(bj), NULL, 0);
 161 }
 162
 163 int
 164 acx_enable_txchan(struct acx_softc *sc, uint8_t chan)
 165 {
 166         return acx_exec_command(sc, ACXCMD_ENABLE_TXCHAN, &chan, sizeof(chan),
 167                                 NULL, 0);
 168 }
 169
 170 int
 171 acx_enable_rxchan(struct acx_softc *sc, uint8_t chan)
 172 {
 173         return acx_exec_command(sc, ACXCMD_ENABLE_RXCHAN, &chan, sizeof(chan),
 174                                 NULL, 0);
 175 }
 176
 177 int
 178 acx_get_conf(struct acx_softc *sc, uint16_t conf_id, void *conf,
 179              uint16_t conf_len)
 180 {
 181         struct acx_conf *confcom;
 182
 183         if (conf_len < sizeof(*confcom)) {
 184                 if_printf(&sc->sc_ic.ic_if, "%s configure data is too short\n",
 185                           __func__);
 186                 return 1;
 187         }
 188
 189         confcom = conf;
 190         confcom->conf_id = htole16(conf_id);
 191         confcom->conf_data_len = htole16(conf_len - sizeof(*confcom));
 192
 193         return acx_exec_command(sc, ACXCMD_GET_CONF, confcom, sizeof(*confcom),
 194                                 conf, conf_len);
 195 }
 196
 197 int
 198 acx_set_conf(struct acx_softc *sc, uint16_t conf_id, void *conf,
 199              uint16_t conf_len)
 200 {
 201         struct acx_conf *confcom;
 202
 203         if (conf_len < sizeof(*confcom)) {
 204                 if_printf(&sc->sc_ic.ic_if, "%s configure data is too short\n",
 205                           __func__);
 206                 return 1;
 207         }
 208
 209         confcom = conf;
 210         confcom->conf_id = htole16(conf_id);
 211         confcom->conf_data_len = htole16(conf_len - sizeof(*confcom));
 212
 213         return acx_exec_command(sc, ACXCMD_SET_CONF, conf, conf_len, NULL, 0);
 214 }
 215
 216 int
 217 acx_set_tmplt(struct acx_softc *sc, uint16_t cmd, void *tmplt,
 218               uint16_t tmplt_len)
 219 {
 220         uint16_t *size;
 221
 222         if (tmplt_len < sizeof(*size)) {
 223                 if_printf(&sc->sc_ic.ic_if, "%s template is too short\n",
 224                           __func__);
 225                 return 1;
 226         }
 227
 228         size = tmplt;
 229         *size = htole16(tmplt_len - sizeof(*size));
 230
 231         return acx_exec_command(sc, cmd, tmplt, tmplt_len, NULL, 0);
 232 }
 233
 234 int
 235 acx_init_radio(struct acx_softc *sc, uint32_t radio_ofs, uint32_t radio_len)
 236 {
 237         struct radio_init r;
 238
 239         r.radio_ofs = htole32(radio_ofs);
 240         r.radio_len = htole32(radio_len);
 241         return acx_exec_command(sc, ACXCMD_INIT_RADIO, &r, sizeof(r), NULL, 0);
 242 }
 243
 244 int
 245 acx_exec_command(struct acx_softc *sc, uint16_t cmd, void *param,
 246                  uint16_t param_len, void *result, uint16_t result_len)
 247 {
 248         uint16_t status;
 249         int i, ret;
 250
 251         ASSERT_SERIALIZED(sc->sc_ic.ic_if.if_serializer);
 252
 253         if ((sc->sc_flags & ACX_FLAG_FW_LOADED) == 0) {
 254                 if_printf(&sc->sc_ic.ic_if, "cmd 0x%04x failed (base firmware "
 255                           "not loaded)", cmd);
 256                 return 1;
 257         }
 258
 259         ret = 0;
 260
 261         if (param != NULL && param_len != 0) {
 262                 /* Set command param */
 263                 CMDPRM_WRITE_REGION_1(sc, param, param_len);
 264         }
 265
 266         /* Set command */
 267         CMD_WRITE_4(sc, cmd);
 268
 269         /* Exec command */
 270         CSR_WRITE_2(sc, ACXREG_INTR_TRIG, ACXRV_TRIG_CMD_FINI);
 271         DELAY(50);      /* XXX maybe 100 */
 272
 273         /* Wait for command to complete */
 274         if (cmd == ACXCMD_INIT_RADIO) {
 275                 /* XXX radio initialization is extremely long */
 276                 tsleep(&cmd, 0, "rdinit", (150 * hz) / 1000);   /* 150ms */
 277         }
 278
 279 #define CMDWAIT_RETRY_MAX       1000
 280         for (i = 0; i < CMDWAIT_RETRY_MAX; ++i) {
 281                 uint16_t reg;
 282
 283                 reg = CSR_READ_2(sc, ACXREG_INTR_STATUS);
 284                 if (reg & ACXRV_INTR_CMD_FINI) {
 285                         CSR_WRITE_2(sc, ACXREG_INTR_ACK, ACXRV_INTR_CMD_FINI);
 286                         break;
 287                 }
 288                 DELAY(50);
 289         }
 290         if (i == CMDWAIT_RETRY_MAX) {
 291                 if_printf(&sc->sc_ic.ic_if, "cmd %04x failed (timeout)\n", cmd);
 292                 ret = 1;
 293                 goto back;
 294         }
 295 #undef CMDWAIT_RETRY_MAX
 296
 297         /* Get command exec status */
 298         status = (CMD_READ_4(sc) >> ACX_CMD_STATUS_SHIFT);
 299         if (status != ACX_CMD_STATUS_OK) {
 300                 if_printf(&sc->sc_ic.ic_if, "cmd %04x failed\n", cmd);
 301                 ret = 1;
 302                 goto back;
 303         }
 304
 305         if (result != NULL && result_len != 0) {
 306                 /* Get command result */
 307                 CMDPRM_READ_REGION_1(sc, result, result_len);
 308         }
 309
 310 back:
 311         CMD_WRITE_4(sc, 0);
 312         return ret;
 313 }