2 * EEPROM parser code for mac80211 Prism54 drivers
4 * Copyright (c) 2006, Michael Wu <flamingice@sourmilk.net>
5 * Copyright (c) 2007-2009, Christian Lamparter <chunkeey@web.de>
6 * Copyright 2008, Johannes Berg <johannes@sipsolutions.net>
9 * - the islsm (softmac prism54) driver, which is:
10 * Copyright 2004-2006 Jean-Baptiste Note <jbnote@gmail.com>, et al.
12 * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
19 #include <linux/init.h>
20 #include <linux/firmware.h>
21 #include <linux/etherdevice.h>
22 #include <linux/sort.h>
23 #include <linux/slab.h>
25 #include <net/mac80211.h>
31 static struct ieee80211_rate p54_bgrates[] = {
32 { .bitrate = 10, .hw_value = 0, },
33 { .bitrate = 20, .hw_value = 1, .flags = IEEE80211_RATE_SHORT_PREAMBLE },
34 { .bitrate = 55, .hw_value = 2, .flags = IEEE80211_RATE_SHORT_PREAMBLE },
35 { .bitrate = 110, .hw_value = 3, .flags = IEEE80211_RATE_SHORT_PREAMBLE },
36 { .bitrate = 60, .hw_value = 4, },
37 { .bitrate = 90, .hw_value = 5, },
38 { .bitrate = 120, .hw_value = 6, },
39 { .bitrate = 180, .hw_value = 7, },
40 { .bitrate = 240, .hw_value = 8, },
41 { .bitrate = 360, .hw_value = 9, },
42 { .bitrate = 480, .hw_value = 10, },
43 { .bitrate = 540, .hw_value = 11, },
46 static struct ieee80211_rate p54_arates[] = {
47 { .bitrate = 60, .hw_value = 4, },
48 { .bitrate = 90, .hw_value = 5, },
49 { .bitrate = 120, .hw_value = 6, },
50 { .bitrate = 180, .hw_value = 7, },
51 { .bitrate = 240, .hw_value = 8, },
52 { .bitrate = 360, .hw_value = 9, },
53 { .bitrate = 480, .hw_value = 10, },
54 { .bitrate = 540, .hw_value = 11, },
57 #define CHAN_HAS_CAL BIT(0)
58 #define CHAN_HAS_LIMIT BIT(1)
59 #define CHAN_HAS_CURVE BIT(2)
60 #define CHAN_HAS_ALL (CHAN_HAS_CAL | CHAN_HAS_LIMIT | CHAN_HAS_CURVE)
62 struct p54_channel_entry {
66 enum ieee80211_band band;
69 struct p54_channel_list {
70 struct p54_channel_entry *channels;
73 size_t band_channel_num[IEEE80211_NUM_BANDS];
76 static int p54_get_band_from_freq(u16 freq)
78 /* FIXME: sync these values with the 802.11 spec */
80 if ((freq >= 2412) && (freq <= 2484))
81 return IEEE80211_BAND_2GHZ;
83 if ((freq >= 4920) && (freq <= 5825))
84 return IEEE80211_BAND_5GHZ;
89 static int p54_compare_channels(const void *_a,
92 const struct p54_channel_entry *a = _a;
93 const struct p54_channel_entry *b = _b;
95 return a->index - b->index;
98 static int p54_fill_band_bitrates(struct ieee80211_hw *dev,
99 struct ieee80211_supported_band *band_entry,
100 enum ieee80211_band band)
102 /* TODO: generate rate array dynamically */
105 case IEEE80211_BAND_2GHZ:
106 band_entry->bitrates = p54_bgrates;
107 band_entry->n_bitrates = ARRAY_SIZE(p54_bgrates);
109 case IEEE80211_BAND_5GHZ:
110 band_entry->bitrates = p54_arates;
111 band_entry->n_bitrates = ARRAY_SIZE(p54_arates);
120 static int p54_generate_band(struct ieee80211_hw *dev,
121 struct p54_channel_list *list,
122 enum ieee80211_band band)
124 struct p54_common *priv = dev->priv;
125 struct ieee80211_supported_band *tmp, *old;
129 if ((!list->entries) || (!list->band_channel_num[band]))
132 tmp = kzalloc(sizeof(*tmp), GFP_KERNEL);
136 tmp->channels = kzalloc(sizeof(struct ieee80211_channel) *
137 list->band_channel_num[band], GFP_KERNEL);
141 ret = p54_fill_band_bitrates(dev, tmp, band);
145 for (i = 0, j = 0; (j < list->band_channel_num[band]) &&
146 (i < list->entries); i++) {
148 if (list->channels[i].band != band)
151 if (list->channels[i].data != CHAN_HAS_ALL) {
152 wiphy_err(dev->wiphy,
153 "%s%s%s is/are missing for channel:%d [%d MHz].\n",
154 (list->channels[i].data & CHAN_HAS_CAL ? "" :
155 " [iqauto calibration data]"),
156 (list->channels[i].data & CHAN_HAS_LIMIT ? "" :
157 " [output power limits]"),
158 (list->channels[i].data & CHAN_HAS_CURVE ? "" :
160 list->channels[i].index, list->channels[i].freq);
164 tmp->channels[j].band = list->channels[i].band;
165 tmp->channels[j].center_freq = list->channels[i].freq;
170 wiphy_err(dev->wiphy, "Disabling totally damaged %d GHz band\n",
171 (band == IEEE80211_BAND_2GHZ) ? 2 : 5);
178 old = priv->band_table[band];
179 priv->band_table[band] = tmp;
181 kfree(old->channels);
189 kfree(tmp->channels);
196 static void p54_update_channel_param(struct p54_channel_list *list,
202 * usually all lists in the eeprom are mostly sorted.
203 * so it's very likely that the entry we are looking for
204 * is right at the end of the list
206 for (i = list->entries; i >= 0; i--) {
207 if (freq == list->channels[i].freq) {
208 list->channels[i].data |= data;
213 if ((i < 0) && (list->entries < list->max_entries)) {
214 /* entry does not exist yet. Initialize a new one. */
215 band = p54_get_band_from_freq(freq);
218 * filter out frequencies which don't belong into
219 * any supported band.
225 list->band_channel_num[band]++;
227 list->channels[i].freq = freq;
228 list->channels[i].data = data;
229 list->channels[i].band = band;
230 list->channels[i].index = ieee80211_frequency_to_channel(freq);
231 /* TODO: parse output_limit and fill max_power */
235 static int p54_generate_channel_lists(struct ieee80211_hw *dev)
237 struct p54_common *priv = dev->priv;
238 struct p54_channel_list *list;
239 unsigned int i, j, max_channel_num;
243 if ((priv->iq_autocal_len != priv->curve_data->entries) ||
244 (priv->iq_autocal_len != priv->output_limit->entries))
245 wiphy_err(dev->wiphy,
246 "Unsupported or damaged EEPROM detected. "
247 "You may not be able to use all channels.\n");
249 max_channel_num = max_t(unsigned int, priv->output_limit->entries,
250 priv->iq_autocal_len);
251 max_channel_num = max_t(unsigned int, max_channel_num,
252 priv->curve_data->entries);
254 list = kzalloc(sizeof(*list), GFP_KERNEL);
260 list->max_entries = max_channel_num;
261 list->channels = kzalloc(sizeof(struct p54_channel_entry) *
262 max_channel_num, GFP_KERNEL);
263 if (!list->channels) {
268 for (i = 0; i < max_channel_num; i++) {
269 if (i < priv->iq_autocal_len) {
270 freq = le16_to_cpu(priv->iq_autocal[i].freq);
271 p54_update_channel_param(list, freq, CHAN_HAS_CAL);
274 if (i < priv->output_limit->entries) {
275 freq = le16_to_cpup((__le16 *) (i *
276 priv->output_limit->entry_size +
277 priv->output_limit->offset +
278 priv->output_limit->data));
280 p54_update_channel_param(list, freq, CHAN_HAS_LIMIT);
283 if (i < priv->curve_data->entries) {
284 freq = le16_to_cpup((__le16 *) (i *
285 priv->curve_data->entry_size +
286 priv->curve_data->offset +
287 priv->curve_data->data));
289 p54_update_channel_param(list, freq, CHAN_HAS_CURVE);
293 /* sort the list by the channel index */
294 sort(list->channels, list->entries, sizeof(struct p54_channel_entry),
295 p54_compare_channels, NULL);
297 for (i = 0, j = 0; i < IEEE80211_NUM_BANDS; i++) {
298 if (p54_generate_band(dev, list, i) == 0)
302 /* no useable band available. */
308 kfree(list->channels);
315 static int p54_convert_rev0(struct ieee80211_hw *dev,
316 struct pda_pa_curve_data *curve_data)
318 struct p54_common *priv = dev->priv;
319 struct p54_pa_curve_data_sample *dst;
320 struct pda_pa_curve_data_sample_rev0 *src;
321 size_t cd_len = sizeof(*curve_data) +
322 (curve_data->points_per_channel*sizeof(*dst) + 2) *
323 curve_data->channels;
325 void *source, *target;
327 priv->curve_data = kmalloc(sizeof(*priv->curve_data) + cd_len,
329 if (!priv->curve_data)
332 priv->curve_data->entries = curve_data->channels;
333 priv->curve_data->entry_size = sizeof(__le16) +
334 sizeof(*dst) * curve_data->points_per_channel;
335 priv->curve_data->offset = offsetof(struct pda_pa_curve_data, data);
336 priv->curve_data->len = cd_len;
337 memcpy(priv->curve_data->data, curve_data, sizeof(*curve_data));
338 source = curve_data->data;
339 target = ((struct pda_pa_curve_data *) priv->curve_data->data)->data;
340 for (i = 0; i < curve_data->channels; i++) {
341 __le16 *freq = source;
342 source += sizeof(__le16);
343 *((__le16 *)target) = *freq;
344 target += sizeof(__le16);
345 for (j = 0; j < curve_data->points_per_channel; j++) {
349 dst->rf_power = src->rf_power;
350 dst->pa_detector = src->pa_detector;
351 dst->data_64qam = src->pcv;
352 /* "invent" the points for the other modulations */
353 #define SUB(x, y) (u8)(((x) - (y)) > (x) ? 0 : (x) - (y))
354 dst->data_16qam = SUB(src->pcv, 12);
355 dst->data_qpsk = SUB(dst->data_16qam, 12);
356 dst->data_bpsk = SUB(dst->data_qpsk, 12);
357 dst->data_barker = SUB(dst->data_bpsk, 14);
359 target += sizeof(*dst);
360 source += sizeof(*src);
367 static int p54_convert_rev1(struct ieee80211_hw *dev,
368 struct pda_pa_curve_data *curve_data)
370 struct p54_common *priv = dev->priv;
371 struct p54_pa_curve_data_sample *dst;
372 struct pda_pa_curve_data_sample_rev1 *src;
373 size_t cd_len = sizeof(*curve_data) +
374 (curve_data->points_per_channel*sizeof(*dst) + 2) *
375 curve_data->channels;
377 void *source, *target;
379 priv->curve_data = kzalloc(cd_len + sizeof(*priv->curve_data),
381 if (!priv->curve_data)
384 priv->curve_data->entries = curve_data->channels;
385 priv->curve_data->entry_size = sizeof(__le16) +
386 sizeof(*dst) * curve_data->points_per_channel;
387 priv->curve_data->offset = offsetof(struct pda_pa_curve_data, data);
388 priv->curve_data->len = cd_len;
389 memcpy(priv->curve_data->data, curve_data, sizeof(*curve_data));
390 source = curve_data->data;
391 target = ((struct pda_pa_curve_data *) priv->curve_data->data)->data;
392 for (i = 0; i < curve_data->channels; i++) {
393 __le16 *freq = source;
394 source += sizeof(__le16);
395 *((__le16 *)target) = *freq;
396 target += sizeof(__le16);
397 for (j = 0; j < curve_data->points_per_channel; j++) {
398 memcpy(target, source, sizeof(*src));
400 target += sizeof(*dst);
401 source += sizeof(*src);
409 static const char *p54_rf_chips[] = { "INVALID-0", "Duette3", "Duette2",
410 "Frisbee", "Xbow", "Longbow", "INVALID-6", "INVALID-7" };
412 static void p54_parse_rssical(struct ieee80211_hw *dev, void *data, int len,
415 struct p54_common *priv = dev->priv;
416 int offset = (type == PDR_RSSI_LINEAR_APPROXIMATION_EXTENDED) ? 2 : 0;
417 int entry_size = sizeof(struct pda_rssi_cal_entry) + offset;
418 int num_entries = (type == PDR_RSSI_LINEAR_APPROXIMATION) ? 1 : 2;
421 if (len != (entry_size * num_entries)) {
422 wiphy_err(dev->wiphy,
423 "unknown rssi calibration data packing type:(%x) len:%d.\n",
426 print_hex_dump_bytes("rssical:", DUMP_PREFIX_NONE,
429 wiphy_err(dev->wiphy, "please report this issue.\n");
433 for (i = 0; i < num_entries; i++) {
434 struct pda_rssi_cal_entry *cal = data +
435 (offset + i * entry_size);
436 priv->rssical_db[i].mul = (s16) le16_to_cpu(cal->mul);
437 priv->rssical_db[i].add = (s16) le16_to_cpu(cal->add);
441 static void p54_parse_default_country(struct ieee80211_hw *dev,
444 struct pda_country *country;
446 if (len != sizeof(*country)) {
447 wiphy_err(dev->wiphy,
448 "found possible invalid default country eeprom entry. (entry size: %d)\n",
451 print_hex_dump_bytes("country:", DUMP_PREFIX_NONE,
454 wiphy_err(dev->wiphy, "please report this issue.\n");
458 country = (struct pda_country *) data;
459 if (country->flags == PDR_COUNTRY_CERT_CODE_PSEUDO)
460 regulatory_hint(dev->wiphy, country->alpha2);
463 * write a shared/common function that converts
464 * "Regulatory domain codes" (802.11-2007 14.8.2.2)
465 * into ISO/IEC 3166-1 alpha2 for regulatory_hint.
470 static int p54_convert_output_limits(struct ieee80211_hw *dev,
471 u8 *data, size_t len)
473 struct p54_common *priv = dev->priv;
479 wiphy_err(dev->wiphy, "unknown output power db revision:%x\n",
484 if (2 + data[1] * sizeof(struct pda_channel_output_limit) > len)
487 priv->output_limit = kmalloc(data[1] *
488 sizeof(struct pda_channel_output_limit) +
489 sizeof(*priv->output_limit), GFP_KERNEL);
491 if (!priv->output_limit)
494 priv->output_limit->offset = 0;
495 priv->output_limit->entries = data[1];
496 priv->output_limit->entry_size =
497 sizeof(struct pda_channel_output_limit);
498 priv->output_limit->len = priv->output_limit->entry_size *
499 priv->output_limit->entries +
500 priv->output_limit->offset;
502 memcpy(priv->output_limit->data, &data[2],
503 data[1] * sizeof(struct pda_channel_output_limit));
508 static struct p54_cal_database *p54_convert_db(struct pda_custom_wrapper *src,
511 struct p54_cal_database *dst;
512 size_t payload_len, entries, entry_size, offset;
514 payload_len = le16_to_cpu(src->len);
515 entries = le16_to_cpu(src->entries);
516 entry_size = le16_to_cpu(src->entry_size);
517 offset = le16_to_cpu(src->offset);
518 if (((entries * entry_size + offset) != payload_len) ||
519 (payload_len + sizeof(*src) != total_len))
522 dst = kmalloc(sizeof(*dst) + payload_len, GFP_KERNEL);
526 dst->entries = entries;
527 dst->entry_size = entry_size;
528 dst->offset = offset;
529 dst->len = payload_len;
531 memcpy(dst->data, src->data, payload_len);
535 int p54_parse_eeprom(struct ieee80211_hw *dev, void *eeprom, int len)
537 struct p54_common *priv = dev->priv;
538 struct eeprom_pda_wrap *wrap;
539 struct pda_entry *entry;
540 unsigned int data_len, entry_len;
543 u8 *end = (u8 *)eeprom + len;
546 wrap = (struct eeprom_pda_wrap *) eeprom;
547 entry = (void *)wrap->data + le16_to_cpu(wrap->len);
549 /* verify that at least the entry length/code fits */
550 while ((u8 *)entry <= end - sizeof(*entry)) {
551 entry_len = le16_to_cpu(entry->len);
552 data_len = ((entry_len - 1) << 1);
554 /* abort if entry exceeds whole structure */
555 if ((u8 *)entry + sizeof(*entry) + data_len > end)
558 switch (le16_to_cpu(entry->code)) {
559 case PDR_MAC_ADDRESS:
560 if (data_len != ETH_ALEN)
562 SET_IEEE80211_PERM_ADDR(dev, entry->data);
564 case PDR_PRISM_PA_CAL_OUTPUT_POWER_LIMITS:
565 if (priv->output_limit)
567 err = p54_convert_output_limits(dev, entry->data,
572 case PDR_PRISM_PA_CAL_CURVE_DATA: {
573 struct pda_pa_curve_data *curve_data =
574 (struct pda_pa_curve_data *)entry->data;
575 if (data_len < sizeof(*curve_data)) {
580 switch (curve_data->cal_method_rev) {
582 err = p54_convert_rev0(dev, curve_data);
585 err = p54_convert_rev1(dev, curve_data);
588 wiphy_err(dev->wiphy,
589 "unknown curve data revision %d\n",
590 curve_data->cal_method_rev);
598 case PDR_PRISM_ZIF_TX_IQ_CALIBRATION:
599 priv->iq_autocal = kmemdup(entry->data, data_len,
601 if (!priv->iq_autocal) {
606 priv->iq_autocal_len = data_len / sizeof(struct pda_iq_autocal_entry);
608 case PDR_DEFAULT_COUNTRY:
609 p54_parse_default_country(dev, entry->data, data_len);
611 case PDR_INTERFACE_LIST:
613 while ((u8 *)tmp < entry->data + data_len) {
614 struct exp_if *exp_if = tmp;
615 if (exp_if->if_id == cpu_to_le16(IF_ID_ISL39000))
616 synth = le16_to_cpu(exp_if->variant);
617 tmp += sizeof(*exp_if);
620 case PDR_HARDWARE_PLATFORM_COMPONENT_ID:
623 priv->version = *(u8 *)(entry->data + 1);
625 case PDR_RSSI_LINEAR_APPROXIMATION:
626 case PDR_RSSI_LINEAR_APPROXIMATION_DUAL_BAND:
627 case PDR_RSSI_LINEAR_APPROXIMATION_EXTENDED:
628 p54_parse_rssical(dev, entry->data, data_len,
629 le16_to_cpu(entry->code));
631 case PDR_RSSI_LINEAR_APPROXIMATION_CUSTOM: {
632 __le16 *src = (void *) entry->data;
633 s16 *dst = (void *) &priv->rssical_db;
636 if (data_len != sizeof(priv->rssical_db)) {
640 for (i = 0; i < sizeof(priv->rssical_db) /
642 *(dst++) = (s16) le16_to_cpu(*(src++));
645 case PDR_PRISM_PA_CAL_OUTPUT_POWER_LIMITS_CUSTOM: {
646 struct pda_custom_wrapper *pda = (void *) entry->data;
647 if (priv->output_limit || data_len < sizeof(*pda))
649 priv->output_limit = p54_convert_db(pda, data_len);
652 case PDR_PRISM_PA_CAL_CURVE_DATA_CUSTOM: {
653 struct pda_custom_wrapper *pda = (void *) entry->data;
654 if (priv->curve_data || data_len < sizeof(*pda))
656 priv->curve_data = p54_convert_db(pda, data_len);
660 /* make it overrun */
667 entry = (void *)entry + (entry_len + 1)*2;
670 if (!synth || !priv->iq_autocal || !priv->output_limit ||
672 wiphy_err(dev->wiphy,
673 "not all required entries found in eeprom!\n");
678 err = p54_generate_channel_lists(dev);
682 priv->rxhw = synth & PDR_SYNTH_FRONTEND_MASK;
683 if (priv->rxhw == PDR_SYNTH_FRONTEND_XBOW)
684 p54_init_xbow_synth(priv);
685 if (!(synth & PDR_SYNTH_24_GHZ_DISABLED))
686 dev->wiphy->bands[IEEE80211_BAND_2GHZ] =
687 priv->band_table[IEEE80211_BAND_2GHZ];
688 if (!(synth & PDR_SYNTH_5_GHZ_DISABLED))
689 dev->wiphy->bands[IEEE80211_BAND_5GHZ] =
690 priv->band_table[IEEE80211_BAND_5GHZ];
691 if ((synth & PDR_SYNTH_RX_DIV_MASK) == PDR_SYNTH_RX_DIV_SUPPORTED)
692 priv->rx_diversity_mask = 3;
693 if ((synth & PDR_SYNTH_TX_DIV_MASK) == PDR_SYNTH_TX_DIV_SUPPORTED)
694 priv->tx_diversity_mask = 3;
696 if (!is_valid_ether_addr(dev->wiphy->perm_addr)) {
697 u8 perm_addr[ETH_ALEN];
699 wiphy_warn(dev->wiphy,
700 "Invalid hwaddr! Using randomly generated MAC addr\n");
701 random_ether_addr(perm_addr);
702 SET_IEEE80211_PERM_ADDR(dev, perm_addr);
705 wiphy_info(dev->wiphy, "hwaddr %pM, MAC:isl38%02x RF:%s\n",
706 dev->wiphy->perm_addr, priv->version,
707 p54_rf_chips[priv->rxhw]);
712 kfree(priv->iq_autocal);
713 kfree(priv->output_limit);
714 kfree(priv->curve_data);
715 priv->iq_autocal = NULL;
716 priv->output_limit = NULL;
717 priv->curve_data = NULL;
719 wiphy_err(dev->wiphy, "eeprom parse failed!\n");
722 EXPORT_SYMBOL_GPL(p54_parse_eeprom);
724 int p54_read_eeprom(struct ieee80211_hw *dev)
726 struct p54_common *priv = dev->priv;
727 size_t eeprom_size = 0x2020, offset = 0, blocksize, maxblocksize;
731 maxblocksize = EEPROM_READBACK_LEN;
732 if (priv->fw_var >= 0x509)
737 eeprom = kzalloc(eeprom_size, GFP_KERNEL);
738 if (unlikely(!eeprom))
741 while (eeprom_size) {
742 blocksize = min(eeprom_size, maxblocksize);
743 ret = p54_download_eeprom(priv, (void *) (eeprom + offset),
749 eeprom_size -= blocksize;
752 ret = p54_parse_eeprom(dev, eeprom, offset);
757 EXPORT_SYMBOL_GPL(p54_read_eeprom);