1/*
2 * This file is provided under a dual BSD/GPLv2 license.  When using or
3 * redistributing this file, you may do so under either license.
4 *
5 * GPL LICENSE SUMMARY
6 *
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
23 */
24
25/* probe_roms - scan for oem parameters */
26
27#include <linux/kernel.h>
28#include <linux/firmware.h>
29#include <linux/uaccess.h>
30#include <linux/efi.h>
31#include <asm/probe_roms.h>
32
33#include "isci.h"
34#include "task.h"
35#include "probe_roms.h"
36
37static efi_char16_t isci_efivar_name[] = {
38	'R', 's', 't', 'S', 'c', 'u', 'O'
39};
40
41struct isci_orom *isci_request_oprom(struct pci_dev *pdev)
42{
43	void __iomem *oprom = pci_map_biosrom(pdev);
44	struct isci_orom *rom = NULL;
45	size_t len, i;
46	int j;
47	char oem_sig[4];
48	struct isci_oem_hdr oem_hdr;
49	u8 *tmp, sum;
50
51	if (!oprom)
52		return NULL;
53
54	len = pci_biosrom_size(pdev);
55	rom = devm_kzalloc(&pdev->dev, sizeof(*rom), GFP_KERNEL);
56	if (!rom) {
57		dev_warn(&pdev->dev,
58			 "Unable to allocate memory for orom\n");
59		return NULL;
60	}
61
62	for (i = 0; i < len && rom; i += ISCI_OEM_SIG_SIZE) {
63		memcpy_fromio(oem_sig, oprom + i, ISCI_OEM_SIG_SIZE);
64
65		/* we think we found the OEM table */
66		if (memcmp(oem_sig, ISCI_OEM_SIG, ISCI_OEM_SIG_SIZE) == 0) {
67			size_t copy_len;
68
69			memcpy_fromio(&oem_hdr, oprom + i, sizeof(oem_hdr));
70
71			copy_len = min(oem_hdr.len - sizeof(oem_hdr),
72				       sizeof(*rom));
73
74			memcpy_fromio(rom,
75				      oprom + i + sizeof(oem_hdr),
76				      copy_len);
77
78			/* calculate checksum */
79			tmp = (u8 *)&oem_hdr;
80			for (j = 0, sum = 0; j < sizeof(oem_hdr); j++, tmp++)
81				sum += *tmp;
82
83			tmp = (u8 *)rom;
84			for (j = 0; j < sizeof(*rom); j++, tmp++)
85				sum += *tmp;
86
87			if (sum != 0) {
88				dev_warn(&pdev->dev,
89					 "OEM table checksum failed\n");
90				continue;
91			}
92
93			/* keep going if that's not the oem param table */
94			if (memcmp(rom->hdr.signature,
95				   ISCI_ROM_SIG,
96				   ISCI_ROM_SIG_SIZE) != 0)
97				continue;
98
99			dev_info(&pdev->dev,
100				 "OEM parameter table found in OROM\n");
101			break;
102		}
103	}
104
105	if (i >= len) {
106		dev_err(&pdev->dev, "oprom parse error\n");
107		rom = NULL;
108	}
109	pci_unmap_biosrom(oprom);
110
111	return rom;
112}
113
114struct isci_orom *isci_request_firmware(struct pci_dev *pdev, const struct firmware *fw)
115{
116	struct isci_orom *orom = NULL, *data;
117	int i, j;
118
119	if (request_firmware(&fw, ISCI_FW_NAME, &pdev->dev) != 0)
120		return NULL;
121
122	if (fw->size < sizeof(*orom))
123		goto out;
124
125	data = (struct isci_orom *)fw->data;
126
127	if (strncmp(ISCI_ROM_SIG, data->hdr.signature,
128		    strlen(ISCI_ROM_SIG)) != 0)
129		goto out;
130
131	orom = devm_kzalloc(&pdev->dev, fw->size, GFP_KERNEL);
132	if (!orom)
133		goto out;
134
135	memcpy(orom, fw->data, fw->size);
136
137	if (is_c0(pdev) || is_c1(pdev))
138		goto out;
139
140	/*
141	 * deprecated: override default amp_control for pre-preproduction
142	 * silicon revisions
143	 */
144	for (i = 0; i < ARRAY_SIZE(orom->ctrl); i++)
145		for (j = 0; j < ARRAY_SIZE(orom->ctrl[i].phys); j++) {
146			orom->ctrl[i].phys[j].afe_tx_amp_control0 = 0xe7c03;
147			orom->ctrl[i].phys[j].afe_tx_amp_control1 = 0xe7c03;
148			orom->ctrl[i].phys[j].afe_tx_amp_control2 = 0xe7c03;
149			orom->ctrl[i].phys[j].afe_tx_amp_control3 = 0xe7c03;
150		}
151 out:
152	release_firmware(fw);
153
154	return orom;
155}
156
157static struct efi *get_efi(void)
158{
159#ifdef CONFIG_EFI
160	return &efi;
161#else
162	return NULL;
163#endif
164}
165
166struct isci_orom *isci_get_efi_var(struct pci_dev *pdev)
167{
168	efi_status_t status;
169	struct isci_orom *rom;
170	struct isci_oem_hdr *oem_hdr;
171	u8 *tmp, sum;
172	int j;
173	unsigned long data_len;
174	u8 *efi_data;
175	u32 efi_attrib = 0;
176
177	data_len = 1024;
178	efi_data = devm_kzalloc(&pdev->dev, data_len, GFP_KERNEL);
179	if (!efi_data) {
180		dev_warn(&pdev->dev,
181			 "Unable to allocate memory for EFI data\n");
182		return NULL;
183	}
184
185	rom = (struct isci_orom *)(efi_data + sizeof(struct isci_oem_hdr));
186
187	if (get_efi())
188		status = get_efi()->get_variable(isci_efivar_name,
189						 &ISCI_EFI_VENDOR_GUID,
190						 &efi_attrib,
191						 &data_len,
192						 efi_data);
193	else
194		status = EFI_NOT_FOUND;
195
196	if (status != EFI_SUCCESS) {
197		dev_warn(&pdev->dev,
198			 "Unable to obtain EFI var data for OEM parms\n");
199		return NULL;
200	}
201
202	oem_hdr = (struct isci_oem_hdr *)efi_data;
203
204	if (memcmp(oem_hdr->sig, ISCI_OEM_SIG, ISCI_OEM_SIG_SIZE) != 0) {
205		dev_warn(&pdev->dev,
206			 "Invalid OEM header signature\n");
207		return NULL;
208	}
209
210	/* calculate checksum */
211	tmp = (u8 *)efi_data;
212	for (j = 0, sum = 0; j < (sizeof(*oem_hdr) + sizeof(*rom)); j++, tmp++)
213		sum += *tmp;
214
215	if (sum != 0) {
216		dev_warn(&pdev->dev,
217			 "OEM table checksum failed\n");
218		return NULL;
219	}
220
221	if (memcmp(rom->hdr.signature,
222		   ISCI_ROM_SIG,
223		   ISCI_ROM_SIG_SIZE) != 0) {
224		dev_warn(&pdev->dev,
225			 "Invalid OEM table signature\n");
226		return NULL;
227	}
228
229	return rom;
230}
231