2 * PMC-Sierra 8001/8081/8088/8089 SAS/SATA based host adapters driver
4 * Copyright (c) 2008-2009 USI Co., Ltd.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification.
13 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
14 * substantially similar to the "NO WARRANTY" disclaimer below
15 * ("Disclaimer") and any redistribution must be conditioned upon
16 * including a substantially similar Disclaimer requirement for further
17 * binary redistribution.
18 * 3. Neither the names of the above-listed copyright holders nor the names
19 * of any contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * Alternatively, this software may be distributed under the terms of the
23 * GNU General Public License ("GPL") version 2 as published by the Free
24 * Software Foundation.
27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
30 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
35 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
36 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGES.
40 #include <linux/firmware.h>
41 #include <linux/slab.h>
42 #include "pm8001_sas.h"
43 #include "pm8001_ctl.h"
45 /* scsi host attributes */
48 * pm8001_ctl_mpi_interface_rev_show - MPI interface revision number
49 * @cdev: pointer to embedded class device
50 * @buf: the buffer returned
52 * A sysfs 'read-only' shost attribute.
54 static ssize_t pm8001_ctl_mpi_interface_rev_show(struct device *cdev,
55 struct device_attribute *attr, char *buf)
57 struct Scsi_Host *shost = class_to_shost(cdev);
58 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
59 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
61 if (pm8001_ha->chip_id == chip_8001) {
62 return snprintf(buf, PAGE_SIZE, "%d\n",
63 pm8001_ha->main_cfg_tbl.pm8001_tbl.interface_rev);
65 return snprintf(buf, PAGE_SIZE, "%d\n",
66 pm8001_ha->main_cfg_tbl.pm80xx_tbl.interface_rev);
70 DEVICE_ATTR(interface_rev, S_IRUGO, pm8001_ctl_mpi_interface_rev_show, NULL);
73 * pm8001_ctl_fw_version_show - firmware version
74 * @cdev: pointer to embedded class device
75 * @buf: the buffer returned
77 * A sysfs 'read-only' shost attribute.
79 static ssize_t pm8001_ctl_fw_version_show(struct device *cdev,
80 struct device_attribute *attr, char *buf)
82 struct Scsi_Host *shost = class_to_shost(cdev);
83 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
84 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
86 if (pm8001_ha->chip_id == chip_8001) {
87 return snprintf(buf, PAGE_SIZE, "%02x.%02x.%02x.%02x\n",
88 (u8)(pm8001_ha->main_cfg_tbl.pm8001_tbl.firmware_rev >> 24),
89 (u8)(pm8001_ha->main_cfg_tbl.pm8001_tbl.firmware_rev >> 16),
90 (u8)(pm8001_ha->main_cfg_tbl.pm8001_tbl.firmware_rev >> 8),
91 (u8)(pm8001_ha->main_cfg_tbl.pm8001_tbl.firmware_rev));
93 return snprintf(buf, PAGE_SIZE, "%02x.%02x.%02x.%02x\n",
94 (u8)(pm8001_ha->main_cfg_tbl.pm80xx_tbl.firmware_rev >> 24),
95 (u8)(pm8001_ha->main_cfg_tbl.pm80xx_tbl.firmware_rev >> 16),
96 (u8)(pm8001_ha->main_cfg_tbl.pm80xx_tbl.firmware_rev >> 8),
97 (u8)(pm8001_ha->main_cfg_tbl.pm80xx_tbl.firmware_rev));
100 static DEVICE_ATTR(fw_version, S_IRUGO, pm8001_ctl_fw_version_show, NULL);
102 * pm8001_ctl_max_out_io_show - max outstanding io supported
103 * @cdev: pointer to embedded class device
104 * @buf: the buffer returned
106 * A sysfs 'read-only' shost attribute.
108 static ssize_t pm8001_ctl_max_out_io_show(struct device *cdev,
109 struct device_attribute *attr, char *buf)
111 struct Scsi_Host *shost = class_to_shost(cdev);
112 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
113 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
115 if (pm8001_ha->chip_id == chip_8001) {
116 return snprintf(buf, PAGE_SIZE, "%d\n",
117 pm8001_ha->main_cfg_tbl.pm8001_tbl.max_out_io);
119 return snprintf(buf, PAGE_SIZE, "%d\n",
120 pm8001_ha->main_cfg_tbl.pm80xx_tbl.max_out_io);
123 static DEVICE_ATTR(max_out_io, S_IRUGO, pm8001_ctl_max_out_io_show, NULL);
125 * pm8001_ctl_max_devices_show - max devices support
126 * @cdev: pointer to embedded class device
127 * @buf: the buffer returned
129 * A sysfs 'read-only' shost attribute.
131 static ssize_t pm8001_ctl_max_devices_show(struct device *cdev,
132 struct device_attribute *attr, char *buf)
134 struct Scsi_Host *shost = class_to_shost(cdev);
135 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
136 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
138 if (pm8001_ha->chip_id == chip_8001) {
139 return snprintf(buf, PAGE_SIZE, "%04d\n",
140 (u16)(pm8001_ha->main_cfg_tbl.pm8001_tbl.max_sgl >> 16)
143 return snprintf(buf, PAGE_SIZE, "%04d\n",
144 (u16)(pm8001_ha->main_cfg_tbl.pm80xx_tbl.max_sgl >> 16)
148 static DEVICE_ATTR(max_devices, S_IRUGO, pm8001_ctl_max_devices_show, NULL);
150 * pm8001_ctl_max_sg_list_show - max sg list supported iff not 0.0 for no
151 * hardware limitation
152 * @cdev: pointer to embedded class device
153 * @buf: the buffer returned
155 * A sysfs 'read-only' shost attribute.
157 static ssize_t pm8001_ctl_max_sg_list_show(struct device *cdev,
158 struct device_attribute *attr, char *buf)
160 struct Scsi_Host *shost = class_to_shost(cdev);
161 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
162 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
164 if (pm8001_ha->chip_id == chip_8001) {
165 return snprintf(buf, PAGE_SIZE, "%04d\n",
166 pm8001_ha->main_cfg_tbl.pm8001_tbl.max_sgl & 0x0000FFFF
169 return snprintf(buf, PAGE_SIZE, "%04d\n",
170 pm8001_ha->main_cfg_tbl.pm80xx_tbl.max_sgl & 0x0000FFFF
174 static DEVICE_ATTR(max_sg_list, S_IRUGO, pm8001_ctl_max_sg_list_show, NULL);
181 show_sas_spec_support_status(unsigned int mode, char *buf)
186 len = sprintf(buf, "%s", "SAS1.1");
188 len += sprintf(buf + len, "%s%s", len ? ", " : "", "SAS2.0");
189 len += sprintf(buf + len, "\n");
195 * pm8001_ctl_sas_spec_support_show - sas spec supported
196 * @cdev: pointer to embedded class device
197 * @buf: the buffer returned
199 * A sysfs 'read-only' shost attribute.
201 static ssize_t pm8001_ctl_sas_spec_support_show(struct device *cdev,
202 struct device_attribute *attr, char *buf)
205 struct Scsi_Host *shost = class_to_shost(cdev);
206 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
207 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
208 /* fe000000 means supports SAS2.1 */
209 if (pm8001_ha->chip_id == chip_8001)
210 mode = (pm8001_ha->main_cfg_tbl.pm8001_tbl.ctrl_cap_flag &
213 /* fe000000 means supports SAS2.1 */
214 mode = (pm8001_ha->main_cfg_tbl.pm80xx_tbl.ctrl_cap_flag &
216 return show_sas_spec_support_status(mode, buf);
218 static DEVICE_ATTR(sas_spec_support, S_IRUGO,
219 pm8001_ctl_sas_spec_support_show, NULL);
222 * pm8001_ctl_sas_address_show - sas address
223 * @cdev: pointer to embedded class device
224 * @buf: the buffer returned
226 * This is the controller sas address
228 * A sysfs 'read-only' shost attribute.
230 static ssize_t pm8001_ctl_host_sas_address_show(struct device *cdev,
231 struct device_attribute *attr, char *buf)
233 struct Scsi_Host *shost = class_to_shost(cdev);
234 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
235 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
236 return snprintf(buf, PAGE_SIZE, "0x%016llx\n",
237 be64_to_cpu(*(__be64 *)pm8001_ha->sas_addr));
239 static DEVICE_ATTR(host_sas_address, S_IRUGO,
240 pm8001_ctl_host_sas_address_show, NULL);
243 * pm8001_ctl_logging_level_show - logging level
244 * @cdev: pointer to embedded class device
245 * @buf: the buffer returned
247 * A sysfs 'read/write' shost attribute.
249 static ssize_t pm8001_ctl_logging_level_show(struct device *cdev,
250 struct device_attribute *attr, char *buf)
252 struct Scsi_Host *shost = class_to_shost(cdev);
253 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
254 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
256 return snprintf(buf, PAGE_SIZE, "%08xh\n", pm8001_ha->logging_level);
258 static ssize_t pm8001_ctl_logging_level_store(struct device *cdev,
259 struct device_attribute *attr, const char *buf, size_t count)
261 struct Scsi_Host *shost = class_to_shost(cdev);
262 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
263 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
266 if (sscanf(buf, "%x", &val) != 1)
269 pm8001_ha->logging_level = val;
273 static DEVICE_ATTR(logging_level, S_IRUGO | S_IWUSR,
274 pm8001_ctl_logging_level_show, pm8001_ctl_logging_level_store);
276 * pm8001_ctl_aap_log_show - aap1 event log
277 * @cdev: pointer to embedded class device
278 * @buf: the buffer returned
280 * A sysfs 'read-only' shost attribute.
282 static ssize_t pm8001_ctl_aap_log_show(struct device *cdev,
283 struct device_attribute *attr, char *buf)
285 struct Scsi_Host *shost = class_to_shost(cdev);
286 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
287 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
289 #define AAP1_MEMMAP(r, c) \
290 (*(u32 *)((u8*)pm8001_ha->memoryMap.region[AAP1].virt_ptr + (r) * 32 \
295 for (i = 0; i < max; i++) {
296 str += sprintf(str, "0x%08x 0x%08x 0x%08x 0x%08x 0x%08x 0x%08x"
310 static DEVICE_ATTR(aap_log, S_IRUGO, pm8001_ctl_aap_log_show, NULL);
312 * pm8001_ctl_aap_log_show - IOP event log
313 * @cdev: pointer to embedded class device
314 * @buf: the buffer returned
316 * A sysfs 'read-only' shost attribute.
318 static ssize_t pm8001_ctl_iop_log_show(struct device *cdev,
319 struct device_attribute *attr, char *buf)
321 struct Scsi_Host *shost = class_to_shost(cdev);
322 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
323 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
324 #define IOP_MEMMAP(r, c) \
325 (*(u32 *)((u8*)pm8001_ha->memoryMap.region[IOP].virt_ptr + (r) * 32 \
330 for (i = 0; i < max; i++) {
331 str += sprintf(str, "0x%08x 0x%08x 0x%08x 0x%08x 0x%08x 0x%08x"
345 static DEVICE_ATTR(iop_log, S_IRUGO, pm8001_ctl_iop_log_show, NULL);
347 #define FLASH_CMD_NONE 0x00
348 #define FLASH_CMD_UPDATE 0x01
349 #define FLASH_CMD_SET_NVMD 0x02
351 struct flash_command {
356 static struct flash_command flash_command_table[] =
358 {"set_nvmd", FLASH_CMD_SET_NVMD},
359 {"update", FLASH_CMD_UPDATE},
360 {"", FLASH_CMD_NONE} /* Last entry should be NULL. */
368 static struct error_fw flash_error_table[] =
370 {"Failed to open fw image file", FAIL_OPEN_BIOS_FILE},
371 {"image header mismatch", FLASH_UPDATE_HDR_ERR},
372 {"image offset mismatch", FLASH_UPDATE_OFFSET_ERR},
373 {"image CRC Error", FLASH_UPDATE_CRC_ERR},
374 {"image length Error.", FLASH_UPDATE_LENGTH_ERR},
375 {"Failed to program flash chip", FLASH_UPDATE_HW_ERR},
376 {"Flash chip not supported.", FLASH_UPDATE_DNLD_NOT_SUPPORTED},
377 {"Flash update disabled.", FLASH_UPDATE_DISABLED},
378 {"Flash in progress", FLASH_IN_PROGRESS},
379 {"Image file size Error", FAIL_FILE_SIZE},
380 {"Input parameter error", FAIL_PARAMETERS},
381 {"Out of memory", FAIL_OUT_MEMORY},
382 {"OK", 0} /* Last entry err_code = 0. */
385 static int pm8001_set_nvmd(struct pm8001_hba_info *pm8001_ha)
387 struct pm8001_ioctl_payload *payload;
388 DECLARE_COMPLETION_ONSTACK(completion);
389 u8 *ioctlbuffer = NULL;
393 length = 1024 * 5 + sizeof(*payload) - 1;
394 ioctlbuffer = kzalloc(length, GFP_KERNEL);
397 if ((pm8001_ha->fw_image->size <= 0) ||
398 (pm8001_ha->fw_image->size > 4096)) {
399 ret = FAIL_FILE_SIZE;
402 payload = (struct pm8001_ioctl_payload *)ioctlbuffer;
403 memcpy((u8 *)&payload->func_specific, (u8 *)pm8001_ha->fw_image->data,
404 pm8001_ha->fw_image->size);
405 payload->length = pm8001_ha->fw_image->size;
407 payload->minor_function = 0x1;
408 pm8001_ha->nvmd_completion = &completion;
409 ret = PM8001_CHIP_DISP->set_nvmd_req(pm8001_ha, payload);
410 wait_for_completion(&completion);
416 static int pm8001_update_flash(struct pm8001_hba_info *pm8001_ha)
418 struct pm8001_ioctl_payload *payload;
419 DECLARE_COMPLETION_ONSTACK(completion);
420 u8 *ioctlbuffer = NULL;
422 struct fw_control_info *fwControl;
423 u32 loopNumber, loopcount = 0;
425 u32 partitionSize, partitionSizeTmp;
427 u32 partitionNumber = 0;
428 struct pm8001_fw_image_header *image_hdr;
430 length = 1024 * 16 + sizeof(*payload) - 1;
431 ioctlbuffer = kzalloc(length, GFP_KERNEL);
432 image_hdr = (struct pm8001_fw_image_header *)pm8001_ha->fw_image->data;
435 if (pm8001_ha->fw_image->size < 28) {
436 ret = FAIL_FILE_SIZE;
440 while (sizeRead < pm8001_ha->fw_image->size) {
442 *(u32 *)((u8 *)&image_hdr->image_length + sizeRead);
443 partitionSize = be32_to_cpu(partitionSizeTmp);
444 loopcount = (partitionSize + HEADER_LEN)/IOCTL_BUF_SIZE;
445 if (loopcount % IOCTL_BUF_SIZE)
449 for (loopNumber = 0; loopNumber < loopcount; loopNumber++) {
450 payload = (struct pm8001_ioctl_payload *)ioctlbuffer;
451 payload->length = 1024*16;
454 (struct fw_control_info *)&payload->func_specific;
455 fwControl->len = IOCTL_BUF_SIZE; /* IN */
456 fwControl->size = partitionSize + HEADER_LEN;/* IN */
457 fwControl->retcode = 0;/* OUT */
458 fwControl->offset = loopNumber * IOCTL_BUF_SIZE;/*OUT */
460 /* for the last chunk of data in case file size is not even with
461 4k, load only the rest*/
462 if (((loopcount-loopNumber) == 1) &&
463 ((partitionSize + HEADER_LEN) % IOCTL_BUF_SIZE)) {
465 (partitionSize + HEADER_LEN) % IOCTL_BUF_SIZE;
466 memcpy((u8 *)fwControl->buffer,
467 (u8 *)pm8001_ha->fw_image->data + sizeRead,
468 (partitionSize + HEADER_LEN) % IOCTL_BUF_SIZE);
470 (partitionSize + HEADER_LEN) % IOCTL_BUF_SIZE;
472 memcpy((u8 *)fwControl->buffer,
473 (u8 *)pm8001_ha->fw_image->data + sizeRead,
475 sizeRead += IOCTL_BUF_SIZE;
478 pm8001_ha->nvmd_completion = &completion;
479 ret = PM8001_CHIP_DISP->fw_flash_update_req(pm8001_ha, payload);
480 wait_for_completion(&completion);
481 if (ret || (fwControl->retcode > FLASH_UPDATE_IN_PROGRESS)) {
482 ret = fwControl->retcode;
496 static ssize_t pm8001_store_update_fw(struct device *cdev,
497 struct device_attribute *attr,
498 const char *buf, size_t count)
500 struct Scsi_Host *shost = class_to_shost(cdev);
501 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
502 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
503 char *cmd_ptr, *filename_ptr;
505 int flash_command = FLASH_CMD_NONE;
507 if (!capable(CAP_SYS_ADMIN))
510 cmd_ptr = kzalloc(count*2, GFP_KERNEL);
513 err = FAIL_OUT_MEMORY;
517 filename_ptr = cmd_ptr + count;
518 res = sscanf(buf, "%s %s", cmd_ptr, filename_ptr);
520 err = FAIL_PARAMETERS;
524 for (i = 0; flash_command_table[i].code != FLASH_CMD_NONE; i++) {
525 if (!memcmp(flash_command_table[i].command,
526 cmd_ptr, strlen(cmd_ptr))) {
527 flash_command = flash_command_table[i].code;
531 if (flash_command == FLASH_CMD_NONE) {
532 err = FAIL_PARAMETERS;
536 if (pm8001_ha->fw_status == FLASH_IN_PROGRESS) {
537 err = FLASH_IN_PROGRESS;
540 err = request_firmware(&pm8001_ha->fw_image,
545 PM8001_FAIL_DBG(pm8001_ha,
546 pm8001_printk("Failed to load firmware image file %s,"
547 " error %d\n", filename_ptr, err));
548 err = FAIL_OPEN_BIOS_FILE;
552 switch (flash_command) {
553 case FLASH_CMD_UPDATE:
554 pm8001_ha->fw_status = FLASH_IN_PROGRESS;
555 err = pm8001_update_flash(pm8001_ha);
557 case FLASH_CMD_SET_NVMD:
558 pm8001_ha->fw_status = FLASH_IN_PROGRESS;
559 err = pm8001_set_nvmd(pm8001_ha);
562 pm8001_ha->fw_status = FAIL_PARAMETERS;
563 err = FAIL_PARAMETERS;
566 release_firmware(pm8001_ha->fw_image);
570 pm8001_ha->fw_status = err;
578 static ssize_t pm8001_show_update_fw(struct device *cdev,
579 struct device_attribute *attr, char *buf)
582 struct Scsi_Host *shost = class_to_shost(cdev);
583 struct sas_ha_struct *sha = SHOST_TO_SAS_HA(shost);
584 struct pm8001_hba_info *pm8001_ha = sha->lldd_ha;
586 for (i = 0; flash_error_table[i].err_code != 0; i++) {
587 if (flash_error_table[i].err_code == pm8001_ha->fw_status)
590 if (pm8001_ha->fw_status != FLASH_IN_PROGRESS)
591 pm8001_ha->fw_status = FLASH_OK;
593 return snprintf(buf, PAGE_SIZE, "status=%x %s\n",
594 flash_error_table[i].err_code,
595 flash_error_table[i].reason);
598 static DEVICE_ATTR(update_fw, S_IRUGO|S_IWUGO,
599 pm8001_show_update_fw, pm8001_store_update_fw);
600 struct device_attribute *pm8001_host_attrs[] = {
601 &dev_attr_interface_rev,
602 &dev_attr_fw_version,
606 &dev_attr_max_out_io,
607 &dev_attr_max_devices,
608 &dev_attr_max_sg_list,
609 &dev_attr_sas_spec_support,
610 &dev_attr_logging_level,
611 &dev_attr_host_sas_address,