[mirror_ubuntu-bionic-kernel.git] / drivers / scsi / libsas / sas_port.c

/*
 * Serial Attached SCSI (SAS) Port class
 *
 * 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#include "sas_internal.h"

#include <scsi/scsi_transport.h>
#include <scsi/scsi_transport_sas.h>
#include "../scsi_sas_internal.h"

static bool phy_is_wideport_member(struct asd_sas_port *port, struct asd_sas_phy *phy)
{
	struct sas_ha_struct *sas_ha = phy->ha;

	if (memcmp(port->attached_sas_addr, phy->attached_sas_addr,
		   SAS_ADDR_SIZE) != 0 || (sas_ha->strict_wide_ports &&
	     memcmp(port->sas_addr, phy->sas_addr, SAS_ADDR_SIZE) != 0))
		return false;
	return true;
}

/**
 * sas_form_port -- add this phy to a port
 * @phy: the phy of interest
 *
 * This function adds this phy to an existing port, thus creating a wide
 * port, or it creates a port and adds the phy to the port.
 */
static void sas_form_port(struct asd_sas_phy *phy)
{
	int i;
	struct sas_ha_struct *sas_ha = phy->ha;
	struct asd_sas_port *port = phy->port;
	struct sas_internal *si =
		to_sas_internal(sas_ha->core.shost->transportt);
	unsigned long flags;

	if (port) {
		if (!phy_is_wideport_member(port, phy))
			sas_deform_port(phy, 0);
		else {
			SAS_DPRINTK("%s: phy%d belongs to port%d already(%d)!\n",
				    __func__, phy->id, phy->port->id,
				    phy->port->num_phys);
			return;
		}
	}

	/* see if the phy should be part of a wide port */
	spin_lock_irqsave(&sas_ha->phy_port_lock, flags);
	for (i = 0; i < sas_ha->num_phys; i++) {
		port = sas_ha->sas_port[i];
		spin_lock(&port->phy_list_lock);
		if (*(u64 *) port->sas_addr &&
		    phy_is_wideport_member(port, phy) && port->num_phys > 0) {
			/* wide port */
			SAS_DPRINTK("phy%d matched wide port%d\n", phy->id,
				    port->id);
			break;
		}
		spin_unlock(&port->phy_list_lock);
	}
	/* The phy does not match any existing port, create a new one */
	if (i == sas_ha->num_phys) {
		for (i = 0; i < sas_ha->num_phys; i++) {
			port = sas_ha->sas_port[i];
			spin_lock(&port->phy_list_lock);
			if (*(u64 *)port->sas_addr == 0
				&& port->num_phys == 0) {
				memcpy(port->sas_addr, phy->sas_addr,
					SAS_ADDR_SIZE);
				break;
			}
			spin_unlock(&port->phy_list_lock);
		}
	}

	if (i >= sas_ha->num_phys) {
		printk(KERN_NOTICE "%s: couldn't find a free port, bug?\n",
		       __func__);
		spin_unlock_irqrestore(&sas_ha->phy_port_lock, flags);
		return;
	}

	/* add the phy to the port */
	list_add_tail(&phy->port_phy_el, &port->phy_list);
	sas_phy_set_target(phy, port->port_dev);
	phy->port = port;
	port->num_phys++;
	port->phy_mask |= (1U << phy->id);

	if (*(u64 *)port->attached_sas_addr == 0) {
		port->class = phy->class;
		memcpy(port->attached_sas_addr, phy->attached_sas_addr,
		       SAS_ADDR_SIZE);
		port->iproto = phy->iproto;
		port->tproto = phy->tproto;
		port->oob_mode = phy->oob_mode;
		port->linkrate = phy->linkrate;
	} else
		port->linkrate = max(port->linkrate, phy->linkrate);
	spin_unlock(&port->phy_list_lock);
	spin_unlock_irqrestore(&sas_ha->phy_port_lock, flags);

	if (!port->port) {
		port->port = sas_port_alloc(phy->phy->dev.parent, phy->id);
		BUG_ON(!port->port);
		sas_port_add(port->port);
	}
	sas_port_add_phy(port->port, phy->phy);

	SAS_DPRINTK("%s added to %s, phy_mask:0x%x (%16llx)\n",
		    dev_name(&phy->phy->dev), dev_name(&port->port->dev),
		    port->phy_mask,
		    SAS_ADDR(port->attached_sas_addr));

	if (port->port_dev)
		port->port_dev->pathways = port->num_phys;

	/* Tell the LLDD about this port formation. */
	if (si->dft->lldd_port_formed)
		si->dft->lldd_port_formed(phy);

	sas_discover_event(phy->port, DISCE_DISCOVER_DOMAIN);
}

