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 
37 static efi_char16_t isci_efivar_name[] = {
38 	'R', 's', 't', 'S', 'c', 'u', 'O'
39 };
40 
isci_request_oprom(struct pci_dev * pdev)41 struct 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 
isci_parse_oem_parameters(struct sci_oem_params * oem,struct isci_orom * orom,int scu_index)114 enum sci_status isci_parse_oem_parameters(struct sci_oem_params *oem,
115 					  struct isci_orom *orom, int scu_index)
116 {
117 	/* check for valid inputs */
118 	if (scu_index < 0 || scu_index >= SCI_MAX_CONTROLLERS ||
119 	    scu_index > orom->hdr.num_elements || !oem)
120 		return -EINVAL;
121 
122 	*oem = orom->ctrl[scu_index];
123 	return 0;
124 }
125 
isci_request_firmware(struct pci_dev * pdev,const struct firmware * fw)126 struct isci_orom *isci_request_firmware(struct pci_dev *pdev, const struct firmware *fw)
127 {
128 	struct isci_orom *orom = NULL, *data;
129 	int i, j;
130 
131 	if (request_firmware(&fw, ISCI_FW_NAME, &pdev->dev) != 0)
132 		return NULL;
133 
134 	if (fw->size < sizeof(*orom))
135 		goto out;
136 
137 	data = (struct isci_orom *)fw->data;
138 
139 	if (strncmp(ISCI_ROM_SIG, data->hdr.signature,
140 		    strlen(ISCI_ROM_SIG)) != 0)
141 		goto out;
142 
143 	orom = devm_kzalloc(&pdev->dev, fw->size, GFP_KERNEL);
144 	if (!orom)
145 		goto out;
146 
147 	memcpy(orom, fw->data, fw->size);
148 
149 	if (is_c0(pdev) || is_c1(pdev))
150 		goto out;
151 
152 	/*
153 	 * deprecated: override default amp_control for pre-preproduction
154 	 * silicon revisions
155 	 */
156 	for (i = 0; i < ARRAY_SIZE(orom->ctrl); i++)
157 		for (j = 0; j < ARRAY_SIZE(orom->ctrl[i].phys); j++) {
158 			orom->ctrl[i].phys[j].afe_tx_amp_control0 = 0xe7c03;
159 			orom->ctrl[i].phys[j].afe_tx_amp_control1 = 0xe7c03;
160 			orom->ctrl[i].phys[j].afe_tx_amp_control2 = 0xe7c03;
161 			orom->ctrl[i].phys[j].afe_tx_amp_control3 = 0xe7c03;
162 		}
163  out:
164 	release_firmware(fw);
165 
166 	return orom;
167 }
168 
get_efi(void)169 static struct efi *get_efi(void)
170 {
171 #ifdef CONFIG_EFI
172 	return &efi;
173 #else
174 	return NULL;
175 #endif
176 }
177 
isci_get_efi_var(struct pci_dev * pdev)178 struct isci_orom *isci_get_efi_var(struct pci_dev *pdev)
179 {
180 	efi_status_t status;
181 	struct isci_orom *rom;
182 	struct isci_oem_hdr *oem_hdr;
183 	u8 *tmp, sum;
184 	int j;
185 	unsigned long data_len;
186 	u8 *efi_data;
187 	u32 efi_attrib = 0;
188 
189 	data_len = 1024;
190 	efi_data = devm_kzalloc(&pdev->dev, data_len, GFP_KERNEL);
191 	if (!efi_data) {
192 		dev_warn(&pdev->dev,
193 			 "Unable to allocate memory for EFI data\n");
194 		return NULL;
195 	}
196 
197 	rom = (struct isci_orom *)(efi_data + sizeof(struct isci_oem_hdr));
198 
199 	if (get_efi())
200 		status = get_efi()->get_variable(isci_efivar_name,
201 						 &ISCI_EFI_VENDOR_GUID,
202 						 &efi_attrib,
203 						 &data_len,
204 						 efi_data);
205 	else
206 		status = EFI_NOT_FOUND;
207 
208 	if (status != EFI_SUCCESS) {
209 		dev_warn(&pdev->dev,
210 			 "Unable to obtain EFI var data for OEM parms\n");
211 		return NULL;
212 	}
213 
214 	oem_hdr = (struct isci_oem_hdr *)efi_data;
215 
216 	if (memcmp(oem_hdr->sig, ISCI_OEM_SIG, ISCI_OEM_SIG_SIZE) != 0) {
217 		dev_warn(&pdev->dev,
218 			 "Invalid OEM header signature\n");
219 		return NULL;
220 	}
221 
222 	/* calculate checksum */
223 	tmp = (u8 *)efi_data;
224 	for (j = 0, sum = 0; j < (sizeof(*oem_hdr) + sizeof(*rom)); j++, tmp++)
225 		sum += *tmp;
226 
227 	if (sum != 0) {
228 		dev_warn(&pdev->dev,
229 			 "OEM table checksum failed\n");
230 		return NULL;
231 	}
232 
233 	if (memcmp(rom->hdr.signature,
234 		   ISCI_ROM_SIG,
235 		   ISCI_ROM_SIG_SIZE) != 0) {
236 		dev_warn(&pdev->dev,
237 			 "Invalid OEM table signature\n");
238 		return NULL;
239 	}
240 
241 	return rom;
242 }
243