root/usr/src/lib/sun_sas/common/Sun_sasGetDiscoveredPortAttributes.c
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */
/*
 * Copyright 2019 Joyent, Inc.
 */

#include    <sun_sas.h>

/*
 * Retrieves the attributes for a specified port discovered in the network
 */
HBA_STATUS
Sun_sasGetDiscoveredPortAttributes(HBA_HANDLE handle,
    HBA_UINT32 port, HBA_UINT32 discoveredport,
    SMHBA_PORTATTRIBUTES *attributes)
{
        const char              ROUTINE[] =
            "Sun_sasGetDiscoveredPortAttributes";
        HBA_STATUS              status;
        HBA_STATUS              ret = HBA_STATUS_OK;
        struct sun_sas_hba      *hba_ptr;
        struct sun_sas_port     *hba_port_ptr, *hba_disco_port;
        int                     index;

        if (attributes == NULL) {
                log(LOG_DEBUG, ROUTINE,
                    "NULL attributes argument. Handle %08lx, port %d, "
                    "discovered port %d", handle, port, discoveredport);
                return (HBA_STATUS_ERROR_ARG);
        }

        lock(&all_hbas_lock);
        index = RetrieveIndex(handle);
        lock(&open_handles_lock);
        hba_ptr = RetrieveHandle(index);
        if (hba_ptr == NULL) {
                log(LOG_DEBUG, ROUTINE, "Invalid handle %08lx.", handle);
                unlock(&open_handles_lock);
                unlock(&all_hbas_lock);
                return (HBA_STATUS_ERROR_INVALID_HANDLE);
        }

        /* Check for stale data */
        status = verifyAdapter(hba_ptr);
        if (status != HBA_STATUS_OK) {
                log(LOG_DEBUG, ROUTINE, "Verify Adapter failed");
                unlock(&open_handles_lock);
                unlock(&all_hbas_lock);
                return (status);
        }


        if (hba_ptr->first_port == NULL) {
                /* This is probably an internal failure of the library */
                if (hba_ptr->device_path[0] != '\0') {
                        log(LOG_DEBUG, ROUTINE, "Internal failure:  Adapter %s"
                            " contains no port data", hba_ptr->device_path);
                } else {
                        log(LOG_DEBUG, ROUTINE, "Internal failure:  Adapter at"
                            " index %d contains no port data", hba_ptr->index);
                }
                unlock(&open_handles_lock);
                unlock(&all_hbas_lock);
                return (HBA_STATUS_ERROR);
        }

        for (hba_port_ptr = hba_ptr->first_port;
            hba_port_ptr != NULL; hba_port_ptr = hba_port_ptr->next) {
                if (hba_port_ptr->index == port) {
                        break;
                }
        }

        if (hba_port_ptr == NULL) {
                log(LOG_DEBUG, ROUTINE,
                    "Invalid port index %d for handle %08lx",
                    port, handle);
                unlock(&open_handles_lock);
                unlock(&all_hbas_lock);
                return (HBA_STATUS_ERROR_ILLEGAL_INDEX);
        }

        /* check to make sure there are devices attached to this port */
        if (hba_port_ptr->first_attached_port != NULL) {
                for (hba_disco_port = hba_port_ptr->first_attached_port;
                    hba_disco_port != NULL;
                    hba_disco_port = hba_disco_port->next) {
                        if (hba_disco_port->index == discoveredport) {
                                break;
                        }
                }
                if (hba_disco_port == NULL) {
                        log(LOG_DEBUG, ROUTINE,
                            "Invalid discovered port index %d for hba port "
                            "index %d on handle %08lx.",
                            discoveredport, port, handle);
                        ret = HBA_STATUS_ERROR_ILLEGAL_INDEX;
                } else {
                        attributes->PortType =
                            hba_disco_port->port_attributes.PortType;
                        attributes->PortState =
                            hba_disco_port->port_attributes.PortState;
                        (void) strlcpy(attributes->OSDeviceName,
                            hba_disco_port->port_attributes.OSDeviceName,
                            sizeof (attributes->OSDeviceName));
                        (void) memcpy(attributes->PortSpecificAttribute.SASPort,
                            hba_disco_port->port_attributes.\
                            PortSpecificAttribute.SASPort,
                            sizeof (struct SMHBA_SAS_Port));
                }
        } else {
                /* No ports, so we can't possibly return anything */
                log(LOG_DEBUG, ROUTINE,
                    "No discovered port on HBA port index %d for handle %08lx",
                    port, handle);
                ret = HBA_STATUS_ERROR;
        }
        unlock(&open_handles_lock);
        unlock(&all_hbas_lock);

        return (ret);
}