root/drivers/scsi/qla4xxx/ql4_attr.c
// SPDX-License-Identifier: GPL-2.0-only
/*
 * QLogic iSCSI HBA Driver
 * Copyright (c)  2003-2013 QLogic Corporation
 */

#include "ql4_def.h"
#include "ql4_glbl.h"
#include "ql4_dbg.h"

static ssize_t
qla4_8xxx_sysfs_read_fw_dump(struct file *filep, struct kobject *kobj,
                             const struct bin_attribute *ba, char *buf, loff_t off,
                             size_t count)
{
        struct scsi_qla_host *ha = to_qla_host(dev_to_shost(container_of(kobj,
                                               struct device, kobj)));

        if (is_qla40XX(ha))
                return -EINVAL;

        if (!test_bit(AF_82XX_DUMP_READING, &ha->flags))
                return 0;

        return memory_read_from_buffer(buf, count, &off, ha->fw_dump,
                                       ha->fw_dump_size);
}

static ssize_t
qla4_8xxx_sysfs_write_fw_dump(struct file *filep, struct kobject *kobj,
                              const struct bin_attribute *ba, char *buf, loff_t off,
                              size_t count)
{
        struct scsi_qla_host *ha = to_qla_host(dev_to_shost(container_of(kobj,
                                               struct device, kobj)));
        uint32_t dev_state;
        long reading;
        int ret = 0;

        if (is_qla40XX(ha))
                return -EINVAL;

        if (off != 0)
                return ret;

        buf[1] = 0;
        ret = kstrtol(buf, 10, &reading);
        if (ret) {
                ql4_printk(KERN_ERR, ha, "%s: Invalid input. Return err %d\n",
                           __func__, ret);
                return ret;
        }

        switch (reading) {
        case 0:
                /* clear dump collection flags */
                if (test_and_clear_bit(AF_82XX_DUMP_READING, &ha->flags)) {
                        clear_bit(AF_82XX_FW_DUMPED, &ha->flags);
                        /* Reload minidump template */
                        qla4xxx_alloc_fw_dump(ha);
                        DEBUG2(ql4_printk(KERN_INFO, ha,
                                          "Firmware template reloaded\n"));
                }
                break;
        case 1:
                /* Set flag to read dump */
                if (test_bit(AF_82XX_FW_DUMPED, &ha->flags) &&
                    !test_bit(AF_82XX_DUMP_READING, &ha->flags)) {
                        set_bit(AF_82XX_DUMP_READING, &ha->flags);
                        DEBUG2(ql4_printk(KERN_INFO, ha,
                                          "Raw firmware dump ready for read on (%ld).\n",
                                          ha->host_no));
                }
                break;
        case 2:
                /* Reset HBA and collect FW dump */
                ha->isp_ops->idc_lock(ha);
                dev_state = qla4_8xxx_rd_direct(ha, QLA8XXX_CRB_DEV_STATE);
                if (dev_state == QLA8XXX_DEV_READY) {
                        ql4_printk(KERN_INFO, ha, "%s: Setting Need reset\n",
                                   __func__);
                        qla4_8xxx_wr_direct(ha, QLA8XXX_CRB_DEV_STATE,
                                            QLA8XXX_DEV_NEED_RESET);
                        if (is_qla8022(ha) ||
                            ((is_qla8032(ha) || is_qla8042(ha)) &&
                             qla4_83xx_can_perform_reset(ha))) {
                                set_bit(AF_8XXX_RST_OWNER, &ha->flags);
                                set_bit(AF_FW_RECOVERY, &ha->flags);
                                ql4_printk(KERN_INFO, ha, "%s: Reset owner is 0x%x\n",
                                           __func__, ha->func_num);
                        }
                } else
                        ql4_printk(KERN_INFO, ha,
                                   "%s: Reset not performed as device state is 0x%x\n",
                                   __func__, dev_state);

                ha->isp_ops->idc_unlock(ha);
                break;
        default:
                /* do nothing */
                break;
        }

        return count;
}

static const struct bin_attribute sysfs_fw_dump_attr = {
        .attr = {
                .name = "fw_dump",
                .mode = S_IRUSR | S_IWUSR,
        },
        .size = 0,
        .read = qla4_8xxx_sysfs_read_fw_dump,
        .write = qla4_8xxx_sysfs_write_fw_dump,
};

