Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Serial Attached SCSI (SAS) class internal header file
0004  *
0005  * Copyright (C) 2005 Adaptec, Inc.  All rights reserved.
0006  * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
0007  */
0008 
0009 #ifndef _SAS_INTERNAL_H_
0010 #define _SAS_INTERNAL_H_
0011 
0012 #include <scsi/scsi.h>
0013 #include <scsi/scsi_host.h>
0014 #include <scsi/scsi_transport_sas.h>
0015 #include <scsi/libsas.h>
0016 #include <scsi/sas_ata.h>
0017 #include <linux/pm_runtime.h>
0018 
0019 #ifdef pr_fmt
0020 #undef pr_fmt
0021 #endif
0022 
0023 #define SAS_FMT "sas: "
0024 
0025 #define pr_fmt(fmt) SAS_FMT fmt
0026 
0027 #define TO_SAS_TASK(_scsi_cmd)  ((void *)(_scsi_cmd)->host_scribble)
0028 #define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0)
0029 
0030 struct sas_phy_data {
0031     /* let reset be performed in sas_queue_work() context */
0032     struct sas_phy *phy;
0033     struct mutex event_lock;
0034     int hard_reset;
0035     int reset_result;
0036     struct sas_work reset_work;
0037     int enable;
0038     int enable_result;
0039     struct sas_work enable_work;
0040 };
0041 
0042 void sas_scsi_recover_host(struct Scsi_Host *shost);
0043 
0044 int sas_show_class(enum sas_class class, char *buf);
0045 int sas_show_proto(enum sas_protocol proto, char *buf);
0046 int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
0047 int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf);
0048 
0049 int  sas_register_phys(struct sas_ha_struct *sas_ha);
0050 void sas_unregister_phys(struct sas_ha_struct *sas_ha);
0051 
0052 struct asd_sas_event *sas_alloc_event(struct asd_sas_phy *phy, gfp_t gfp_flags);
0053 void sas_free_event(struct asd_sas_event *event);
0054 
0055 int  sas_register_ports(struct sas_ha_struct *sas_ha);
0056 void sas_unregister_ports(struct sas_ha_struct *sas_ha);
0057 
0058 void sas_disable_revalidation(struct sas_ha_struct *ha);
0059 void sas_enable_revalidation(struct sas_ha_struct *ha);
0060 void sas_queue_deferred_work(struct sas_ha_struct *ha);
0061 void __sas_drain_work(struct sas_ha_struct *ha);
0062 
0063 void sas_deform_port(struct asd_sas_phy *phy, int gone);
0064 
0065 void sas_porte_bytes_dmaed(struct work_struct *work);
0066 void sas_porte_broadcast_rcvd(struct work_struct *work);
0067 void sas_porte_link_reset_err(struct work_struct *work);
0068 void sas_porte_timer_event(struct work_struct *work);
0069 void sas_porte_hard_reset(struct work_struct *work);
0070 bool sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw);
0071 
0072 int sas_notify_lldd_dev_found(struct domain_device *);
0073 void sas_notify_lldd_dev_gone(struct domain_device *);
0074 
0075 void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost,
0076         struct sas_rphy *rphy);
0077 int sas_smp_phy_control(struct domain_device *dev, int phy_id,
0078             enum phy_func phy_func, struct sas_phy_linkrates *);
0079 int sas_smp_get_phy_events(struct sas_phy *phy);
0080 
0081 void sas_device_set_phy(struct domain_device *dev, struct sas_port *port);
0082 struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
0083 struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
0084 int sas_ex_phy_discover(struct domain_device *dev, int single);
0085 int sas_get_report_phy_sata(struct domain_device *dev, int phy_id,
0086                 struct smp_rps_resp *rps_resp);
0087 int sas_try_ata_reset(struct asd_sas_phy *phy);
0088 void sas_hae_reset(struct work_struct *work);
0089 
0090 void sas_free_device(struct kref *kref);
0091 void sas_destruct_devices(struct asd_sas_port *port);
0092 
0093 extern const work_func_t sas_phy_event_fns[PHY_NUM_EVENTS];
0094 extern const work_func_t sas_port_event_fns[PORT_NUM_EVENTS];
0095 
0096 void sas_task_internal_done(struct sas_task *task);
0097 void sas_task_internal_timedout(struct timer_list *t);
0098 int sas_execute_tmf(struct domain_device *device, void *parameter,
0099             int para_len, int force_phy_id,
0100             struct sas_tmf_task *tmf);
0101 
0102 #ifdef CONFIG_SCSI_SAS_HOST_SMP
0103 extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost);
0104 #else
0105 static inline void sas_smp_host_handler(struct bsg_job *job,
0106         struct Scsi_Host *shost)
0107 {
0108     shost_printk(KERN_ERR, shost,
0109         "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
0110     bsg_job_done(job, -EINVAL, 0);
0111 }
0112 #endif
0113 
0114 static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err)
0115 {
0116     pr_warn("%s: for %s device %016llx returned %d\n",
0117         func, dev->parent ? "exp-attached" :
0118         "direct-attached",
0119         SAS_ADDR(dev->sas_addr), err);
0120     sas_unregister_dev(dev->port, dev);
0121 }
0122 
0123 static inline void sas_fill_in_rphy(struct domain_device *dev,
0124                     struct sas_rphy *rphy)
0125 {
0126     rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
0127     rphy->identify.initiator_port_protocols = dev->iproto;
0128     rphy->identify.target_port_protocols = dev->tproto;
0129     switch (dev->dev_type) {
0130     case SAS_SATA_DEV:
0131         /* FIXME: need sata device type */
0132     case SAS_END_DEVICE:
0133     case SAS_SATA_PENDING:
0134         rphy->identify.device_type = SAS_END_DEVICE;
0135         break;
0136     case SAS_EDGE_EXPANDER_DEVICE:
0137         rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
0138         break;
0139     case SAS_FANOUT_EXPANDER_DEVICE:
0140         rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
0141         break;
0142     default:
0143         rphy->identify.device_type = SAS_PHY_UNUSED;
0144         break;
0145     }
0146 }
0147 
0148 static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev)
0149 {
0150     struct sas_phy *phy = p->phy;
0151 
0152     if (dev) {
0153         if (dev_is_sata(dev))
0154             phy->identify.device_type = SAS_END_DEVICE;
0155         else
0156             phy->identify.device_type = dev->dev_type;
0157         phy->identify.target_port_protocols = dev->tproto;
0158     } else {
0159         phy->identify.device_type = SAS_PHY_UNUSED;
0160         phy->identify.target_port_protocols = 0;
0161     }
0162 }
0163 
0164 static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
0165 {
0166     struct expander_device *ex = &dev->ex_dev;
0167     struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
0168 
0169     if (!ex->parent_port) {
0170         ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
0171         /* FIXME: error handling */
0172         BUG_ON(!ex->parent_port);
0173         BUG_ON(sas_port_add(ex->parent_port));
0174         sas_port_mark_backlink(ex->parent_port);
0175     }
0176     sas_port_add_phy(ex->parent_port, ex_phy->phy);
0177 }
0178 
0179 static inline struct domain_device *sas_alloc_device(void)
0180 {
0181     struct domain_device *dev = kzalloc(sizeof(*dev), GFP_KERNEL);
0182 
0183     if (dev) {
0184         INIT_LIST_HEAD(&dev->siblings);
0185         INIT_LIST_HEAD(&dev->dev_list_node);
0186         INIT_LIST_HEAD(&dev->disco_list_node);
0187         kref_init(&dev->kref);
0188         spin_lock_init(&dev->done_lock);
0189     }
0190     return dev;
0191 }
0192 
0193 static inline void sas_put_device(struct domain_device *dev)
0194 {
0195     kref_put(&dev->kref, sas_free_device);
0196 }
0197 
0198 #endif /* _SAS_INTERNAL_H_ */