root/drivers/scsi/libsas/sas_internal.h
/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Serial Attached SCSI (SAS) class internal header file
 *
 * Copyright (C) 2005 Adaptec, Inc.  All rights reserved.
 * Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
 */

#ifndef _SAS_INTERNAL_H_
#define _SAS_INTERNAL_H_

#include <scsi/scsi.h>
#include <scsi/scsi_host.h>
#include <scsi/scsi_transport_sas.h>
#include <scsi/libsas.h>
#include <scsi/sas_ata.h>
#include <linux/pm_runtime.h>

#ifdef pr_fmt
#undef pr_fmt
#endif

#define SAS_FMT "sas: "

#define pr_fmt(fmt) SAS_FMT fmt

#define TO_SAS_TASK(_scsi_cmd)  ((void *)(_scsi_cmd)->host_scribble)
#define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0)

struct sas_phy_data {
        /* let reset be performed in sas_queue_work() context */
        struct sas_phy *phy;
        struct mutex event_lock;
        int hard_reset;
        int reset_result;
        struct sas_work reset_work;
        int enable;
        int enable_result;
        struct sas_work enable_work;
};

void sas_hash_addr(u8 *hashed, const u8 *sas_addr);

int sas_discover_root_expander(struct domain_device *dev);

int sas_ex_revalidate_domain(struct domain_device *dev);
void sas_unregister_domain_devices(struct asd_sas_port *port, bool gone);
void sas_init_disc(struct sas_discovery *disc, struct asd_sas_port *port);
void sas_discover_event(struct asd_sas_port *port, enum discover_event ev);

void sas_init_dev(struct domain_device *dev);
void sas_unregister_dev(struct asd_sas_port *port, struct domain_device *dev);

void sas_scsi_recover_host(struct Scsi_Host *shost);

int  sas_register_phys(struct sas_ha_struct *sas_ha);
void sas_unregister_phys(struct sas_ha_struct *sas_ha);

struct asd_sas_event *sas_alloc_event(struct asd_sas_phy *phy, gfp_t gfp_flags);
void sas_free_event(struct asd_sas_event *event);

struct sas_task *sas_alloc_task(gfp_t flags);
struct sas_task *sas_alloc_slow_task(gfp_t flags);
void sas_free_task(struct sas_task *task);

int  sas_register_ports(struct sas_ha_struct *sas_ha);
void sas_unregister_ports(struct sas_ha_struct *sas_ha);

void sas_disable_revalidation(struct sas_ha_struct *ha);
void sas_enable_revalidation(struct sas_ha_struct *ha);
void sas_queue_deferred_work(struct sas_ha_struct *ha);
void __sas_drain_work(struct sas_ha_struct *ha);

void sas_deform_port(struct asd_sas_phy *phy, bool gone);

void sas_porte_bytes_dmaed(struct work_struct *work);
void sas_porte_broadcast_rcvd(struct work_struct *work);
void sas_porte_link_reset_err(struct work_struct *work);
void sas_porte_timer_event(struct work_struct *work);
void sas_porte_hard_reset(struct work_struct *work);
bool sas_queue_work(struct sas_ha_struct *ha, struct sas_work *sw);

int sas_notify_lldd_dev_found(struct domain_device *);
void sas_notify_lldd_dev_gone(struct domain_device *);

void sas_smp_handler(struct bsg_job *job, struct Scsi_Host *shost,
                struct sas_rphy *rphy);
int sas_smp_phy_control(struct domain_device *dev, int phy_id,
                        enum phy_func phy_func, struct sas_phy_linkrates *);
int sas_smp_get_phy_events(struct sas_phy *phy);

void sas_device_set_phy(struct domain_device *dev, struct sas_port *port);
struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);
struct domain_device *sas_ex_to_ata(struct domain_device *ex_dev, int phy_id);
int sas_ex_phy_discover(struct domain_device *dev, int single);
int sas_get_report_phy_sata(struct domain_device *dev, int phy_id,
                            struct smp_rps_resp *rps_resp);
int sas_get_phy_attached_dev(struct domain_device *dev, int phy_id,
                             u8 *sas_addr, enum sas_device_type *type);
int sas_try_ata_reset(struct asd_sas_phy *phy);

void sas_free_device(struct kref *kref);
void sas_destruct_devices(struct asd_sas_port *port);

extern const work_func_t sas_phy_event_fns[PHY_NUM_EVENTS];
extern const work_func_t sas_port_event_fns[PORT_NUM_EVENTS];

void sas_task_internal_done(struct sas_task *task);
void sas_task_internal_timedout(struct timer_list *t);
int sas_execute_tmf(struct domain_device *device, void *parameter,
                    int para_len, int force_phy_id,
                    struct sas_tmf_task *tmf);

#ifdef CONFIG_SCSI_SAS_HOST_SMP
extern void sas_smp_host_handler(struct bsg_job *job, struct Scsi_Host *shost);
#else
static inline void sas_smp_host_handler(struct bsg_job *job,
                struct Scsi_Host *shost)
{
        shost_printk(KERN_ERR, shost,
                "Cannot send SMP to a sas host (not enabled in CONFIG)\n");
        bsg_job_done(job, -EINVAL, 0);
}
#endif

