Commit fc7212fd authored by Sreekanth Reddy's avatar Sreekanth Reddy Committed by Martin K. Petersen
Browse files

scsi: mpi3mr: Add framework to add phys to STL 

Add framework to register and unregister the host and expander phys with
SCSI Transport Layer (STL).

Link: https://lore.kernel.org/r/20220804131226.16653-6-sreekanth.reddy@broadcom.com


Reviewed-by: default avatarHimanshu Madhani <himanshu.madhani@oracle.com>
Signed-off-by: default avatarSreekanth Reddy <sreekanth.reddy@broadcom.com>
Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
parent 7188c03f

drivers/scsi/mpi3mr/Makefile

+1 −0
Original line number Diff line number Diff line
@@ -3,3 +3,4 @@ obj-m += mpi3mr.o 
mpi3mr-y +=  mpi3mr_os.o     \

		mpi3mr_fw.o \

		mpi3mr_app.o \

		mpi3mr_transport.o

drivers/scsi/mpi3mr/mpi3mr.h

+93 −0
Original line number Diff line number Diff line
@@ -39,6 +39,7 @@ 
#include <scsi/scsi_host.h>

#include <scsi/scsi_tcq.h>

#include <uapi/scsi/scsi_bsg_mpi3mr.h>

#include <scsi/scsi_transport_sas.h>



#include "mpi/mpi30_transport.h"

#include "mpi/mpi30_cnfg.h"
@@ -461,6 +462,98 @@ struct mpi3mr_throttle_group_info { 
	atomic_t pend_large_data_sz;

};



/* HBA port flags */

#define MPI3MR_HBA_PORT_FLAG_DIRTY	0x01



/**

 * struct mpi3mr_hba_port - HBA's port information

 * @port_id: Port number

 * @flags: HBA port flags

 */

struct mpi3mr_hba_port {

	struct list_head list;

	u8 port_id;

	u8 flags;

};



/**

 * struct mpi3mr_sas_port - Internal SAS port information

 * @port_list: List of ports belonging to a SAS node

 * @num_phys: Number of phys associated with port

 * @hba_port: HBA port entry

 * @remote_identify: Attached device identification

 * @rphy: SAS transport layer rphy object

 * @port: SAS transport layer port object

 * @phy_list: mpi3mr_sas_phy objects belonging to this port

 */

struct mpi3mr_sas_port {

	struct list_head port_list;

	u8 num_phys;

	struct mpi3mr_hba_port *hba_port;

	struct sas_identify remote_identify;

	struct sas_rphy *rphy;

	struct sas_port *port;

	struct list_head phy_list;

};



/**

 * struct mpi3mr_sas_phy - Internal SAS Phy information

 * @port_siblings: List of phys belonging to a port

 * @identify: Phy identification

 * @remote_identify: Attached device identification

 * @phy: SAS transport layer Phy object

 * @phy_id: Unique phy id within a port

 * @handle: Firmware device handle for this phy

 * @attached_handle: Firmware device handle for attached device

 * @phy_belongs_to_port: Flag to indicate phy belongs to port

   @hba_port: HBA port entry

 */

struct mpi3mr_sas_phy {

	struct list_head port_siblings;

	struct sas_identify identify;

	struct sas_identify remote_identify;

	struct sas_phy *phy;

	u8 phy_id;

	u16 handle;

	u16 attached_handle;

	u8 phy_belongs_to_port;

	struct mpi3mr_hba_port *hba_port;

};



/**

 * struct mpi3mr_sas_node - SAS host/expander information

 * @list: List of sas nodes in a controller

 * @parent_dev: Parent device class

 * @num_phys: Number phys belonging to sas_node

 * @sas_address: SAS address of sas_node

 * @handle: Firmware device handle for this sas_host/expander

 * @sas_address_parent: SAS address of parent expander or host

 * @enclosure_handle: Firmware handle of enclosure of this node

 * @device_info: Capabilities of this sas_host/expander

 * @non_responding: used to refresh the expander devices during reset

 * @host_node: Flag to indicate this is a host_node

 * @hba_port: HBA port entry

 * @phy: A list of phys that make up this sas_host/expander

 * @sas_port_list: List of internal ports of this node

 * @rphy: sas_rphy object of this expander node

 */