/**
 * sas_deform_port -- remove this phy from the port it belongs to
 * @phy: the phy of interest
 *
 * This is called when the physical link to the other phy has been
 * lost (on this phy), in Event thread context. We cannot delay here.
 */
void sas_deform_port(struct asd_sas_phy *phy, int gone)
{
	struct sas_ha_struct *sas_ha = phy->ha;
	struct asd_sas_port *port = phy->port;
	struct sas_internal *si =
		to_sas_internal(sas_ha->core.shost->transportt);
	struct domain_device *dev;
	unsigned long flags;

	if (!port)
		return;		  /* done by a phy event */

	dev = port->port_dev;
	if (dev)
		dev->pathways--;

	if (port->num_phys == 1) {
		sas_unregister_domain_devices(port, gone);
		sas_port_delete(port->port);
		port->port = NULL;
	} else {
		sas_port_delete_phy(port->port, phy->phy);
		sas_device_set_phy(dev, port->port);
	}

	if (si->dft->lldd_port_deformed)
		si->dft->lldd_port_deformed(phy);

	spin_lock_irqsave(&sas_ha->phy_port_lock, flags);
	spin_lock(&port->phy_list_lock);

	list_del_init(&phy->port_phy_el);
	sas_phy_set_target(phy, NULL);
	phy->port = NULL;
	port->num_phys--;
	port->phy_mask &= ~(1U << phy->id);

	if (port->num_phys == 0) {
		INIT_LIST_HEAD(&port->phy_list);
		memset(port->sas_addr, 0, SAS_ADDR_SIZE);
		memset(port->attached_sas_addr, 0, SAS_ADDR_SIZE);
		port->class = 0;
		port->iproto = 0;
		port->tproto = 0;
		port->oob_mode = 0;
		port->phy_mask = 0;
	}
	spin_unlock(&port->phy_list_lock);
	spin_unlock_irqrestore(&sas_ha->phy_port_lock, flags);

	return;
}

/* ---------- SAS port events ---------- */

void sas_porte_bytes_dmaed(struct work_struct *work)
{
	struct asd_sas_event *ev =
		container_of(work, struct asd_sas_event, work);
	struct asd_sas_phy *phy = ev->phy;

	clear_bit(PORTE_BYTES_DMAED, &phy->port_events_pending);

	sas_form_port(phy);
}

void sas_porte_broadcast_rcvd(struct work_struct *work)
{
	struct asd_sas_event *ev =
		container_of(work, struct asd_sas_event, work);
	struct asd_sas_phy *phy = ev->phy;
	unsigned long flags;
	u32 prim;

	clear_bit(PORTE_BROADCAST_RCVD, &phy->port_events_pending);

	spin_lock_irqsave(&phy->sas_prim_lock, flags);
	prim = phy->sas_prim;
	spin_unlock_irqrestore(&phy->sas_prim_lock, flags);

	SAS_DPRINTK("broadcast received: %d\n", prim);
	sas_discover_event(phy->port, DISCE_REVALIDATE_DOMAIN);
}