static struct sysfs_entry {
        char *name;
        const struct bin_attribute *attr;
} bin_file_entries[] = {
        { "fw_dump", &sysfs_fw_dump_attr },
        { NULL },
};

void qla4_8xxx_alloc_sysfs_attr(struct scsi_qla_host *ha)
{
        struct Scsi_Host *host = ha->host;
        struct sysfs_entry *iter;
        int ret;

        for (iter = bin_file_entries; iter->name; iter++) {
                ret = sysfs_create_bin_file(&host->shost_gendev.kobj,
                                            iter->attr);
                if (ret)
                        ql4_printk(KERN_ERR, ha,
                                   "Unable to create sysfs %s binary attribute (%d).\n",
                                   iter->name, ret);
        }
}

void qla4_8xxx_free_sysfs_attr(struct scsi_qla_host *ha)
{
        struct Scsi_Host *host = ha->host;
        struct sysfs_entry *iter;

        for (iter = bin_file_entries; iter->name; iter++)
                sysfs_remove_bin_file(&host->shost_gendev.kobj,
                                      iter->attr);
}

/* Scsi_Host attributes. */
static ssize_t
qla4xxx_fw_version_show(struct device *dev,
                        struct device_attribute *attr, char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));

        if (is_qla80XX(ha))
                return snprintf(buf, PAGE_SIZE, "%d.%02d.%02d (%x)\n",
                                ha->fw_info.fw_major, ha->fw_info.fw_minor,
                                ha->fw_info.fw_patch, ha->fw_info.fw_build);
        else
                return snprintf(buf, PAGE_SIZE, "%d.%02d.%02d.%02d\n",
                                ha->fw_info.fw_major, ha->fw_info.fw_minor,
                                ha->fw_info.fw_patch, ha->fw_info.fw_build);
}

static ssize_t
qla4xxx_serial_num_show(struct device *dev, struct device_attribute *attr,
                        char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));
        return snprintf(buf, PAGE_SIZE, "%s\n", ha->serial_number);
}

static ssize_t
qla4xxx_iscsi_version_show(struct device *dev, struct device_attribute *attr,
                           char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));
        return snprintf(buf, PAGE_SIZE, "%d.%02d\n", ha->fw_info.iscsi_major,
                        ha->fw_info.iscsi_minor);
}

static ssize_t
qla4xxx_optrom_version_show(struct device *dev, struct device_attribute *attr,
                            char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));
        return snprintf(buf, PAGE_SIZE, "%d.%02d.%02d.%02d\n",
                        ha->fw_info.bootload_major, ha->fw_info.bootload_minor,
                        ha->fw_info.bootload_patch, ha->fw_info.bootload_build);
}

static ssize_t
qla4xxx_board_id_show(struct device *dev, struct device_attribute *attr,
                      char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));
        return snprintf(buf, PAGE_SIZE, "0x%08X\n", ha->board_id);
}

static ssize_t
qla4xxx_fw_state_show(struct device *dev, struct device_attribute *attr,
                      char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));

        qla4xxx_get_firmware_state(ha);
        return snprintf(buf, PAGE_SIZE, "0x%08X%8X\n", ha->firmware_state,
                        ha->addl_fw_state);
}

static ssize_t
qla4xxx_phy_port_cnt_show(struct device *dev, struct device_attribute *attr,
                      char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));

        if (is_qla40XX(ha))
                return -ENOSYS;

        return snprintf(buf, PAGE_SIZE, "0x%04X\n", ha->phy_port_cnt);
}

static ssize_t
qla4xxx_phy_port_num_show(struct device *dev, struct device_attribute *attr,
                      char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));

        if (is_qla40XX(ha))
                return -ENOSYS;

        return snprintf(buf, PAGE_SIZE, "0x%04X\n", ha->phy_port_num);
}

static ssize_t
qla4xxx_iscsi_func_cnt_show(struct device *dev, struct device_attribute *attr,
                      char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));

        if (is_qla40XX(ha))
                return -ENOSYS;

        return snprintf(buf, PAGE_SIZE, "0x%04X\n", ha->iscsi_pci_func_cnt);
}

static ssize_t
qla4xxx_hba_model_show(struct device *dev, struct device_attribute *attr,
                       char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));

        return snprintf(buf, PAGE_SIZE, "%s\n", ha->model_name);
}