struct mpi3mr_sas_node {

	struct list_head list;

	struct device *parent_dev;

	u8 num_phys;

	u64 sas_address;

	u16 handle;

	u64 sas_address_parent;

	u16 enclosure_handle;

	u64 enclosure_logical_id;

	u8 non_responding;

	u8 host_node;

	struct mpi3mr_hba_port *hba_port;

	struct mpi3mr_sas_phy *phy;

	struct list_head sas_port_list;

	struct sas_rphy *rphy;

};



/**

 * struct mpi3mr_enclosure_node - enclosure information

 * @list: List of enclosures

drivers/scsi/mpi3mr/mpi3mr_transport.c

0 → 100644
+430 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-or-later

/*

 * Driver for Broadcom MPI3 Storage Controllers

 *

 * Copyright (C) 2017-2022 Broadcom Inc.

 *  (mailto: mpi3mr-linuxdrv.pdl@broadcom.com)

 *

 */



#include "mpi3mr.h"



/**

 * mpi3mr_convert_phy_link_rate -

 * @link_rate: link rate as defined in the MPI header

 *

 * Convert link_rate from mpi format into sas_transport layer

 * form.

 *

 * Return: A valid SAS transport layer defined link rate

 */

static enum sas_linkrate mpi3mr_convert_phy_link_rate(u8 link_rate)

{

	enum sas_linkrate rc;



	switch (link_rate) {

	case MPI3_SAS_NEG_LINK_RATE_1_5:

		rc = SAS_LINK_RATE_1_5_GBPS;

		break;

	case MPI3_SAS_NEG_LINK_RATE_3_0:

		rc = SAS_LINK_RATE_3_0_GBPS;

		break;

	case MPI3_SAS_NEG_LINK_RATE_6_0:

		rc = SAS_LINK_RATE_6_0_GBPS;

		break;

	case MPI3_SAS_NEG_LINK_RATE_12_0:

		rc = SAS_LINK_RATE_12_0_GBPS;

		break;

	case MPI3_SAS_NEG_LINK_RATE_22_5:

		rc = SAS_LINK_RATE_22_5_GBPS;

		break;

	case MPI3_SAS_NEG_LINK_RATE_PHY_DISABLED:

		rc = SAS_PHY_DISABLED;

		break;

	case MPI3_SAS_NEG_LINK_RATE_NEGOTIATION_FAILED:

		rc = SAS_LINK_RATE_FAILED;

		break;

	case MPI3_SAS_NEG_LINK_RATE_PORT_SELECTOR:

		rc = SAS_SATA_PORT_SELECTOR;

		break;

	case MPI3_SAS_NEG_LINK_RATE_SMP_RESET_IN_PROGRESS:

		rc = SAS_PHY_RESET_IN_PROGRESS;

		break;

	case MPI3_SAS_NEG_LINK_RATE_SATA_OOB_COMPLETE:

	case MPI3_SAS_NEG_LINK_RATE_UNKNOWN_LINK_RATE:

	default:

		rc = SAS_LINK_RATE_UNKNOWN;

		break;

	}

	return rc;

}



/**

 * mpi3mr_delete_sas_phy - Remove a single phy from port

 * @mrioc: Adapter instance reference

 * @mr_sas_port: Internal Port object

 * @mr_sas_phy: Internal Phy object

 *

 * Return: None.

 */

static void mpi3mr_delete_sas_phy(struct mpi3mr_ioc *mrioc,

	struct mpi3mr_sas_port *mr_sas_port,

	struct mpi3mr_sas_phy *mr_sas_phy)

{

	u64 sas_address = mr_sas_port->remote_identify.sas_address;



	dev_info(&mr_sas_phy->phy->dev,

	    "remove: sas_address(0x%016llx), phy(%d)\n",

	    (unsigned long long) sas_address, mr_sas_phy->phy_id);