void sas_porte_link_reset_err(struct work_struct *work)
{
	struct asd_sas_event *ev =
		container_of(work, struct asd_sas_event, work);
	struct asd_sas_phy *phy = ev->phy;

	clear_bit(PORTE_LINK_RESET_ERR, &phy->port_events_pending);

	sas_deform_port(phy, 1);
}

void sas_porte_timer_event(struct work_struct *work)
{
	struct asd_sas_event *ev =
		container_of(work, struct asd_sas_event, work);
	struct asd_sas_phy *phy = ev->phy;

	clear_bit(PORTE_TIMER_EVENT, &phy->port_events_pending);

	sas_deform_port(phy, 1);
}

void sas_porte_hard_reset(struct work_struct *work)
{
	struct asd_sas_event *ev =
		container_of(work, struct asd_sas_event, work);
	struct asd_sas_phy *phy = ev->phy;

	clear_bit(PORTE_HARD_RESET, &phy->port_events_pending);

	sas_deform_port(phy, 1);
}

/* ---------- SAS port registration ---------- */

static void sas_init_port(struct asd_sas_port *port,
			  struct sas_ha_struct *sas_ha, int i)
{
	memset(port, 0, sizeof(*port));
	port->id = i;
	INIT_LIST_HEAD(&port->dev_list);
	INIT_LIST_HEAD(&port->disco_list);
	INIT_LIST_HEAD(&port->destroy_list);
	spin_lock_init(&port->phy_list_lock);
	INIT_LIST_HEAD(&port->phy_list);
	port->ha = sas_ha;

	spin_lock_init(&port->dev_list_lock);
}

int sas_register_ports(struct sas_ha_struct *sas_ha)
{
	int i;

	/* initialize the ports and discovery */
	for (i = 0; i < sas_ha->num_phys; i++) {
		struct asd_sas_port *port = sas_ha->sas_port[i];

		sas_init_port(port, sas_ha, i);
		sas_init_disc(&port->disc, port);
	}
	return 0;
}

void sas_unregister_ports(struct sas_ha_struct *sas_ha)
{
	int i;

	for (i = 0; i < sas_ha->num_phys; i++)
		if (sas_ha->sas_phy[i]->port)
			sas_deform_port(sas_ha->sas_phy[i], 0);

}
Commit	Line	Data
2908d778 JB	1	/*
	2	* Serial Attached SCSI (SAS) Port class
	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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
	22	*
	23	*/
	24
	25	#include "sas_internal.h"
	26
	27	#include <scsi/scsi_transport.h>
	28	#include <scsi/scsi_transport_sas.h>
	29	#include "../scsi_sas_internal.h"
	30
00f0254e DW	31	static bool phy_is_wideport_member(struct asd_sas_port port, struct asd_sas_phy phy)
	32	{
	33	struct sas_ha_struct *sas_ha = phy->ha;
	34
	35	if (memcmp(port->attached_sas_addr, phy->attached_sas_addr,
	36	SAS_ADDR_SIZE) != 0 \|\| (sas_ha->strict_wide_ports &&
	37	memcmp(port->sas_addr, phy->sas_addr, SAS_ADDR_SIZE) != 0))
	38	return false;
	39	return true;
	40	}
	41