static ssize_t
qla4xxx_fw_timestamp_show(struct device *dev, struct device_attribute *attr,
                          char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));
        return snprintf(buf, PAGE_SIZE, "%s %s\n", ha->fw_info.fw_build_date,
                        ha->fw_info.fw_build_time);
}

static ssize_t
qla4xxx_fw_build_user_show(struct device *dev, struct device_attribute *attr,
                           char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));
        return snprintf(buf, PAGE_SIZE, "%s\n", ha->fw_info.fw_build_user);
}

static ssize_t
qla4xxx_fw_ext_timestamp_show(struct device *dev, struct device_attribute *attr,
                              char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));
        return snprintf(buf, PAGE_SIZE, "%s\n", ha->fw_info.extended_timestamp);
}

static ssize_t
qla4xxx_fw_load_src_show(struct device *dev, struct device_attribute *attr,
                         char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));
        char *load_src = NULL;

        switch (ha->fw_info.fw_load_source) {
        case 1:
                load_src = "Flash Primary";
                break;
        case 2:
                load_src = "Flash Secondary";
                break;
        case 3:
                load_src = "Host Download";
                break;
        }

        return snprintf(buf, PAGE_SIZE, "%s\n", load_src);
}

static ssize_t
qla4xxx_fw_uptime_show(struct device *dev, struct device_attribute *attr,
                       char *buf)
{
        struct scsi_qla_host *ha = to_qla_host(class_to_shost(dev));
        qla4xxx_about_firmware(ha);
        return snprintf(buf, PAGE_SIZE, "%u.%u secs\n", ha->fw_uptime_secs,
                        ha->fw_uptime_msecs);
}

static DEVICE_ATTR(fw_version, S_IRUGO, qla4xxx_fw_version_show, NULL);
static DEVICE_ATTR(serial_num, S_IRUGO, qla4xxx_serial_num_show, NULL);
static DEVICE_ATTR(iscsi_version, S_IRUGO, qla4xxx_iscsi_version_show, NULL);
static DEVICE_ATTR(optrom_version, S_IRUGO, qla4xxx_optrom_version_show, NULL);
static DEVICE_ATTR(board_id, S_IRUGO, qla4xxx_board_id_show, NULL);
static DEVICE_ATTR(fw_state, S_IRUGO, qla4xxx_fw_state_show, NULL);
static DEVICE_ATTR(phy_port_cnt, S_IRUGO, qla4xxx_phy_port_cnt_show, NULL);
static DEVICE_ATTR(phy_port_num, S_IRUGO, qla4xxx_phy_port_num_show, NULL);
static DEVICE_ATTR(iscsi_func_cnt, S_IRUGO, qla4xxx_iscsi_func_cnt_show, NULL);
static DEVICE_ATTR(hba_model, S_IRUGO, qla4xxx_hba_model_show, NULL);
static DEVICE_ATTR(fw_timestamp, S_IRUGO, qla4xxx_fw_timestamp_show, NULL);
static DEVICE_ATTR(fw_build_user, S_IRUGO, qla4xxx_fw_build_user_show, NULL);
static DEVICE_ATTR(fw_ext_timestamp, S_IRUGO, qla4xxx_fw_ext_timestamp_show,
                   NULL);
static DEVICE_ATTR(fw_load_src, S_IRUGO, qla4xxx_fw_load_src_show, NULL);
static DEVICE_ATTR(fw_uptime, S_IRUGO, qla4xxx_fw_uptime_show, NULL);

static struct attribute *qla4xxx_host_attrs[] = {
        &dev_attr_fw_version.attr,
        &dev_attr_serial_num.attr,
        &dev_attr_iscsi_version.attr,
        &dev_attr_optrom_version.attr,
        &dev_attr_board_id.attr,
        &dev_attr_fw_state.attr,
        &dev_attr_phy_port_cnt.attr,
        &dev_attr_phy_port_num.attr,
        &dev_attr_iscsi_func_cnt.attr,
        &dev_attr_hba_model.attr,
        &dev_attr_fw_timestamp.attr,
        &dev_attr_fw_build_user.attr,
        &dev_attr_fw_ext_timestamp.attr,
        &dev_attr_fw_load_src.attr,
        &dev_attr_fw_uptime.attr,
        NULL,
};

static const struct attribute_group qla4xxx_host_attr_group = {
        .attrs = qla4xxx_host_attrs
};

const struct attribute_group *qla4xxx_host_groups[] = {
        &qla4xxx_host_attr_group,
        NULL
};