	list_del(&mr_sas_phy->port_siblings);

	mr_sas_port->num_phys--;

	sas_port_delete_phy(mr_sas_port->port, mr_sas_phy->phy);

	mr_sas_phy->phy_belongs_to_port = 0;

}



/**

 * mpi3mr_add_sas_phy - Adding a single phy to a port

 * @mrioc: Adapter instance reference

 * @mr_sas_port: Internal Port object

 * @mr_sas_phy: Internal Phy object

 *

 * Return: None.

 */

static void mpi3mr_add_sas_phy(struct mpi3mr_ioc *mrioc,

	struct mpi3mr_sas_port *mr_sas_port,

	struct mpi3mr_sas_phy *mr_sas_phy)

{

	u64 sas_address = mr_sas_port->remote_identify.sas_address;



	dev_info(&mr_sas_phy->phy->dev,

	    "add: sas_address(0x%016llx), phy(%d)\n", (unsigned long long)

	    sas_address, mr_sas_phy->phy_id);



	list_add_tail(&mr_sas_phy->port_siblings, &mr_sas_port->phy_list);

	mr_sas_port->num_phys++;

	sas_port_add_phy(mr_sas_port->port, mr_sas_phy->phy);

	mr_sas_phy->phy_belongs_to_port = 1;

}



/**

 * mpi3mr_add_phy_to_an_existing_port - add phy to existing port

 * @mrioc: Adapter instance reference

 * @mr_sas_node: Internal sas node object (expander or host)

 * @mr_sas_phy: Internal Phy object *

 * @sas_address: SAS address of device/expander were phy needs

 *             to be added to

 * @hba_port: HBA port entry

 *

 * Return: None.

 */

static void mpi3mr_add_phy_to_an_existing_port(struct mpi3mr_ioc *mrioc,

	struct mpi3mr_sas_node *mr_sas_node, struct mpi3mr_sas_phy *mr_sas_phy,

	u64 sas_address, struct mpi3mr_hba_port *hba_port)

{

	struct mpi3mr_sas_port *mr_sas_port;

	struct mpi3mr_sas_phy *srch_phy;



	if (mr_sas_phy->phy_belongs_to_port == 1)

		return;



	if (!hba_port)

		return;



	list_for_each_entry(mr_sas_port, &mr_sas_node->sas_port_list,

	    port_list) {

		if (mr_sas_port->remote_identify.sas_address !=

		    sas_address)

			continue;

		if (mr_sas_port->hba_port != hba_port)

			continue;

		list_for_each_entry(srch_phy, &mr_sas_port->phy_list,

		    port_siblings) {

			if (srch_phy == mr_sas_phy)

				return;

		}

		mpi3mr_add_sas_phy(mrioc, mr_sas_port, mr_sas_phy);

		return;

	}

}



/**

 * mpi3mr_del_phy_from_an_existing_port - del phy from a port

 * @mrioc: Adapter instance reference

 * @mr_sas_node: Internal sas node object (expander or host)

 * @mr_sas_phy: Internal Phy object

 *

 * Return: None.

 */

static void mpi3mr_del_phy_from_an_existing_port(struct mpi3mr_ioc *mrioc,

	struct mpi3mr_sas_node *mr_sas_node, struct mpi3mr_sas_phy *mr_sas_phy)

{

	struct mpi3mr_sas_port *mr_sas_port, *next;

	struct mpi3mr_sas_phy *srch_phy;



	if (mr_sas_phy->phy_belongs_to_port == 0)

		return;



	list_for_each_entry_safe(mr_sas_port, next, &mr_sas_node->sas_port_list,

	    port_list) {

		list_for_each_entry(srch_phy, &mr_sas_port->phy_list,

		    port_siblings) {

			if (srch_phy != mr_sas_phy)

				continue;

			mpi3mr_delete_sas_phy(mrioc, mr_sas_port,

			    mr_sas_phy);

			return;

		}

	}

}