2908d778 JB	42	/**
	43	* sas_form_port -- add this phy to a port
	44	* @phy: the phy of interest
	45	*
	46	* This function adds this phy to an existing port, thus creating a wide
	47	* port, or it creates a port and adds the phy to the port.
	48	*/
	49	static void sas_form_port(struct asd_sas_phy *phy)
	50	{
	51	int i;
	52	struct sas_ha_struct *sas_ha = phy->ha;
	53	struct asd_sas_port *port = phy->port;
	54	struct sas_internal *si =
	55	to_sas_internal(sas_ha->core.shost->transportt);
980fa2f9	56	unsigned long flags;
2908d778 JB	57
2908d778 JB	58	if (port) {
00f0254e	59	if (!phy_is_wideport_member(port, phy))
90f1e10d	60	sas_deform_port(phy, 0);
2908d778 JB	61	else {
2908d778 JB	62	SAS_DPRINTK("%s: phy%d belongs to port%d already(%d)!\n",
cadbd4a5	63	__func__, phy->id, phy->port->id,
2908d778 JB	64	phy->port->num_phys);
	65	return;
	66	}
	67	}
	68
5381837f	69	/* see if the phy should be part of a wide port */
980fa2f9	70	spin_lock_irqsave(&sas_ha->phy_port_lock, flags);
2908d778 JB	71	for (i = 0; i < sas_ha->num_phys; i++) {
	72	port = sas_ha->sas_port[i];
	73	spin_lock(&port->phy_list_lock);
	74	if ((u64 ) port->sas_addr &&
00f0254e	75	phy_is_wideport_member(port, phy) && port->num_phys > 0) {
2908d778 JB	76	/* wide port */
	77	SAS_DPRINTK("phy%d matched wide port%d\n", phy->id,
	78	port->id);
	79	break;
2908d778 JB	80	}
	81	spin_unlock(&port->phy_list_lock);
	82	}
5381837f TP	83	/* The phy does not match any existing port, create a new one */
	84	if (i == sas_ha->num_phys) {
	85	for (i = 0; i < sas_ha->num_phys; i++) {
	86	port = sas_ha->sas_port[i];
	87	spin_lock(&port->phy_list_lock);
	88	if ((u64 )port->sas_addr == 0
	89	&& port->num_phys == 0) {
	90	memcpy(port->sas_addr, phy->sas_addr,
	91	SAS_ADDR_SIZE);
	92	break;
	93	}
	94	spin_unlock(&port->phy_list_lock);
	95	}
	96	}
2908d778 JB	97
	98	if (i >= sas_ha->num_phys) {
	99	printk(KERN_NOTICE "%s: couldn't find a free port, bug?\n",
cadbd4a5	100	__func__);
980fa2f9	101	spin_unlock_irqrestore(&sas_ha->phy_port_lock, flags);
2908d778 JB	102	return;
	103	}
	104
	105	/* add the phy to the port */
	106	list_add_tail(&phy->port_phy_el, &port->phy_list);
899fcf40	107	sas_phy_set_target(phy, port->port_dev);
2908d778 JB	108	phy->port = port;
	109	port->num_phys++;
	110	port->phy_mask \|= (1U << phy->id);
	111
2908d778 JB	112	if ((u64 )port->attached_sas_addr == 0) {
	113	port->class = phy->class;
	114	memcpy(port->attached_sas_addr, phy->attached_sas_addr,
	115	SAS_ADDR_SIZE);
	116	port->iproto = phy->iproto;
	117	port->tproto = phy->tproto;
	118	port->oob_mode = phy->oob_mode;
	119	port->linkrate = phy->linkrate;
	120	} else
	121	port->linkrate = max(port->linkrate, phy->linkrate);
	122	spin_unlock(&port->phy_list_lock);
980fa2f9	123	spin_unlock_irqrestore(&sas_ha->phy_port_lock, flags);
2908d778 JB	124
2908d778 JB	125	if (!port->port) {
a692b0ee	126	port->port = sas_port_alloc(phy->phy->dev.parent, phy->id);
2908d778 JB	127	BUG_ON(!port->port);
	128	sas_port_add(port->port);
	129	}
	130	sas_port_add_phy(port->port, phy->phy);
	131
a29c0515	132	SAS_DPRINTK("%s added to %s, phy_mask:0x%x (%16llx)\n",
71610f55	133	dev_name(&phy->phy->dev), dev_name(&port->port->dev),
a29c0515 JB	134	port->phy_mask,
	135	SAS_ADDR(port->attached_sas_addr));
	136
2908d778 JB	137	if (port->port_dev)
	138	port->port_dev->pathways = port->num_phys;
	139
	140	/* Tell the LLDD about this port formation. */
	141	if (si->dft->lldd_port_formed)
	142	si->dft->lldd_port_formed(phy);
	143
	144	sas_discover_event(phy->port, DISCE_DISCOVER_DOMAIN);
	145	}
	146
	147	/**
	148	* sas_deform_port -- remove this phy from the port it belongs to
	149	* @phy: the phy of interest
	150	*
	151	* This is called when the physical link to the other phy has been
	152	* lost (on this phy), in Event thread context. We cannot delay here.
	153	*/
