[mirror_ubuntu-bionic-kernel.git] / drivers / scsi / libsas / sas_internal.h

/*
 * 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>
 *
 * This file is licensed under GPLv2.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 *
 */

#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>

#define sas_printk(fmt, ...) printk(KERN_NOTICE "sas: " fmt, ## __VA_ARGS__)

#define SAS_DPRINTK(fmt, ...) printk(KERN_DEBUG "sas: " fmt, ## __VA_ARGS__)

#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)

void sas_scsi_recover_host(struct Scsi_Host *shost);

int sas_show_class(enum sas_class class, char *buf);
int sas_show_proto(enum sas_protocol proto, char *buf);
int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf);

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

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

enum blk_eh_timer_return sas_scsi_timed_out(struct scsi_cmnd *);

int  sas_init_queue(struct sas_ha_struct *sas_ha);
int  sas_init_events(struct sas_ha_struct *sas_ha);
void sas_shutdown_queue(struct sas_ha_struct *sas_ha);

void sas_deform_port(struct asd_sas_phy *phy, int 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);

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

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);

struct domain_device *sas_find_dev_by_rphy(struct sas_rphy *rphy);

void sas_hae_reset(struct work_struct *work);

#ifdef CONFIG_SCSI_SAS_HOST_SMP
extern int sas_smp_host_handler(struct Scsi_Host *shost, struct request *req,
				struct request *rsp);
#else
static inline int sas_smp_host_handler(struct Scsi_Host *shost,
				       struct request *req,
				       struct request *rsp)
{
	shost_printk(KERN_ERR, shost,
		"Cannot send SMP to a sas host (not enabled in CONFIG)\n");
	return -EINVAL;
}
#endif

static inline void sas_queue_event(int event, spinlock_t *lock,
				   unsigned long *pending,
				   struct work_struct *work,
				   struct sas_ha_struct *sas_ha)
{
	unsigned long flags;

	spin_lock_irqsave(lock, flags);
	if (test_bit(event, pending)) {
		spin_unlock_irqrestore(lock, flags);
		return;
	}
	__set_bit(event, pending);
	spin_unlock_irqrestore(lock, flags);

	spin_lock_irqsave(&sas_ha->state_lock, flags);
	if (sas_ha->state != SAS_HA_UNREGISTERED) {
		scsi_queue_work(sas_ha->core.shost, work);
	}
	spin_unlock_irqrestore(&sas_ha->state_lock, flags);
}

static inline void sas_begin_event(int event, spinlock_t *lock,
				   unsigned long *pending)
{
	unsigned long flags;

	spin_lock_irqsave(lock, flags);
	__clear_bit(event, pending);
	spin_unlock_irqrestore(lock, flags);
}

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 SATA_DEV:
		/* FIXME: need sata device type */
	case SAS_END_DEV:
		rphy->identify.device_type = SAS_END_DEVICE;
		break;
	case EDGE_DEV:
		rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
		break;
	case FANOUT_DEV:
		rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
		break;
	default:
		rphy->identify.device_type = SAS_PHY_UNUSED;
		break;
	}
}

static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
{
	struct expander_device *ex = &dev->ex_dev;
	struct ex_phy *ex_phy = &ex->ex_phy[phy_id];

	if (!ex->parent_port) {
		ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
		/* FIXME: error handling */
		BUG_ON(!ex->parent_port);
		BUG_ON(sas_port_add(ex->parent_port));
		sas_port_mark_backlink(ex->parent_port);
	}
	sas_port_add_phy(ex->parent_port, ex_phy->phy);
}

#endif /* _SAS_INTERNAL_H_ */
Commit	Line	Data
2908d778 JB	1	/*
	2	* Serial Attached SCSI (SAS) class internal header file
	3	*
	4	* Copyright (C) 2005 Adaptec, Inc. All rights reserved.
	5	* Copyright (C) 2005 Luben Tuikov <luben_tuikov@adaptec.com>
	6	*
	7	* This file is licensed under GPLv2.
	8	*
	9	* This program is free software; you can redistribute it and/or
	10	* modify it under the terms of the GNU General Public License as
	11	* published by the Free Software Foundation; either version 2 of the
	12	* License, or (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful, but
	15	* WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	17	* General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
	22	* USA
	23	*
	24	*/
	25
	26	#ifndef _SAS_INTERNAL_H_
	27	#define _SAS_INTERNAL_H_
	28
	29	#include <scsi/scsi.h>
	30	#include <scsi/scsi_host.h>
	31	#include <scsi/scsi_transport_sas.h>
	32	#include <scsi/libsas.h>
	33
	34	#define sas_printk(fmt, ...) printk(KERN_NOTICE "sas: " fmt, ## __VA_ARGS__)
	35
96db6fa9	36	#define SAS_DPRINTK(fmt, ...) printk(KERN_DEBUG "sas: " fmt, ## __VA_ARGS__)
2908d778	37
3a2755af DW	38	#define TO_SAS_TASK(_scsi_cmd) ((void *)(_scsi_cmd)->host_scribble)
	39	#define ASSIGN_SAS_TASK(_sc, _t) do { (_sc)->host_scribble = (void *) _t; } while (0)
	40
2908d778 JB	41	void sas_scsi_recover_host(struct Scsi_Host *shost);
	42
	43	int sas_show_class(enum sas_class class, char *buf);