/**

 * mpi3mr_sas_port_sanity_check - sanity check while adding port

 * @mrioc: Adapter instance reference

 * @mr_sas_node: Internal sas node object (expander or host)

 * @sas_address: SAS address of device/expander

 * @hba_port: HBA port entry

 *

 * Verifies whether the Phys attached to a device with the given

 * SAS address already belongs to an existing sas port if so

 * will remove those phys from the sas port

 *

 * Return: None.

 */

static void mpi3mr_sas_port_sanity_check(struct mpi3mr_ioc *mrioc,

	struct mpi3mr_sas_node *mr_sas_node, u64 sas_address,

	struct mpi3mr_hba_port *hba_port)

{

	int i;



	for (i = 0; i < mr_sas_node->num_phys; i++) {

		if ((mr_sas_node->phy[i].remote_identify.sas_address !=

		    sas_address) || (mr_sas_node->phy[i].hba_port != hba_port))

			continue;

		if (mr_sas_node->phy[i].phy_belongs_to_port == 1)

			mpi3mr_del_phy_from_an_existing_port(mrioc,

			    mr_sas_node, &mr_sas_node->phy[i]);

	}

}



/**

 * mpi3mr_set_identify - set identify for phys and end devices

 * @mrioc: Adapter instance reference

 * @handle: Firmware device handle

 * @identify: SAS transport layer's identify info

 *

 * Populates sas identify info for a specific device.

 *

 * Return: 0 for success, non-zero for failure.

 */

static int mpi3mr_set_identify(struct mpi3mr_ioc *mrioc, u16 handle,

	struct sas_identify *identify)

{



	struct mpi3_device_page0 device_pg0;

	struct mpi3_device0_sas_sata_format *sasinf;

	u16 device_info;

	u16 ioc_status;



	if (mrioc->reset_in_progress) {

		ioc_err(mrioc, "%s: host reset in progress!\n", __func__);

		return -EFAULT;

	}



	if ((mpi3mr_cfg_get_dev_pg0(mrioc, &ioc_status, &device_pg0,

	    sizeof(device_pg0), MPI3_DEVICE_PGAD_FORM_HANDLE, handle))) {

		ioc_err(mrioc, "%s: device page0 read failed\n", __func__);

		return -ENXIO;

	}



	if (ioc_status != MPI3_IOCSTATUS_SUCCESS) {

		ioc_err(mrioc, "device page read failed for handle(0x%04x), with ioc_status(0x%04x) failure at %s:%d/%s()!\n",

		    handle, ioc_status, __FILE__, __LINE__, __func__);

		return -EIO;

	}



	memset(identify, 0, sizeof(struct sas_identify));

	sasinf = &device_pg0.device_specific.sas_sata_format;

	device_info = le16_to_cpu(sasinf->device_info);



	/* sas_address */

	identify->sas_address = le64_to_cpu(sasinf->sas_address);



	/* phy number of the parent device this device is linked to */

	identify->phy_identifier = sasinf->phy_num;



	/* device_type */

	switch (device_info & MPI3_SAS_DEVICE_INFO_DEVICE_TYPE_MASK) {

	case MPI3_SAS_DEVICE_INFO_DEVICE_TYPE_NO_DEVICE:

		identify->device_type = SAS_PHY_UNUSED;

		break;

	case MPI3_SAS_DEVICE_INFO_DEVICE_TYPE_END_DEVICE:

		identify->device_type = SAS_END_DEVICE;

		break;

	case MPI3_SAS_DEVICE_INFO_DEVICE_TYPE_EXPANDER:

		identify->device_type = SAS_EDGE_EXPANDER_DEVICE;

		break;

	}



	/* initiator_port_protocols */

	if (device_info & MPI3_SAS_DEVICE_INFO_SSP_INITIATOR)

		identify->initiator_port_protocols |= SAS_PROTOCOL_SSP;

	/* MPI3.0 doesn't have define for SATA INIT so setting both here*/

	if (device_info & MPI3_SAS_DEVICE_INFO_STP_INITIATOR)

		identify->initiator_port_protocols |= (SAS_PROTOCOL_STP |

		    SAS_PROTOCOL_SATA);

