1f931551bSRalph Campbell /*
27fac3301SMike Marciniszyn * Copyright (c) 2012 Intel Corporation. All rights reserved.
37fac3301SMike Marciniszyn * Copyright (c) 2006 - 2012 QLogic Corporation. All rights reserved.
4f931551bSRalph Campbell * Copyright (c) 2003, 2004, 2005, 2006 PathScale, Inc. All rights reserved.
5f931551bSRalph Campbell *
6f931551bSRalph Campbell * This software is available to you under a choice of one of two
7f931551bSRalph Campbell * licenses. You may choose to be licensed under the terms of the GNU
8f931551bSRalph Campbell * General Public License (GPL) Version 2, available from the file
9f931551bSRalph Campbell * COPYING in the main directory of this source tree, or the
10f931551bSRalph Campbell * OpenIB.org BSD license below:
11f931551bSRalph Campbell *
12f931551bSRalph Campbell * Redistribution and use in source and binary forms, with or
13f931551bSRalph Campbell * without modification, are permitted provided that the following
14f931551bSRalph Campbell * conditions are met:
15f931551bSRalph Campbell *
16f931551bSRalph Campbell * - Redistributions of source code must retain the above
17f931551bSRalph Campbell * copyright notice, this list of conditions and the following
18f931551bSRalph Campbell * disclaimer.
19f931551bSRalph Campbell *
20f931551bSRalph Campbell * - Redistributions in binary form must reproduce the above
21f931551bSRalph Campbell * copyright notice, this list of conditions and the following
22f931551bSRalph Campbell * disclaimer in the documentation and/or other materials
23f931551bSRalph Campbell * provided with the distribution.
24f931551bSRalph Campbell *
25f931551bSRalph Campbell * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26f931551bSRalph Campbell * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27f931551bSRalph Campbell * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28f931551bSRalph Campbell * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29f931551bSRalph Campbell * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30f931551bSRalph Campbell * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31f931551bSRalph Campbell * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32f931551bSRalph Campbell * SOFTWARE.
33f931551bSRalph Campbell */
34f931551bSRalph Campbell
35f931551bSRalph Campbell #include <linux/delay.h>
36f931551bSRalph Campbell #include <linux/pci.h>
37f931551bSRalph Campbell #include <linux/vmalloc.h>
38f931551bSRalph Campbell
39f931551bSRalph Campbell #include "qib.h"
40f931551bSRalph Campbell
41f931551bSRalph Campbell /*
42f931551bSRalph Campbell * Functions specific to the serial EEPROM on cards handled by ib_qib.
43f931551bSRalph Campbell * The actual serail interface code is in qib_twsi.c. This file is a client
44f931551bSRalph Campbell */
45f931551bSRalph Campbell
46f931551bSRalph Campbell /**
47f931551bSRalph Campbell * qib_eeprom_read - receives bytes from the eeprom via I2C
48f931551bSRalph Campbell * @dd: the qlogic_ib device
49f931551bSRalph Campbell * @eeprom_offset: address to read from
50*aab5a7e9SLee Jones * @buff: where to store result
51f931551bSRalph Campbell * @len: number of bytes to receive
52f931551bSRalph Campbell */
qib_eeprom_read(struct qib_devdata * dd,u8 eeprom_offset,void * buff,int len)53f931551bSRalph Campbell int qib_eeprom_read(struct qib_devdata *dd, u8 eeprom_offset,
54f931551bSRalph Campbell void *buff, int len)
55f931551bSRalph Campbell {
56f931551bSRalph Campbell int ret;
57f931551bSRalph Campbell
58f931551bSRalph Campbell ret = mutex_lock_interruptible(&dd->eep_lock);
59f931551bSRalph Campbell if (!ret) {
60f931551bSRalph Campbell ret = qib_twsi_reset(dd);
61f931551bSRalph Campbell if (ret)
62f931551bSRalph Campbell qib_dev_err(dd, "EEPROM Reset for read failed\n");
63f931551bSRalph Campbell else
64f931551bSRalph Campbell ret = qib_twsi_blk_rd(dd, dd->twsi_eeprom_dev,
65f931551bSRalph Campbell eeprom_offset, buff, len);
66f931551bSRalph Campbell mutex_unlock(&dd->eep_lock);
67f931551bSRalph Campbell }
68f931551bSRalph Campbell
69f931551bSRalph Campbell return ret;
70f931551bSRalph Campbell }
71f931551bSRalph Campbell
72f931551bSRalph Campbell /*
73f931551bSRalph Campbell * Actually update the eeprom, first doing write enable if
74f931551bSRalph Campbell * needed, then restoring write enable state.
75f931551bSRalph Campbell * Must be called with eep_lock held
76f931551bSRalph Campbell */
eeprom_write_with_enable(struct qib_devdata * dd,u8 offset,const void * buf,int len)77f931551bSRalph Campbell static int eeprom_write_with_enable(struct qib_devdata *dd, u8 offset,
78f931551bSRalph Campbell const void *buf, int len)
79f931551bSRalph Campbell {
80f931551bSRalph Campbell int ret, pwen;
81f931551bSRalph Campbell
82f931551bSRalph Campbell pwen = dd->f_eeprom_wen(dd, 1);
83f931551bSRalph Campbell ret = qib_twsi_reset(dd);
84f931551bSRalph Campbell if (ret)
85f931551bSRalph Campbell qib_dev_err(dd, "EEPROM Reset for write failed\n");
86f931551bSRalph Campbell else
87f931551bSRalph Campbell ret = qib_twsi_blk_wr(dd, dd->twsi_eeprom_dev,
88f931551bSRalph Campbell offset, buf, len);
89f931551bSRalph Campbell dd->f_eeprom_wen(dd, pwen);
90f931551bSRalph Campbell return ret;
91f931551bSRalph Campbell }
92f931551bSRalph Campbell
93f931551bSRalph Campbell /**
94f931551bSRalph Campbell * qib_eeprom_write - writes data to the eeprom via I2C
95f931551bSRalph Campbell * @dd: the qlogic_ib device
96f931551bSRalph Campbell * @eeprom_offset: where to place data
97*aab5a7e9SLee Jones * @buff: data to write
98f931551bSRalph Campbell * @len: number of bytes to write
99f931551bSRalph Campbell */
qib_eeprom_write(struct qib_devdata * dd,u8 eeprom_offset,const void * buff,int len)100f931551bSRalph Campbell int qib_eeprom_write(struct qib_devdata *dd, u8 eeprom_offset,
101f931551bSRalph Campbell const void *buff, int len)
102f931551bSRalph Campbell {
103f931551bSRalph Campbell int ret;
104f931551bSRalph Campbell
105f931551bSRalph Campbell ret = mutex_lock_interruptible(&dd->eep_lock);
106f931551bSRalph Campbell if (!ret) {
107f931551bSRalph Campbell ret = eeprom_write_with_enable(dd, eeprom_offset, buff, len);
108f931551bSRalph Campbell mutex_unlock(&dd->eep_lock);
109f931551bSRalph Campbell }
110f931551bSRalph Campbell
111f931551bSRalph Campbell return ret;
112f931551bSRalph Campbell }
113f931551bSRalph Campbell
flash_csum(struct qib_flash * ifp,int adjust)114f931551bSRalph Campbell static u8 flash_csum(struct qib_flash *ifp, int adjust)
115f931551bSRalph Campbell {
116f931551bSRalph Campbell u8 *ip = (u8 *) ifp;
117f931551bSRalph Campbell u8 csum = 0, len;
118f931551bSRalph Campbell
119f931551bSRalph Campbell /*
120f931551bSRalph Campbell * Limit length checksummed to max length of actual data.
121f931551bSRalph Campbell * Checksum of erased eeprom will still be bad, but we avoid
122f931551bSRalph Campbell * reading past the end of the buffer we were passed.
123f931551bSRalph Campbell */
124f931551bSRalph Campbell len = ifp->if_length;
125f931551bSRalph Campbell if (len > sizeof(struct qib_flash))
126f931551bSRalph Campbell len = sizeof(struct qib_flash);
127f931551bSRalph Campbell while (len--)
128f931551bSRalph Campbell csum += *ip++;
129f931551bSRalph Campbell csum -= ifp->if_csum;
130f931551bSRalph Campbell csum = ~csum;
131f931551bSRalph Campbell if (adjust)
132f931551bSRalph Campbell ifp->if_csum = csum;
133f931551bSRalph Campbell
134f931551bSRalph Campbell return csum;
135f931551bSRalph Campbell }
136f931551bSRalph Campbell
137f931551bSRalph Campbell /**
138f931551bSRalph Campbell * qib_get_eeprom_info- get the GUID et al. from the TSWI EEPROM device
139f931551bSRalph Campbell * @dd: the qlogic_ib device
140f931551bSRalph Campbell *
141f931551bSRalph Campbell * We have the capability to use the nguid field, and get
142f931551bSRalph Campbell * the guid from the first chip's flash, to use for all of them.
143f931551bSRalph Campbell */
qib_get_eeprom_info(struct qib_devdata * dd)144f931551bSRalph Campbell void qib_get_eeprom_info(struct qib_devdata *dd)
145f931551bSRalph Campbell {
146f931551bSRalph Campbell void *buf;
147f931551bSRalph Campbell struct qib_flash *ifp;
148f931551bSRalph Campbell __be64 guid;
149f931551bSRalph Campbell int len, eep_stat;
150f931551bSRalph Campbell u8 csum, *bguid;
151f931551bSRalph Campbell int t = dd->unit;
152f931551bSRalph Campbell struct qib_devdata *dd0 = qib_lookup(0);
153f931551bSRalph Campbell
154f931551bSRalph Campbell if (t && dd0->nguid > 1 && t <= dd0->nguid) {
155f931551bSRalph Campbell u8 oguid;
156da12c1f6SMike Marciniszyn
157f931551bSRalph Campbell dd->base_guid = dd0->base_guid;
158f931551bSRalph Campbell bguid = (u8 *) &dd->base_guid;
159f931551bSRalph Campbell
160f931551bSRalph Campbell oguid = bguid[7];
161f931551bSRalph Campbell bguid[7] += t;
162f931551bSRalph Campbell if (oguid > bguid[7]) {
163f931551bSRalph Campbell if (bguid[6] == 0xff) {
164f931551bSRalph Campbell if (bguid[5] == 0xff) {
1657fac3301SMike Marciniszyn qib_dev_err(dd,
16611f0e897SMichael J. Ruhl "Can't set GUID from base, wraps to OUI!\n");
167f931551bSRalph Campbell dd->base_guid = 0;
168f931551bSRalph Campbell goto bail;
169f931551bSRalph Campbell }
170f931551bSRalph Campbell bguid[5]++;
171f931551bSRalph Campbell }
172f931551bSRalph Campbell bguid[6]++;
173f931551bSRalph Campbell }
174f931551bSRalph Campbell dd->nguid = 1;
175f931551bSRalph Campbell goto bail;
176f931551bSRalph Campbell }
177f931551bSRalph Campbell
178f931551bSRalph Campbell /*
179f931551bSRalph Campbell * Read full flash, not just currently used part, since it may have
180f931551bSRalph Campbell * been written with a newer definition.
181f931551bSRalph Campbell * */
182f931551bSRalph Campbell len = sizeof(struct qib_flash);
183f931551bSRalph Campbell buf = vmalloc(len);
184c40a83b9SLeon Romanovsky if (!buf)
185f931551bSRalph Campbell goto bail;
186f931551bSRalph Campbell
187f931551bSRalph Campbell /*
188f931551bSRalph Campbell * Use "public" eeprom read function, which does locking and
189f931551bSRalph Campbell * figures out device. This will migrate to chip-specific.
190f931551bSRalph Campbell */
191f931551bSRalph Campbell eep_stat = qib_eeprom_read(dd, 0, buf, len);
192f931551bSRalph Campbell
193f931551bSRalph Campbell if (eep_stat) {
194f931551bSRalph Campbell qib_dev_err(dd, "Failed reading GUID from eeprom\n");
195f931551bSRalph Campbell goto done;
196f931551bSRalph Campbell }
197f931551bSRalph Campbell ifp = (struct qib_flash *)buf;
198f931551bSRalph Campbell
199f931551bSRalph Campbell csum = flash_csum(ifp, 0);
200f931551bSRalph Campbell if (csum != ifp->if_csum) {
2017fac3301SMike Marciniszyn qib_devinfo(dd->pcidev,
2027fac3301SMike Marciniszyn "Bad I2C flash checksum: 0x%x, not 0x%x\n",
2037fac3301SMike Marciniszyn csum, ifp->if_csum);
204f931551bSRalph Campbell goto done;
205f931551bSRalph Campbell }
206f931551bSRalph Campbell if (*(__be64 *) ifp->if_guid == cpu_to_be64(0) ||
207f931551bSRalph Campbell *(__be64 *) ifp->if_guid == ~cpu_to_be64(0)) {
2087fac3301SMike Marciniszyn qib_dev_err(dd,
2097fac3301SMike Marciniszyn "Invalid GUID %llx from flash; ignoring\n",
210f931551bSRalph Campbell *(unsigned long long *) ifp->if_guid);
211f931551bSRalph Campbell /* don't allow GUID if all 0 or all 1's */
212f931551bSRalph Campbell goto done;
213f931551bSRalph Campbell }
214f931551bSRalph Campbell
215f931551bSRalph Campbell /* complain, but allow it */
216f931551bSRalph Campbell if (*(u64 *) ifp->if_guid == 0x100007511000000ULL)
2177fac3301SMike Marciniszyn qib_devinfo(dd->pcidev,
2187fac3301SMike Marciniszyn "Warning, GUID %llx is default, probably not correct!\n",
219f931551bSRalph Campbell *(unsigned long long *) ifp->if_guid);
220f931551bSRalph Campbell
221f931551bSRalph Campbell bguid = ifp->if_guid;
222f931551bSRalph Campbell if (!bguid[0] && !bguid[1] && !bguid[2]) {
223f931551bSRalph Campbell /*
224f931551bSRalph Campbell * Original incorrect GUID format in flash; fix in
225f931551bSRalph Campbell * core copy, by shifting up 2 octets; don't need to
226f931551bSRalph Campbell * change top octet, since both it and shifted are 0.
227f931551bSRalph Campbell */
228f931551bSRalph Campbell bguid[1] = bguid[3];
229f931551bSRalph Campbell bguid[2] = bguid[4];
230f931551bSRalph Campbell bguid[3] = 0;
231f931551bSRalph Campbell bguid[4] = 0;
232f931551bSRalph Campbell guid = *(__be64 *) ifp->if_guid;
233f931551bSRalph Campbell } else
234f931551bSRalph Campbell guid = *(__be64 *) ifp->if_guid;
235f931551bSRalph Campbell dd->base_guid = guid;
236f931551bSRalph Campbell dd->nguid = ifp->if_numguid;
237f931551bSRalph Campbell /*
238f931551bSRalph Campbell * Things are slightly complicated by the desire to transparently
239f931551bSRalph Campbell * support both the Pathscale 10-digit serial number and the QLogic
240f931551bSRalph Campbell * 13-character version.
241f931551bSRalph Campbell */
242f931551bSRalph Campbell if ((ifp->if_fversion > 1) && ifp->if_sprefix[0] &&
243f931551bSRalph Campbell ((u8 *) ifp->if_sprefix)[0] != 0xFF) {
244f931551bSRalph Campbell char *snp = dd->serial;
245f931551bSRalph Campbell
246f931551bSRalph Campbell /*
247f931551bSRalph Campbell * This board has a Serial-prefix, which is stored
248f931551bSRalph Campbell * elsewhere for backward-compatibility.
249f931551bSRalph Campbell */
250041af0bbSMike Marciniszyn memcpy(snp, ifp->if_sprefix, sizeof(ifp->if_sprefix));
251041af0bbSMike Marciniszyn snp[sizeof(ifp->if_sprefix)] = '\0';
252f931551bSRalph Campbell len = strlen(snp);
253f931551bSRalph Campbell snp += len;
254041af0bbSMike Marciniszyn len = sizeof(dd->serial) - len;
255041af0bbSMike Marciniszyn if (len > sizeof(ifp->if_serial))
256041af0bbSMike Marciniszyn len = sizeof(ifp->if_serial);
257f931551bSRalph Campbell memcpy(snp, ifp->if_serial, len);
258a46a2802SMike Marciniszyn } else {
259a46a2802SMike Marciniszyn memcpy(dd->serial, ifp->if_serial, sizeof(ifp->if_serial));
260a46a2802SMike Marciniszyn }
261f931551bSRalph Campbell if (!strstr(ifp->if_comment, "Tested successfully"))
2627fac3301SMike Marciniszyn qib_dev_err(dd,
2637fac3301SMike Marciniszyn "Board SN %s did not pass functional test: %s\n",
2647fac3301SMike Marciniszyn dd->serial, ifp->if_comment);
265f931551bSRalph Campbell
266f931551bSRalph Campbell done:
267f931551bSRalph Campbell vfree(buf);
268f931551bSRalph Campbell
269f931551bSRalph Campbell bail:;
270f931551bSRalph Campbell }
271f931551bSRalph Campbell
272