^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-only */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Serial Attached SCSI (SAS) class internal header file
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * Copyright (C) 2005 Adaptec, Inc. All rights reserved.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) #ifndef _SAS_INTERNAL_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #define _SAS_INTERNAL_H_
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <scsi/scsi.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <scsi/scsi_host.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <scsi/scsi_transport_sas.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <scsi/libsas.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <scsi/sas_ata.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #ifdef pr_fmt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #undef pr_fmt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define SAS_FMT "sas: "
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) #define pr_fmt(fmt) SAS_FMT fmt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) #define TO_SAS_TASK(_scsi_cmd) ((void *)(_scsi_cmd)->host_scribble)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) struct sas_phy_data {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) /* let reset be performed in sas_queue_work() context */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) struct sas_phy *phy;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) struct mutex event_lock;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) int hard_reset;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) int reset_result;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) struct sas_work reset_work;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) int enable;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) int enable_result;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) struct sas_work enable_work;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) void sas_scsi_recover_host(struct Scsi_Host *shost);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) int sas_show_class(enum sas_class class, char *buf);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) int sas_show_proto(enum sas_protocol proto, char *buf);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) int sas_register_phys(struct sas_ha_struct *sas_ha);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) void sas_unregister_phys(struct sas_ha_struct *sas_ha);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) struct asd_sas_event *sas_alloc_event(struct asd_sas_phy *phy);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) struct asd_sas_event *sas_alloc_event_gfp(struct asd_sas_phy *phy,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) gfp_t gfp_flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) void sas_free_event(struct asd_sas_event *event);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) int sas_register_ports(struct sas_ha_struct *sas_ha);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) void sas_unregister_ports(struct sas_ha_struct *sas_ha);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) void sas_disable_revalidation(struct sas_ha_struct *ha);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) void sas_enable_revalidation(struct sas_ha_struct *ha);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) void __sas_drain_work(struct sas_ha_struct *ha);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) void sas_deform_port(struct asd_sas_phy *phy, int gone);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) void sas_porte_bytes_dmaed(struct work_struct *work);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) void sas_porte_broadcast_rcvd(struct work_struct *work);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) void sas_porte_link_reset_err(struct work_struct *work);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) void sas_porte_timer_event(struct work_struct *work);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) void sas_porte_hard_reset(struct work_struct *work);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) int sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) int sas_notify_lldd_dev_found(struct domain_device *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) void sas_notify_lldd_dev_gone(struct domain_device *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) struct sas_rphy *rphy);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) int sas_smp_phy_control(struct domain_device *dev, int phy_id,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) enum phy_func phy_func, struct sas_phy_linkrates *);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) int sas_smp_get_phy_events(struct sas_phy *phy);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) int sas_notify_phy_event(struct asd_sas_phy *phy, enum phy_event event);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) int sas_notify_phy_event_gfp(struct asd_sas_phy *phy, enum phy_event event,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) gfp_t flags);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) void sas_device_set_phy(struct domain_device *dev, struct sas_port *port);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) int sas_ex_phy_discover(struct domain_device *dev, int single);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) int sas_get_report_phy_sata(struct domain_device *dev, int phy_id,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) struct smp_resp *rps_resp);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) int sas_try_ata_reset(struct asd_sas_phy *phy);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) void sas_hae_reset(struct work_struct *work);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) void sas_free_device(struct kref *kref);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) void sas_destruct_devices(struct asd_sas_port *port);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) extern const work_func_t sas_phy_event_fns[PHY_NUM_EVENTS];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) extern const work_func_t sas_port_event_fns[PORT_NUM_EVENTS];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) #ifdef CONFIG_SCSI_SAS_HOST_SMP
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) #else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) static inline void sas_smp_host_handler(struct bsg_job *job,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) struct Scsi_Host *shost)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) shost_printk(KERN_ERR, shost,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) bsg_job_done(job, -EINVAL, 0);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) #endif
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) pr_warn("%s: for %s device %016llx returned %d\n",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) func, dev->parent ? "exp-attached" :
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) "direct-attached",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) SAS_ADDR(dev->sas_addr), err);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) sas_unregister_dev(dev->port, dev);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) static inline void sas_fill_in_rphy(struct domain_device *dev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) struct sas_rphy *rphy)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) rphy->identify.initiator_port_protocols = dev->iproto;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) rphy->identify.target_port_protocols = dev->tproto;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) switch (dev->dev_type) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) case SAS_SATA_DEV:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) /* FIXME: need sata device type */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) case SAS_END_DEVICE:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) case SAS_SATA_PENDING:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) rphy->identify.device_type = SAS_END_DEVICE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) case SAS_EDGE_EXPANDER_DEVICE:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) case SAS_FANOUT_EXPANDER_DEVICE:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) default:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) rphy->identify.device_type = SAS_PHY_UNUSED;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) struct sas_phy *phy = p->phy;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) if (dev) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) if (dev_is_sata(dev))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) phy->identify.device_type = SAS_END_DEVICE;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) phy->identify.device_type = dev->dev_type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) phy->identify.target_port_protocols = dev->tproto;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) } else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) phy->identify.device_type = SAS_PHY_UNUSED;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) phy->identify.target_port_protocols = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161) static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) struct expander_device *ex = &dev->ex_dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) if (!ex->parent_port) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) /* FIXME: error handling */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) BUG_ON(!ex->parent_port);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) BUG_ON(sas_port_add(ex->parent_port));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) sas_port_mark_backlink(ex->parent_port);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) sas_port_add_phy(ex->parent_port, ex_phy->phy);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176) static inline struct domain_device *sas_alloc_device(void)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) if (dev) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181) INIT_LIST_HEAD(&dev->siblings);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) INIT_LIST_HEAD(&dev->dev_list_node);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) INIT_LIST_HEAD(&dev->disco_list_node);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) kref_init(&dev->kref);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) spin_lock_init(&dev->done_lock);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) return dev;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) static inline void sas_put_device(struct domain_device *dev)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) kref_put(&dev->kref, sas_free_device);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) #endif /* _SAS_INTERNAL_H_ */