	if (device_info & MPI3_SAS_DEVICE_INFO_SMP_INITIATOR)

		identify->initiator_port_protocols |= SAS_PROTOCOL_SMP;



	/* target_port_protocols */

	if (device_info & MPI3_SAS_DEVICE_INFO_SSP_TARGET)

		identify->target_port_protocols |= SAS_PROTOCOL_SSP;

	/* MPI3.0 doesn't have define for STP Target so setting both here*/

	if (device_info & MPI3_SAS_DEVICE_INFO_STP_SATA_TARGET)

		identify->target_port_protocols |= (SAS_PROTOCOL_STP |

		    SAS_PROTOCOL_SATA);

	if (device_info & MPI3_SAS_DEVICE_INFO_SMP_TARGET)

		identify->target_port_protocols |= SAS_PROTOCOL_SMP;

	return 0;

}



/**

 * mpi3mr_add_host_phy - report sas_host phy to SAS transport

 * @mrioc: Adapter instance reference

 * @mr_sas_phy: Internal Phy object

 * @phy_pg0: SAS phy page 0

 * @parent_dev: Prent device class object

 *

 * Return: 0 for success, non-zero for failure.

 */

static int mpi3mr_add_host_phy(struct mpi3mr_ioc *mrioc,

	struct mpi3mr_sas_phy *mr_sas_phy, struct mpi3_sas_phy_page0 phy_pg0,

	struct device *parent_dev)

{

	struct sas_phy *phy;

	int phy_index = mr_sas_phy->phy_id;





	INIT_LIST_HEAD(&mr_sas_phy->port_siblings);

	phy = sas_phy_alloc(parent_dev, phy_index);

	if (!phy) {

		ioc_err(mrioc, "failure at %s:%d/%s()!\n",

		    __FILE__, __LINE__, __func__);

		return -1;

	}

	if ((mpi3mr_set_identify(mrioc, mr_sas_phy->handle,

	    &mr_sas_phy->identify))) {

		ioc_err(mrioc, "failure at %s:%d/%s()!\n",

		    __FILE__, __LINE__, __func__);

		sas_phy_free(phy);

		return -1;

	}

	phy->identify = mr_sas_phy->identify;

	mr_sas_phy->attached_handle = le16_to_cpu(phy_pg0.attached_dev_handle);

	if (mr_sas_phy->attached_handle)

		mpi3mr_set_identify(mrioc, mr_sas_phy->attached_handle,

		    &mr_sas_phy->remote_identify);

	phy->identify.phy_identifier = mr_sas_phy->phy_id;

	phy->negotiated_linkrate = mpi3mr_convert_phy_link_rate(

	    (phy_pg0.negotiated_link_rate &

	    MPI3_SAS_NEG_LINK_RATE_LOGICAL_MASK) >>

	    MPI3_SAS_NEG_LINK_RATE_LOGICAL_SHIFT);

	phy->minimum_linkrate_hw = mpi3mr_convert_phy_link_rate(

	    phy_pg0.hw_link_rate & MPI3_SAS_HWRATE_MIN_RATE_MASK);

	phy->maximum_linkrate_hw = mpi3mr_convert_phy_link_rate(

	    phy_pg0.hw_link_rate >> 4);

	phy->minimum_linkrate = mpi3mr_convert_phy_link_rate(

	    phy_pg0.programmed_link_rate & MPI3_SAS_PRATE_MIN_RATE_MASK);

	phy->maximum_linkrate = mpi3mr_convert_phy_link_rate(

	    phy_pg0.programmed_link_rate >> 4);

	phy->hostdata = mr_sas_phy->hba_port;



	if ((sas_phy_add(phy))) {

		ioc_err(mrioc, "failure at %s:%d/%s()!\n",

		    __FILE__, __LINE__, __func__);

		sas_phy_free(phy);

		return -1;

	}

	if ((mrioc->logging_level & MPI3_DEBUG_TRANSPORT_INFO))