90f1e10d	154	void sas_deform_port(struct asd_sas_phy *phy, int gone)
2908d778 JB	155	{
	156	struct sas_ha_struct *sas_ha = phy->ha;
	157	struct asd_sas_port *port = phy->port;
	158	struct sas_internal *si =
	159	to_sas_internal(sas_ha->core.shost->transportt);
90f1e10d	160	struct domain_device *dev;
980fa2f9	161	unsigned long flags;
2908d778 JB	162
	163	if (!port)
	164	return; /* done by a phy event */
	165
90f1e10d DW	166	dev = port->port_dev;
	167	if (dev)
	168	dev->pathways--;
2908d778 JB	169
2908d778 JB	170	if (port->num_phys == 1) {
7d05919a	171	sas_unregister_domain_devices(port, gone);
2908d778 JB	172	sas_port_delete(port->port);
2908d778 JB	173	port->port = NULL;
f41a0c44	174	} else {
2908d778	175	sas_port_delete_phy(port->port, phy->phy);
f41a0c44 DW	176	sas_device_set_phy(dev, port->port);
f41a0c44 DW	177	}
2908d778	178
2908d778 JB	179	if (si->dft->lldd_port_deformed)
	180	si->dft->lldd_port_deformed(phy);
	181
980fa2f9	182	spin_lock_irqsave(&sas_ha->phy_port_lock, flags);
2908d778 JB	183	spin_lock(&port->phy_list_lock);
	184
	185	list_del_init(&phy->port_phy_el);
899fcf40	186	sas_phy_set_target(phy, NULL);
2908d778 JB	187	phy->port = NULL;
	188	port->num_phys--;
	189	port->phy_mask &= ~(1U << phy->id);
	190
	191	if (port->num_phys == 0) {
	192	INIT_LIST_HEAD(&port->phy_list);
	193	memset(port->sas_addr, 0, SAS_ADDR_SIZE);
	194	memset(port->attached_sas_addr, 0, SAS_ADDR_SIZE);
	195	port->class = 0;
	196	port->iproto = 0;
	197	port->tproto = 0;
	198	port->oob_mode = 0;
	199	port->phy_mask = 0;
	200	}
	201	spin_unlock(&port->phy_list_lock);
980fa2f9	202	spin_unlock_irqrestore(&sas_ha->phy_port_lock, flags);
2908d778 JB	203
	204	return;
	205	}
	206
	207	/* ---------- SAS port events ---------- */
	208
c4028958	209	void sas_porte_bytes_dmaed(struct work_struct *work)
2908d778	210	{
c4028958 DH	211	struct asd_sas_event *ev =
	212	container_of(work, struct asd_sas_event, work);
	213	struct asd_sas_phy *phy = ev->phy;
2908d778	214
b15ebe0b	215	clear_bit(PORTE_BYTES_DMAED, &phy->port_events_pending);
2908d778 JB	216
	217	sas_form_port(phy);
	218	}
	219