static inline bool sas_phy_match_dev_addr(struct domain_device *dev,
                                         struct ex_phy *phy)
{
        return SAS_ADDR(dev->sas_addr) == SAS_ADDR(phy->attached_sas_addr);
}

static inline bool sas_phy_match_port_addr(struct asd_sas_port *port,
                                           struct ex_phy *phy)
{
        return SAS_ADDR(port->sas_addr) == SAS_ADDR(phy->attached_sas_addr);
}

static inline bool sas_phy_addr_match(struct ex_phy *p1, struct ex_phy *p2)
{
        return  SAS_ADDR(p1->attached_sas_addr) == SAS_ADDR(p2->attached_sas_addr);
}

static inline void sas_fail_probe(struct domain_device *dev, const char *func, int err)
{
        pr_warn("%s: for %s device %016llx returned %d\n",
                func, dev->parent ? "exp-attached" :
                "direct-attached",
                SAS_ADDR(dev->sas_addr), err);
        sas_unregister_dev(dev->port, dev);
}

static inline void sas_fill_in_rphy(struct domain_device *dev,
                                    struct sas_rphy *rphy)
{
        rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
        rphy->identify.initiator_port_protocols = dev->iproto;
        rphy->identify.target_port_protocols = dev->tproto;
        switch (dev->dev_type) {
        case SAS_SATA_DEV:
                /* FIXME: need sata device type */
        case SAS_END_DEVICE:
        case SAS_SATA_PENDING:
                rphy->identify.device_type = SAS_END_DEVICE;
                break;
        case SAS_EDGE_EXPANDER_DEVICE:
                rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
                break;
        case SAS_FANOUT_EXPANDER_DEVICE:
                rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
                break;
        default:
                rphy->identify.device_type = SAS_PHY_UNUSED;
                break;
        }
}

static inline void sas_phy_set_target(struct asd_sas_phy *p, struct domain_device *dev)
{
        struct sas_phy *phy = p->phy;

        if (dev) {
                if (dev_is_sata(dev))
                        phy->identify.device_type = SAS_END_DEVICE;
                else
                        phy->identify.device_type = dev->dev_type;
                phy->identify.target_port_protocols = dev->tproto;
        } else {
                phy->identify.device_type = SAS_PHY_UNUSED;
                phy->identify.target_port_protocols = 0;
        }
}

static inline struct domain_device *sas_alloc_device(void)
{
        struct domain_device *dev = kzalloc_obj(*dev);

        if (dev) {
                INIT_LIST_HEAD(&dev->siblings);
                INIT_LIST_HEAD(&dev->dev_list_node);
                INIT_LIST_HEAD(&dev->disco_list_node);
                kref_init(&dev->kref);
                spin_lock_init(&dev->done_lock);
        }
        return dev;
}

static inline void sas_put_device(struct domain_device *dev)
{
        kref_put(&dev->kref, sas_free_device);
}

#ifdef CONFIG_SCSI_SAS_ATA

int sas_ata_init(struct domain_device *dev);
void sas_ata_task_abort(struct sas_task *task);
int sas_discover_sata(struct domain_device *dev);
int sas_ata_add_dev(struct domain_device *parent, struct ex_phy *phy,
                    struct domain_device *child, int phy_id);
void sas_ata_strategy_handler(struct Scsi_Host *shost);
void sas_ata_eh(struct Scsi_Host *shost, struct list_head *work_q);
void sas_ata_end_eh(struct ata_port *ap);
void sas_ata_wait_eh(struct domain_device *dev);
void sas_probe_sata(struct asd_sas_port *port);
void sas_suspend_sata(struct asd_sas_port *port);
void sas_resume_sata(struct asd_sas_port *port);

#else

static inline int sas_ata_init(struct domain_device *dev)
{
        return 0;
}

static inline void sas_ata_task_abort(struct sas_task *task)
{
}

static inline void sas_ata_strategy_handler(struct Scsi_Host *shost)
{
}

static inline void sas_ata_eh(struct Scsi_Host *shost, struct list_head *work_q)
{
}

static inline void sas_ata_end_eh(struct ata_port *ap)
{
}

static inline void sas_ata_wait_eh(struct domain_device *dev)
{
}

static inline void sas_probe_sata(struct asd_sas_port *port)
{
}

static inline void sas_suspend_sata(struct asd_sas_port *port)
{
}

static inline void sas_resume_sata(struct asd_sas_port *port)
{
}

static inline void sas_ata_disabled_notice(void)
{
        pr_notice_once("ATA device seen but CONFIG_SCSI_SAS_ATA=N\n");
}

static inline int sas_discover_sata(struct domain_device *dev)
{
        sas_ata_disabled_notice();
        return -ENXIO;
}

static inline int sas_ata_add_dev(struct domain_device *parent, struct ex_phy *phy,
                                  struct domain_device *child, int phy_id)
{
        sas_ata_disabled_notice();
        return -ENODEV;
}

#endif

#endif /* _SAS_INTERNAL_H_ */