General revision of RoboSwitch driver
[wpasupplicant] / src / drivers / driver_roboswitch.c
1 /*
2  * WPA Supplicant - roboswitch driver interface
3  * Copyright (c) 2008-2009 Jouke Witteveen
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation.
8  *
9  * Alternatively, this software may be distributed under the terms of BSD
10  * license.
11  *
12  * See README and COPYING for more details.
13  */
14
15 #include "includes.h"
16 #include <sys/ioctl.h>
17 #include <linux/if.h>
18 #include <linux/sockios.h>
19 #include <linux/if_ether.h>
20 #include <linux/mii.h>
21
22 #include "common.h"
23 #include "driver.h"
24 #include "l2_packet/l2_packet.h"
25
26 #ifndef ETH_P_EAPOL
27 #define ETH_P_EAPOL             0x888e
28 #endif
29
30 #define ROBO_PHY_ADDR           0x1e    /* RoboSwitch PHY address */
31
32 /* MII access registers */
33 #define ROBO_MII_PAGE           0x10    /* MII page register */
34 #define ROBO_MII_ADDR           0x11    /* MII address register */
35 #define ROBO_MII_DATA_OFFSET    0x18    /* Start of MII data registers */
36
37 #define ROBO_MII_PAGE_ENABLE    0x01    /* MII page op code */
38 #define ROBO_MII_ADDR_WRITE     0x01    /* MII address write op code */
39 #define ROBO_MII_ADDR_READ      0x02    /* MII address read op code */
40 #define ROBO_MII_DATA_MAX          4    /* Consecutive MII data registers */
41 #define ROBO_MII_RETRY_MAX        10    /* Read attempts before giving up */
42
43 /* Page numbers */
44 #define ROBO_ARLCTRL_PAGE       0x04    /* ARL control page */
45 #define ROBO_VLAN_PAGE          0x34    /* VLAN page */
46
47 /* ARL control page registers */
48 #define ROBO_ARLCTRL_CONF       0x00    /* ARL configuration register */
49 #define ROBO_ARLCTRL_ADDR_1     0x10    /* Multiport address 1 */
50 #define ROBO_ARLCTRL_VEC_1      0x16    /* Multiport vector 1 */
51 #define ROBO_ARLCTRL_ADDR_2     0x20    /* Multiport address 2 */
52 #define ROBO_ARLCTRL_VEC_2      0x26    /* Multiport vector 2 */
53
54 /* VLAN page registers */
55 #define ROBO_VLAN_ACCESS        0x08    /* VLAN table access register */
56 #define ROBO_VLAN_ACCESS_5350   0x06    /* VLAN table access register (5350) */
57 #define ROBO_VLAN_READ          0x0c    /* VLAN read register */
58 #define ROBO_VLAN_MAX           0xff    /* Maximum number of VLANs */
59
60
61 static const u8 pae_group_addr[ETH_ALEN] =
62 { 0x01, 0x80, 0xc2, 0x00, 0x00, 0x03 };
63
64
65 struct wpa_driver_roboswitch_data {
66         void *ctx;
67         struct l2_packet_data *l2;
68         char ifname[IFNAMSIZ + 1];
69         u8 own_addr[ETH_ALEN];
70         struct ifreq ifr;
71         int fd, is_5350;
72         u16 ports;
73 };
74
75
76 /* Copied from the kernel-only part of mii.h. */
77 static inline struct mii_ioctl_data *if_mii(struct ifreq *rq)
78 {
79         return (struct mii_ioctl_data *) &rq->ifr_ifru;
80 }
81
82
83 /*
84  * RoboSwitch uses 16-bit Big Endian addresses.
85  * The ordering of the words is reversed in the MII registers.
86  */
87 static void wpa_driver_roboswitch_addr_be16(const u8 addr[ETH_ALEN], u16 *be)
88 {
89         int i;
90         for (i = 0; i < ETH_ALEN; i += 2)
91                 be[(ETH_ALEN - i) / 2 - 1] = WPA_GET_BE16(addr + i);
92 }
93
94
95 static u16 wpa_driver_roboswitch_mdio_read(
96         struct wpa_driver_roboswitch_data *drv, u8 reg)
97 {
98         struct mii_ioctl_data *mii = if_mii(&drv->ifr);
99
100         mii->phy_id = ROBO_PHY_ADDR;
101         mii->reg_num = reg;
102
103         if (ioctl(drv->fd, SIOCGMIIREG, &drv->ifr) < 0) {
104                 perror("ioctl[SIOCGMIIREG]");
105                 return 0x00;
106         }
107         return mii->val_out;
108 }
109
110
111 static void wpa_driver_roboswitch_mdio_write(
112         struct wpa_driver_roboswitch_data *drv, u8 reg, u16 val)
113 {
114         struct mii_ioctl_data *mii = if_mii(&drv->ifr);
115
116         mii->phy_id = ROBO_PHY_ADDR;
117         mii->reg_num = reg;
118         mii->val_in = val;
119
120         if (ioctl(drv->fd, SIOCSMIIREG, &drv->ifr) < 0) {
121                 perror("ioctl[SIOCSMIIREG");
122         }
123 }
124
125
126 static int wpa_driver_roboswitch_reg(struct wpa_driver_roboswitch_data *drv,
127                                      u8 page, u8 reg, u8 op)
128 {
129         int i;
130
131         /* set page number */
132         wpa_driver_roboswitch_mdio_write(drv, ROBO_MII_PAGE,
133                                          (page << 8) | ROBO_MII_PAGE_ENABLE);
134         /* set register address */
135         wpa_driver_roboswitch_mdio_write(drv, ROBO_MII_ADDR, (reg << 8) | op);
136
137         /* check if operation completed */
138         for (i = 0; i < ROBO_MII_RETRY_MAX; ++i) {
139                 if ((wpa_driver_roboswitch_mdio_read(drv, ROBO_MII_ADDR) & 3)
140                     == 0)
141                         return 0;
142         }
143         /* timeout */
144         return -1;
145 }
146
147
148 static int wpa_driver_roboswitch_read(struct wpa_driver_roboswitch_data *drv,
149                                       u8 page, u8 reg, u16 *val, int len)
150 {
151         int i;
152
153         if (len > ROBO_MII_DATA_MAX ||
154             wpa_driver_roboswitch_reg(drv, page, reg, ROBO_MII_ADDR_READ) < 0)
155                 return -1;
156
157         for (i = 0; i < len; ++i) {
158                 val[i] = wpa_driver_roboswitch_mdio_read(
159                         drv, ROBO_MII_DATA_OFFSET + i);
160         }
161
162         return 0;
163 }
164
165
166 static int wpa_driver_roboswitch_write(struct wpa_driver_roboswitch_data *drv,
167                                        u8 page, u8 reg, u16 *val, int len)
168 {
169         int i;
170
171         if (len > ROBO_MII_DATA_MAX) return -1;
172         for (i = 0; i < len; ++i) {
173                 wpa_driver_roboswitch_mdio_write(drv, ROBO_MII_DATA_OFFSET + i,
174                                                  val[i]);
175         }
176         return wpa_driver_roboswitch_reg(drv, page, reg, ROBO_MII_ADDR_WRITE);
177 }
178
179
180 static void wpa_driver_roboswitch_receive(void *priv, const u8 *src_addr,
181                                           const u8 *buf, size_t len)
182 {
183         struct wpa_driver_roboswitch_data *drv = priv;
184
185         if (len > 14 && WPA_GET_BE16(buf + 12) == ETH_P_EAPOL &&
186             os_memcmp(buf, drv->own_addr, ETH_ALEN) == 0) {
187                 wpa_supplicant_rx_eapol(drv->ctx, src_addr, buf + 14,
188                                         len - 14);
189         }
190 }
191
192
193 static int wpa_driver_roboswitch_get_ssid(void *priv, u8 *ssid)
194 {
195         ssid[0] = 0;
196         return 0;
197 }
198
199
200 static int wpa_driver_roboswitch_get_bssid(void *priv, u8 *bssid)
201 {
202         /* Report PAE group address as the "BSSID" for wired connection. */
203         os_memcpy(bssid, pae_group_addr, ETH_ALEN);
204         return 0;
205 }
206
207
208 static int wpa_driver_roboswitch_get_capa(void *priv,
209                                           struct wpa_driver_capa *capa)
210 {
211         os_memset(capa, 0, sizeof(*capa));
212         capa->flags = WPA_DRIVER_FLAGS_WIRED;
213         return 0;
214 }
215
216
217 static int wpa_driver_roboswitch_set_param(void *priv, const char *param)
218 {
219         struct wpa_driver_roboswitch_data *drv = priv;
220         char *sep;
221
222         if (param == NULL || os_strstr(param, "multicast_only=1") == NULL) {
223                 sep = drv->ifname + os_strlen(drv->ifname);
224                 *sep = '.';
225                 drv->l2 = l2_packet_init(drv->ifname, NULL, ETH_P_ALL,
226                                          wpa_driver_roboswitch_receive, drv,
227                                          1);
228                 if (drv->l2 == NULL) {
229                         wpa_printf(MSG_INFO, "%s: Unable to listen on %s",
230                                    __func__, drv->ifname);
231                         return -1;
232                 }
233                 *sep = '\0';
234                 l2_packet_get_own_addr(drv->l2, drv->own_addr);
235         } else {
236                 wpa_printf(MSG_DEBUG, "%s: Ignoring unicast frames", __func__);
237                 drv->l2 = NULL;
238         }
239         return 0;
240 }
241
242
243 static const char * wpa_driver_roboswitch_get_ifname(void *priv)
244 {
245         struct wpa_driver_roboswitch_data *drv = priv;
246         return drv->ifname;
247 }
248
249
250 static int wpa_driver_roboswitch_join(struct wpa_driver_roboswitch_data *drv,
251                                       u16 ports, const u8 *addr)
252 {
253         u16 read1[3], read2[3], addr_be16[3];
254
255         wpa_driver_roboswitch_addr_be16(addr, addr_be16);
256
257         if (wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
258                                        ROBO_ARLCTRL_CONF, read1, 1) < 0)
259                 return -1;
260         if (!(read1[0] & (1 << 4))) {
261                 /* multiport addresses are not yet enabled */
262                 read1[0] |= 1 << 4;
263                 wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
264                                             ROBO_ARLCTRL_ADDR_1, addr_be16, 3);
265                 wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
266                                             ROBO_ARLCTRL_VEC_1, &ports, 1);
267                 wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
268                                             ROBO_ARLCTRL_ADDR_2, addr_be16, 3);
269                 wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
270                                             ROBO_ARLCTRL_VEC_2, &ports, 1);
271                 wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
272                                             ROBO_ARLCTRL_CONF, read1, 1);
273         } else {
274                 /* if both multiport addresses are the same we can add */
275                 wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
276                                            ROBO_ARLCTRL_ADDR_1, read1, 3);
277                 wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
278                                            ROBO_ARLCTRL_ADDR_2, read2, 3);
279                 if (os_memcmp(read1, read2, 6) != 0)
280                         return -1;
281                 wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
282                                            ROBO_ARLCTRL_VEC_1, read1, 1);
283                 wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
284                                            ROBO_ARLCTRL_VEC_2, read2, 1);
285                 if (read1[0] != read2[0])
286                         return -1;
287                 wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
288                                             ROBO_ARLCTRL_ADDR_1, addr_be16, 3);
289                 wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
290                                             ROBO_ARLCTRL_VEC_1, &ports, 1);
291         }
292         return 0;
293 }
294
295
296 static int wpa_driver_roboswitch_leave(struct wpa_driver_roboswitch_data *drv,
297                                        u16 ports, const u8 *addr)
298 {
299         u16 _read, addr_be16[3], addr_read[3], ports_read;
300
301         wpa_driver_roboswitch_addr_be16(addr, addr_be16);
302
303         wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE, ROBO_ARLCTRL_CONF,
304                                    &_read, 1);
305         /* If ARL control is disabled, there is nothing to leave. */
306         if (!(_read & (1 << 4))) return -1;
307
308         wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
309                                    ROBO_ARLCTRL_ADDR_1, addr_read, 3);
310         wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE, ROBO_ARLCTRL_VEC_1,
311                                    &ports_read, 1);
312         /* check if we occupy multiport address 1 */
313         if (os_memcmp(addr_read, addr_be16, 6) == 0 && ports_read == ports) {
314                 wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
315                                            ROBO_ARLCTRL_ADDR_2, addr_read, 3);
316                 wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
317                                            ROBO_ARLCTRL_VEC_2, &ports_read, 1);
318                 /* and multiport address 2 */
319                 if (os_memcmp(addr_read, addr_be16, 6) == 0 &&
320                     ports_read == ports) {
321                         _read &= ~(1 << 4);
322                         wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
323                                                     ROBO_ARLCTRL_CONF, &_read,
324                                                     1);
325                 } else {
326                         wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
327                                                    ROBO_ARLCTRL_ADDR_1,
328                                                    addr_read, 3);
329                         wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
330                                                    ROBO_ARLCTRL_VEC_1,
331                                                    &ports_read, 1);
332                         wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
333                                                     ROBO_ARLCTRL_ADDR_2,
334                                                     addr_read, 3);
335                         wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
336                                                     ROBO_ARLCTRL_VEC_2,
337                                                     &ports_read, 1);
338                 }
339         } else {
340                 wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
341                                            ROBO_ARLCTRL_ADDR_2, addr_read, 3);
342                 wpa_driver_roboswitch_read(drv, ROBO_ARLCTRL_PAGE,
343                                            ROBO_ARLCTRL_VEC_2, &ports_read, 1);
344                 /* or multiport address 2 */
345                 if (os_memcmp(addr_read, addr_be16, 6) == 0 &&
346                     ports_read == ports) {
347                         wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
348                                                     ROBO_ARLCTRL_ADDR_1,
349                                                     addr_read, 3);
350                         wpa_driver_roboswitch_write(drv, ROBO_ARLCTRL_PAGE,
351                                                     ROBO_ARLCTRL_VEC_1,
352                                                     &ports_read, 1);
353                 } else return -1;
354         }
355         return 0;
356 }
357
358
359 static void * wpa_driver_roboswitch_init(void *ctx, const char *ifname)
360 {
361         struct wpa_driver_roboswitch_data *drv;
362         char *sep;
363         u16 vlan = 0, _read[2];
364
365         drv = os_zalloc(sizeof(*drv));
366         if (drv == NULL) return NULL;
367         drv->ctx = ctx;
368         drv->own_addr[0] = '\0';
369
370         /* copy ifname and take a pointer to the second to last character */
371         sep = drv->ifname +
372               os_strlcpy(drv->ifname, ifname, sizeof(drv->ifname)) - 2;
373         /* find the '.' seperating <interface> and <vlan> */
374         while (sep > drv->ifname && *sep != '.') sep--;
375         if (sep <= drv->ifname) {
376                 wpa_printf(MSG_INFO, "%s: No <interface>.<vlan> pair in "
377                            "interface name %s", __func__, drv->ifname);
378                 os_free(drv);
379                 return NULL;
380         }
381         *sep = '\0';
382         while (*++sep) {
383                 if (*sep < '0' || *sep > '9') {
384                         wpa_printf(MSG_INFO, "%s: Invalid vlan specification "
385                                    "in interface name %s", __func__, ifname);
386                         os_free(drv);
387                         return NULL;
388                 }
389                 vlan *= 10;
390                 vlan += *sep - '0';
391                 if (vlan > ROBO_VLAN_MAX) {
392                         wpa_printf(MSG_INFO, "%s: VLAN out of range in "
393                                    "interface name %s", __func__, ifname);
394                         os_free(drv);
395                         return NULL;
396                 }
397         }
398
399         drv->fd = socket(PF_INET, SOCK_DGRAM, 0);
400         if (drv->fd < 0) {
401                 wpa_printf(MSG_INFO, "%s: Unable to create socket", __func__);
402                 os_free(drv);
403                 return NULL;
404         }
405
406         os_memset(&drv->ifr, 0, sizeof(drv->ifr));
407         os_strlcpy(drv->ifr.ifr_name, drv->ifname, IFNAMSIZ);
408         if (ioctl(drv->fd, SIOCGMIIPHY, &drv->ifr) < 0) {
409                 perror("ioctl[SIOCGMIIPHY]");
410                 os_free(drv);
411                 return NULL;
412         }
413         if (if_mii(&drv->ifr)->phy_id != ROBO_PHY_ADDR) {
414                 wpa_printf(MSG_INFO, "%s: Invalid phy address (not a "
415                            "RoboSwitch?)", __func__);
416                 os_free(drv);
417                 return NULL;
418         }
419
420         /* set and read back to see if the register can be used */
421         _read[0] = ROBO_VLAN_MAX;
422         wpa_driver_roboswitch_write(drv, ROBO_VLAN_PAGE, ROBO_VLAN_ACCESS_5350,
423                                     _read, 1);
424         wpa_driver_roboswitch_read(drv, ROBO_VLAN_PAGE, ROBO_VLAN_ACCESS_5350,
425                                    _read + 1, 1);
426         drv->is_5350 = _read[0] == _read[1];
427
428         /* set the read bit */
429         vlan |= 1 << 13;
430         wpa_driver_roboswitch_write(drv, ROBO_VLAN_PAGE,
431                                     drv->is_5350 ? ROBO_VLAN_ACCESS_5350
432                                                  : ROBO_VLAN_ACCESS,
433                                     &vlan, 1);
434         wpa_driver_roboswitch_read(drv, ROBO_VLAN_PAGE, ROBO_VLAN_READ, _read,
435                                    drv->is_5350 ? 2 : 1);
436         if (!(drv->is_5350 ? _read[1] & (1 << 4) : _read[0] & (1 << 14))) {
437                 wpa_printf(MSG_INFO, "%s: Could not get port information for "
438                                      "VLAN %d", __func__, vlan & ~(1 << 13));
439                 os_free(drv);
440                 return NULL;
441         }
442         drv->ports = _read[0] & 0x001F;
443         /* add the MII port */
444         drv->ports |= 1 << 8;
445         if (wpa_driver_roboswitch_join(drv, drv->ports, pae_group_addr) < 0) {
446                 wpa_printf(MSG_INFO, "%s: Unable to join PAE group", __func__);
447                 os_free(drv);
448                 return NULL;
449         } else {
450                 wpa_printf(MSG_DEBUG, "%s: Added PAE group address to "
451                            "RoboSwitch ARL", __func__);
452         }
453
454         return drv;
455 }
456
457
458 static void wpa_driver_roboswitch_deinit(void *priv)
459 {
460         struct wpa_driver_roboswitch_data *drv = priv;
461
462         if (drv->l2) {
463                 l2_packet_deinit(drv->l2);
464                 drv->l2 = NULL;
465         }
466         if (wpa_driver_roboswitch_leave(drv, drv->ports, pae_group_addr) < 0) {
467                 wpa_printf(MSG_DEBUG, "%s: Unable to leave PAE group",
468                            __func__);
469         }
470
471         close(drv->fd);
472         os_free(drv);
473 }
474
475
476 const struct wpa_driver_ops wpa_driver_roboswitch_ops = {
477         .name = "roboswitch",
478         .desc = "wpa_supplicant roboswitch driver",
479         .get_ssid = wpa_driver_roboswitch_get_ssid,
480         .get_bssid = wpa_driver_roboswitch_get_bssid,
481         .get_capa = wpa_driver_roboswitch_get_capa,
482         .init = wpa_driver_roboswitch_init,
483         .deinit = wpa_driver_roboswitch_deinit,
484         .set_param = wpa_driver_roboswitch_set_param,
485         .get_ifname = wpa_driver_roboswitch_get_ifname,
486 };