c4028958	220	void sas_porte_broadcast_rcvd(struct work_struct *work)
2908d778	221	{
c4028958 DH	222	struct asd_sas_event *ev =
	223	container_of(work, struct asd_sas_event, work);
	224	struct asd_sas_phy *phy = ev->phy;
2908d778 JB	225	unsigned long flags;
2908d778 JB	226	u32 prim;
2908d778	227
b15ebe0b	228	clear_bit(PORTE_BROADCAST_RCVD, &phy->port_events_pending);
2908d778 JB	229
	230	spin_lock_irqsave(&phy->sas_prim_lock, flags);
	231	prim = phy->sas_prim;
	232	spin_unlock_irqrestore(&phy->sas_prim_lock, flags);
	233
	234	SAS_DPRINTK("broadcast received: %d\n", prim);
	235	sas_discover_event(phy->port, DISCE_REVALIDATE_DOMAIN);
	236	}
	237
c4028958	238	void sas_porte_link_reset_err(struct work_struct *work)
2908d778	239	{
c4028958 DH	240	struct asd_sas_event *ev =
	241	container_of(work, struct asd_sas_event, work);
	242	struct asd_sas_phy *phy = ev->phy;
2908d778	243
b15ebe0b	244	clear_bit(PORTE_LINK_RESET_ERR, &phy->port_events_pending);
2908d778	245
90f1e10d	246	sas_deform_port(phy, 1);
2908d778 JB	247	}
2908d778 JB	248
c4028958	249	void sas_porte_timer_event(struct work_struct *work)
2908d778	250	{
c4028958 DH	251	struct asd_sas_event *ev =
	252	container_of(work, struct asd_sas_event, work);
	253	struct asd_sas_phy *phy = ev->phy;
2908d778	254
b15ebe0b	255	clear_bit(PORTE_TIMER_EVENT, &phy->port_events_pending);
2908d778	256
90f1e10d	257	sas_deform_port(phy, 1);
2908d778 JB	258	}
2908d778 JB	259
c4028958	260	void sas_porte_hard_reset(struct work_struct *work)
2908d778	261	{
c4028958 DH	262	struct asd_sas_event *ev =
	263	container_of(work, struct asd_sas_event, work);
	264	struct asd_sas_phy *phy = ev->phy;
2908d778	265
b15ebe0b	266	clear_bit(PORTE_HARD_RESET, &phy->port_events_pending);
2908d778	267
90f1e10d	268	sas_deform_port(phy, 1);
2908d778 JB	269	}
	270
	271	/* ---------- SAS port registration ---------- */
	272
	273	static void sas_init_port(struct asd_sas_port *port,
	274	struct sas_ha_struct *sas_ha, int i)
	275	{
a29c0515	276	memset(port, 0, sizeof(*port));
2908d778 JB	277	port->id = i;
2908d778 JB	278	INIT_LIST_HEAD(&port->dev_list);
87c8331f DW	279	INIT_LIST_HEAD(&port->disco_list);
87c8331f DW	280	INIT_LIST_HEAD(&port->destroy_list);
2908d778 JB	281	spin_lock_init(&port->phy_list_lock);
2908d778 JB	282	INIT_LIST_HEAD(&port->phy_list);
2908d778 JB	283	port->ha = sas_ha;
	284
	285	spin_lock_init(&port->dev_list_lock);
	286	}
	287
	288	int sas_register_ports(struct sas_ha_struct *sas_ha)
	289	{
	290	int i;
	291
	292	/* initialize the ports and discovery */
	293	for (i = 0; i < sas_ha->num_phys; i++) {
	294	struct asd_sas_port *port = sas_ha->sas_port[i];
	295
	296	sas_init_port(port, sas_ha, i);
	297	sas_init_disc(&port->disc, port);
	298	}
	299	return 0;
	300	}
	301
	302	void sas_unregister_ports(struct sas_ha_struct *sas_ha)
	303	{
	304	int i;
	305
	306	for (i = 0; i < sas_ha->num_phys; i++)
	307	if (sas_ha->sas_phy[i]->port)
90f1e10d	308	sas_deform_port(sas_ha->sas_phy[i], 0);
2908d778 JB	309
2908d778 JB	310	}