		dev_info(&phy->dev,

		    "add: handle(0x%04x), sas_address(0x%016llx)\n"

		    "\tattached_handle(0x%04x), sas_address(0x%016llx)\n",

		    mr_sas_phy->handle, (unsigned long long)

		    mr_sas_phy->identify.sas_address,

		    mr_sas_phy->attached_handle,

		    (unsigned long long)

		    mr_sas_phy->remote_identify.sas_address);

	mr_sas_phy->phy = phy;

	return 0;

}



/**

 * mpi3mr_add_expander_phy - report expander phy to transport

 * @mrioc: Adapter instance reference

 * @mr_sas_phy: Internal Phy object

 * @expander_pg1: SAS Expander page 1

 * @parent_dev: Parent device class object

 *

 * Return: 0 for success, non-zero for failure.

 */

static int mpi3mr_add_expander_phy(struct mpi3mr_ioc *mrioc,

	struct mpi3mr_sas_phy *mr_sas_phy,

	struct mpi3_sas_expander_page1 expander_pg1,

	struct device *parent_dev)

{

	struct sas_phy *phy;

	int phy_index = mr_sas_phy->phy_id;



	INIT_LIST_HEAD(&mr_sas_phy->port_siblings);

	phy = sas_phy_alloc(parent_dev, phy_index);

	if (!phy) {

		ioc_err(mrioc, "failure at %s:%d/%s()!\n",

		    __FILE__, __LINE__, __func__);

		return -1;

	}

	if ((mpi3mr_set_identify(mrioc, mr_sas_phy->handle,

	    &mr_sas_phy->identify))) {

		ioc_err(mrioc, "failure at %s:%d/%s()!\n",

		    __FILE__, __LINE__, __func__);

		sas_phy_free(phy);

		return -1;

	}

	phy->identify = mr_sas_phy->identify;

	mr_sas_phy->attached_handle =

	    le16_to_cpu(expander_pg1.attached_dev_handle);

	if (mr_sas_phy->attached_handle)

		mpi3mr_set_identify(mrioc, mr_sas_phy->attached_handle,

		    &mr_sas_phy->remote_identify);

	phy->identify.phy_identifier = mr_sas_phy->phy_id;

	phy->negotiated_linkrate = mpi3mr_convert_phy_link_rate(

	    (expander_pg1.negotiated_link_rate &

	    MPI3_SAS_NEG_LINK_RATE_LOGICAL_MASK) >>

	    MPI3_SAS_NEG_LINK_RATE_LOGICAL_SHIFT);

	phy->minimum_linkrate_hw = mpi3mr_convert_phy_link_rate(

	    expander_pg1.hw_link_rate & MPI3_SAS_HWRATE_MIN_RATE_MASK);

	phy->maximum_linkrate_hw = mpi3mr_convert_phy_link_rate(

	    expander_pg1.hw_link_rate >> 4);

	phy->minimum_linkrate = mpi3mr_convert_phy_link_rate(

	    expander_pg1.programmed_link_rate & MPI3_SAS_PRATE_MIN_RATE_MASK);

	phy->maximum_linkrate = mpi3mr_convert_phy_link_rate(

	    expander_pg1.programmed_link_rate >> 4);

	phy->hostdata = mr_sas_phy->hba_port;



	if ((sas_phy_add(phy))) {

		ioc_err(mrioc, "failure at %s:%d/%s()!\n",

		    __FILE__, __LINE__, __func__);

		sas_phy_free(phy);

		return -1;

	}

	if ((mrioc->logging_level & MPI3_DEBUG_TRANSPORT_INFO))

		dev_info(&phy->dev,

		    "add: handle(0x%04x), sas_address(0x%016llx)\n"

		    "\tattached_handle(0x%04x), sas_address(0x%016llx)\n",

		    mr_sas_phy->handle, (unsigned long long)

		    mr_sas_phy->identify.sas_address,

		    mr_sas_phy->attached_handle,

		    (unsigned long long)

		    mr_sas_phy->remote_identify.sas_address);

	mr_sas_phy->phy = phy;

	return 0;

}