5929faf3	44	int sas_show_proto(enum sas_protocol proto, char *buf);
88edf746	45	int sas_show_linkrate(enum sas_linkrate linkrate, char *buf);
2908d778 JB	46	int sas_show_oob_mode(enum sas_oob_mode oob_mode, char *buf);
	47
	48	int sas_register_phys(struct sas_ha_struct *sas_ha);
	49	void sas_unregister_phys(struct sas_ha_struct *sas_ha);
	50
	51	int sas_register_ports(struct sas_ha_struct *sas_ha);
	52	void sas_unregister_ports(struct sas_ha_struct *sas_ha);
	53
242f9dcb	54	enum blk_eh_timer_return sas_scsi_timed_out(struct scsi_cmnd *);
2908d778 JB	55
	56	int sas_init_queue(struct sas_ha_struct *sas_ha);
	57	int sas_init_events(struct sas_ha_struct *sas_ha);
	58	void sas_shutdown_queue(struct sas_ha_struct *sas_ha);
	59
90f1e10d	60	void sas_deform_port(struct asd_sas_phy *phy, int gone);
2908d778	61
c4028958 DH	62	void sas_porte_bytes_dmaed(struct work_struct *work);
	63	void sas_porte_broadcast_rcvd(struct work_struct *work);
	64	void sas_porte_link_reset_err(struct work_struct *work);
	65	void sas_porte_timer_event(struct work_struct *work);
	66	void sas_porte_hard_reset(struct work_struct *work);
2908d778 JB	67
	68	int sas_notify_lldd_dev_found(struct domain_device *);
	69	void sas_notify_lldd_dev_gone(struct domain_device *);
	70
	71	int sas_smp_phy_control(struct domain_device *dev, int phy_id,
a01e70e5	72	enum phy_func phy_func, struct sas_phy_linkrates *);
2908d778 JB	73	int sas_smp_get_phy_events(struct sas_phy *phy);
	74
	75	struct domain_device sas_find_dev_by_rphy(struct sas_rphy rphy);
	76
c4028958	77	void sas_hae_reset(struct work_struct *work);
2908d778	78
b98e66fa JB	79	#ifdef CONFIG_SCSI_SAS_HOST_SMP
	80	extern int sas_smp_host_handler(struct Scsi_Host shost, struct request req,
	81	struct request *rsp);
	82	#else
	83	static inline int sas_smp_host_handler(struct Scsi_Host *shost,
	84	struct request *req,
	85	struct request *rsp)
	86	{
	87	shost_printk(KERN_ERR, shost,
	88	"Cannot send SMP to a sas host (not enabled in CONFIG)\n");
	89	return -EINVAL;
	90	}
	91	#endif
	92
2908d778 JB	93	static inline void sas_queue_event(int event, spinlock_t *lock,
	94	unsigned long *pending,
	95	struct work_struct *work,
6b0efb85	96	struct sas_ha_struct *sas_ha)
2908d778 JB	97	{
	98	unsigned long flags;
	99
	100	spin_lock_irqsave(lock, flags);
	101	if (test_bit(event, pending)) {
	102	spin_unlock_irqrestore(lock, flags);
	103	return;
	104	}
	105	__set_bit(event, pending);
	106	spin_unlock_irqrestore(lock, flags);
6b0efb85 DW	107
	108	spin_lock_irqsave(&sas_ha->state_lock, flags);
	109	if (sas_ha->state != SAS_HA_UNREGISTERED) {
	110	scsi_queue_work(sas_ha->core.shost, work);
	111	}
	112	spin_unlock_irqrestore(&sas_ha->state_lock, flags);
2908d778 JB	113	}
	114
	115	static inline void sas_begin_event(int event, spinlock_t *lock,
	116	unsigned long *pending)
	117	{
	118	unsigned long flags;
	119
	120	spin_lock_irqsave(lock, flags);
	121	__clear_bit(event, pending);
	122	spin_unlock_irqrestore(lock, flags);
	123	}
	124
	125	static inline void sas_fill_in_rphy(struct domain_device *dev,
	126	struct sas_rphy *rphy)
	127	{
	128	rphy->identify.sas_address = SAS_ADDR(dev->sas_addr);
	129	rphy->identify.initiator_port_protocols = dev->iproto;
	130	rphy->identify.target_port_protocols = dev->tproto;
	131	switch (dev->dev_type) {
	132	case SATA_DEV:
	133	/* FIXME: need sata device type */
	134	case SAS_END_DEV:
	135	rphy->identify.device_type = SAS_END_DEVICE;
	136	break;
	137	case EDGE_DEV:
	138	rphy->identify.device_type = SAS_EDGE_EXPANDER_DEVICE;
	139	break;
	140	case FANOUT_DEV:
	141	rphy->identify.device_type = SAS_FANOUT_EXPANDER_DEVICE;
	142	break;
	143	default:
	144	rphy->identify.device_type = SAS_PHY_UNUSED;
	145	break;
	146	}
	147	}
	148
	149	static inline void sas_add_parent_port(struct domain_device *dev, int phy_id)
	150	{
	151	struct expander_device *ex = &dev->ex_dev;
	152	struct ex_phy *ex_phy = &ex->ex_phy[phy_id];
	153
	154	if (!ex->parent_port) {
	155	ex->parent_port = sas_port_alloc(&dev->rphy->dev, phy_id);
	156	/* FIXME: error handling */
	157	BUG_ON(!ex->parent_port);
	158	BUG_ON(sas_port_add(ex->parent_port));
	159	sas_port_mark_backlink(ex->parent_port);
	160	}
	161	sas_port_add_phy(ex->parent_port, ex_phy->phy);
	162	}
	163
	164	#endif /* _SAS_INTERNAL_H_ */