4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * CDDL HEADER START
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * The contents of this file are subject to the terms of the
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Common Development and Distribution License (the "License").
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * You may not use this file except in compliance with the License.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * or http://www.opensolaris.org/os/licensing.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * See the License for the specific language governing permissions
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * and limitations under the License.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * When distributing Covered Code, include this CDDL HEADER in each
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * If applicable, add the following below this CDDL HEADER, with the
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * fields enclosed by brackets "[]" replaced with your own identifying
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * information: Portions Copyright [yyyy] [name of copyright owner]
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * CDDL HEADER END
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister */
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister/*
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister * Copyright (c) 2009, 2010, Oracle and/or its affiliates. All rights reserved.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#ifndef _PMCS_DEF_H
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define _PMCS_DEF_H
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#ifdef __cplusplus
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhextern "C" {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#endif
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef enum {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh NOTHING, /* nothing connected here */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh SATA, /* SATA connection */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh SAS, /* direct or indirect SAS connection */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh EXPANDER, /* connection to an expander */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh NEW /* Brand new device (pending state) */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh} pmcs_dtype_t;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * This structure defines a PHY device that represents what we
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * are connected to.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * The eight real physical PHYs that are in the PMC8X6G are represented
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * as an array of eight of these structures which define what these
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * real PHYs are connected to.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Depending upon what is actually connected to each PHY, the
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * type set will define what we're connected to. If it is
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * a direct SATA connection, the phy will describe a SATA endpoint
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * If it is a direct SAS connection, it will describe a SAS
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * endpoint.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * If it is an EXPANDER, this will describe the edge of an expander.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * As we perform discovery on what is in an EXPANDER we define an
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * additional list of phys that represent what the Expander is connected to.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_HW_MIN_LINK_RATE SAS_LINK_RATE_1_5GBIT
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_HW_MAX_LINK_RATE SAS_LINK_RATE_6GBIT
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
601c90f161ff0319c1b4a2c3362b466043a65d8dSrikanth, Ramana#define PMCS_INVALID_DEVICE_ID 0xffffffff
65e70c04884b95e29d10e9933a3d55f0ec5af3beDavid Hollister#define PMCS_DEVICE_ID_MASK 0xffff
601c90f161ff0319c1b4a2c3362b466043a65d8dSrikanth, Ramana#define PMCS_PHY_INVALID_PORT_ID 0xf
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister#define PMCS_PM_MAX_NAMELEN 16
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister#define PMCS_MAX_REENUMERATE 2 /* Maximum re-enumeration attempts */
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister/*
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister * Number of usecs to wait after last noted activate/deactivate callback
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister * before possibly restarting discovery
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister */
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister#define PMCS_REDISCOVERY_DELAY (5 * MICROSEC)
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhstruct pmcs_phy {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_phy_t *sibling; /* sibling phy */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_phy_t *parent; /* parent phy */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_phy_t *children; /* head of list of children */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_phy_t *dead_next; /* dead PHY list link */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh list_node_t list_node; /* list element */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t device_id; /* PMC8X6G device handle */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ncphy : 8, /* # of contained phys for expander */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh hw_event_ack : 24; /* XXX: first level phy event acked */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t phynum; /* phy number on parent expander */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t width; /* how many phys wide */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t ds_recovery_retries; /* # error retry attempts */
af68568220d139fee6e01579437e660dbfee20a8Srikanth, Ramana uint8_t ds_prev_good_recoveries; /* # successful recoveries */
af68568220d139fee6e01579437e660dbfee20a8Srikanth, Ramana clock_t prev_recovery; /* previous successful recovery */
af68568220d139fee6e01579437e660dbfee20a8Srikanth, Ramana clock_t last_good_recovery; /* oldest successful recovery */
af68568220d139fee6e01579437e660dbfee20a8Srikanth, Ramana /* within PMCS_MAX_DS_RECOVERY_TIME time frame */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_dtype_t dtype; /* current dtype of the phy */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_dtype_t pend_dtype; /* new dtype (pending change) */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh level : 8, /* level in expander tree */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh tolerates_sas2 : 1, /* tolerates SAS2 SMP */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh spinup_hold : 1, /* spinup hold needs releasing */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh atdt : 3, /* attached device type */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh portid : 4, /* PMC8X6G port context */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh link_rate : 4, /* current supported speeds */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh valid_device_id : 1, /* device id is valid */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh abort_sent : 1, /* we've sent an abort */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh abort_pending : 1, /* we have an abort pending */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh need_rl_ext : 1, /* need SATA RL_EXT recocvery */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh subsidiary : 1, /* this is part of a wide phy */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh configured : 1, /* is configured */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh dead : 1, /* dead */
601c90f161ff0319c1b4a2c3362b466043a65d8dSrikanth, Ramana changed : 1, /* this phy is changing */
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister reenumerate : 1, /* attempt re-enumeration */
c80dec56debdecfa03d9c0c18755df818e408772David Hollister virtual : 1, /* This is a virtual PHY */
601c90f161ff0319c1b4a2c3362b466043a65d8dSrikanth, Ramana deregister_wait : 1; /* phy waiting to get deregistered */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh clock_t config_stop; /* When config attempts will stop */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh hrtime_t abort_all_start;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh kcondvar_t abort_all_cv; /* Wait for ABORT_ALL completion */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh kmutex_t phy_lock;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh volatile uint32_t ref_count; /* Targets & work on this PHY */
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister uint32_t enum_attempts; /* # of enumeration attempts */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t sas_address[8]; /* SAS address for this PHY */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh struct {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh prog_min_rate :4,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh hw_min_rate :4,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh prog_max_rate :4,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh hw_max_rate :4,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh reserved :16;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh } state;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh char path[32]; /* path name for this phy */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_hw_t *pwp; /* back ptr to hba struct */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_iport_t *iport; /* back ptr to the iport handle */
73a3eccd27d9673a6407274ea0de350699562fd9David Hollister pmcs_iport_t *last_iport; /* last iport this PHY was on */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_xscsi_t *target; /* back ptr to current target */
188eaed9d5f14c73dfba1cd0dabaa430bdfd4a9aSrikanth Suravajhala pmcs_xscsi_t **target_addr; /* address of real target pointer */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh kstat_t *phy_stats; /* kstats for this phy */
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister /*
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister * Attached port phy mask and target port phymask. With 16 bytes
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister * we can represent a phymask for anything with up to 64 ports
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister */
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister uint64_t att_port_pm; /* att port pm for this PHY */
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister uint64_t att_port_pm_tmp; /* Temp area for wide-ports */
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister char att_port_pm_str[PMCS_PM_MAX_NAMELEN + 1];
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister uint64_t tgt_port_pm; /* tgt port pm for this PHY */
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister uint64_t tgt_port_pm_tmp; /* Temp area for wide-ports */
499cfd156ad653fc27397c5f021047c091dd12c5David Hollister char tgt_port_pm_str[PMCS_PM_MAX_NAMELEN + 1];
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister smp_routing_attr_t routing_attr; /* Routing attr. from discover resp. */
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister smp_routing_attr_t routing_method; /* Actual routing method used. */
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister smp_report_general_resp_t rg_resp; /* Response to REPORT_GENERAL */
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister smp_discover_resp_t disc_resp; /* Response to DISCOVER */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh};
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/* maximum number of ds recovery retries (ds_recovery_retries) */
601c90f161ff0319c1b4a2c3362b466043a65d8dSrikanth, Ramana#define PMCS_MAX_DS_RECOVERY_RETRIES 10
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
af68568220d139fee6e01579437e660dbfee20a8Srikanth, Ramana/* max time allowed for successful recovery */
af68568220d139fee6e01579437e660dbfee20a8Srikanth, Ramana#define PMCS_MAX_DS_RECOVERY_TIME (60 * 1000000) /* 60 seconds */
af68568220d139fee6e01579437e660dbfee20a8Srikanth, Ramana
af68568220d139fee6e01579437e660dbfee20a8Srikanth, Ramana/* ds recovery on same same phy is not allowed within this interval */
af68568220d139fee6e01579437e660dbfee20a8Srikanth, Ramana#define PMCS_DS_RECOVERY_INTERVAL (1000000) /* 1 second */
af68568220d139fee6e01579437e660dbfee20a8Srikanth, Ramana
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Inbound and Outbound Queue Related Definitions.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * The PMC8X6G has a programmable number of inbound and outbound circular
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * queues for use in message passing between the host and the PMC8X6G
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * (up to 64 queues for the Rev C Chip). This driver does not use all
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * possible queues.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Each Queue is given 4K of consistent memory and we set a 64 byte size for
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * the queue entry size (this gives us 256 queue entries per queue).
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * This allocation then continues up a further PMCS_SCRATCH_SIZE bytes
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * that the driver uses as a temporary scratch area for things like
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * SMP discovery.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * This control area looks like this:
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Offset What
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * ------------------------------------------------
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 0 IQ 0 Consumer Index
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 4 IQ 1 Consumer Index
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 8..255 ...
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 252..255 IQ 63 Consumer Index
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 256 OQ 0 Producer Index
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 260 OQ 1 Producer Index
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 264..259 ....
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 508..511 OQ 63 Producer Index
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 512..512+PMCS_SCRATCH_SIZE-1 Scratch area.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define IQCI_BASE_OFFSET 0
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define IQ_OFFSET(qnum) (IQCI_BASE_OFFSET + (qnum << 2))
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define OQPI_BASE_OFFSET 256
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define OQ_OFFSET(qnum) (OQPI_BASE_OFFSET + (qnum << 2))
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Work related structures. Each one of these structures is paired
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * with *any* command that is fed to the PMC8X6G via one of the
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Inbound Queues. The work structure has a tag to compare with
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * the message that comes back out of an Outbound Queue. The
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * work structure also points to the phy which this command is
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * tied to. It also has a pointer a callback function (if defined).
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * See that TAG Architecture below for the various kinds of
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * dispositions of a work structure.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Work Structure States
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * NIL -> READY
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * READY -> NIL
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * READY -> ONCHIP
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * ONCHIP -> INTR
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * INTR -> READY
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * INTR -> NIL
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * INTR -> ABORTED
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * INTR -> TIMED_OUT
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * ABORTED -> NIL
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * TIMED_OUT -> NIL
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef enum {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh PMCS_WORK_STATE_NIL = 0,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh PMCS_WORK_STATE_READY,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh PMCS_WORK_STATE_ONCHIP,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh PMCS_WORK_STATE_INTR,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh PMCS_WORK_STATE_IOCOMPQ,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh PMCS_WORK_STATE_ABORTED,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh PMCS_WORK_STATE_TIMED_OUT
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh} pmcs_work_state_t;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhstruct pmcwork {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh STAILQ_ENTRY(pmcwork) next;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh kmutex_t lock;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh kcondvar_t sleep_cv;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh void *ptr; /* linkage or callback function */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh void *arg; /* command specific data */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_phy_t *phy; /* phy who owns this command */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_xscsi_t *xp; /* Back pointer to xscsi struct */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh volatile uint32_t htag; /* tag for this structure */
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh uint32_t abt_htag; /* Tag of command to be aborted */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh timer : 27,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh onwire : 1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh dead : 1,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh state : 3;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh hrtime_t start; /* timestamp start */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t ssp_event; /* ssp event */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_dtype_t dtype; /* stash, incase phy gets cleared */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh void *last_ptr;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh void *last_arg;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_phy_t *last_phy;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_xscsi_t *last_xp;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t last_htag;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_work_state_t last_state;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh hrtime_t finish;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh};
39cd77a06f56f308333bd7b2d8aae1b1467be113Jesse Butler#define PMCS_ABT_HTAG_ALL 0xffffffff
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_REC_EVENT 0xffffffff /* event recovery */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * This structure defines a PMC-Sierra defined firmware header.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#pragma pack(4)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef struct {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh char vendor_id[8];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t product_id;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t hwrev;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t destination_partition;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t reserved0;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t fwrev[4];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t firmware_length;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t crc;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t start_address;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint8_t data[];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh} pmcs_fw_hdr_t;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#pragma pack()
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Offlevel work as a bit pattern.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_DISCOVER 0
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_ABORT_HANDLE 3
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_SPINUP_RELEASE 4
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_SAS_HW_ACK 5
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_SATA_RUN 6
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_RUN_QUEUES 7
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_ADD_DMA_CHUNKS 8
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_DS_ERR_RECOVERY 9
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_SSP_EVT_RECOVERY 10
601c90f161ff0319c1b4a2c3362b466043a65d8dSrikanth, Ramana#define PMCS_WORK_DEREGISTER_DEV 11
c280a92b706bf16eee2a24cc328c9b78d71cb38cDavid Hollister#define PMCS_WORK_DUMP_REGS 12
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * The actual values as they appear in work_flags
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_FLAG_DISCOVER (1 << 0)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_FLAG_ABORT_HANDLE (1 << 3)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_FLAG_SPINUP_RELEASE (1 << 4)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_FLAG_SAS_HW_ACK (1 << 5)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_FLAG_SATA_RUN (1 << 6)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_FLAG_RUN_QUEUES (1 << 7)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_FLAG_ADD_DMA_CHUNKS (1 << 8)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_FLAG_DS_ERR_RECOVERY (1 << 9)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_WORK_FLAG_SSP_EVT_RECOVERY (1 << 10)
601c90f161ff0319c1b4a2c3362b466043a65d8dSrikanth, Ramana#define PMCS_WORK_FLAG_DEREGISTER_DEV (1 << 11)
c280a92b706bf16eee2a24cc328c9b78d71cb38cDavid Hollister#define PMCS_WORK_FLAG_DUMP_REGS (1 << 12)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * This structure is used by this function to test MPI (and interrupts)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * after MPI has been started to make sure it's working reliably.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef struct {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t signature;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t count;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t *ptr;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh} echo_test_t;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define ECHO_SIGNATURE 0xbebebeef
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Tag Architecture. The PMC has 32 bit tags for MPI messages.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * We use this tag this way.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * bits what
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * ------------------------
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 31 done bit
978d7443a924cda8208d6a10e72be89383bc7becSrikanth Suravajhala * 30 non-io cmd bit
978d7443a924cda8208d6a10e72be89383bc7becSrikanth Suravajhala * 29..28 tag type
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 27..12 rolling serial number
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * 11..0 index into work area to get pmcwork structure
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * A tag type of NONE means that nobody is waiting on any results,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * so the interrupt code frees the work structure that has this
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * tag.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * A tag type of CBACK means that the the interrupt handler
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * takes the tag 'arg' in the work structure to be a callback
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * function pointer (see pmcs_cb_t). The callee is responsible
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * for freeing the work structure that has this tag.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh *
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * A tag type of WAIT means that the issuer of the work needs
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * be woken up from interrupt level when the command completes
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * (or times out). If work structure tag 'arg' is non-null,
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * up to 2*PMCS_QENTRY_SIZE bits of data from the Outbound Queue
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * entry may be copied to the area pointed to by 'arg'. This
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * allows issuers to get directly at the results of the command
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * they issed. The synchronization point for the issuer and the
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * interrupt code for command done notification is the setting
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * of the 'DONE' bit in the tag as stored in the work structure.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_TYPE_FREE 0
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_TYPE_NONE 1
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_TYPE_CBACK 2
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_TYPE_WAIT 3
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_TYPE_SHIFT 28
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_SERNO_SHIFT 12
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_INDEX_SHIFT 0
978d7443a924cda8208d6a10e72be89383bc7becSrikanth Suravajhala#define PMCS_TAG_TYPE_MASK 0x30000000
978d7443a924cda8208d6a10e72be89383bc7becSrikanth Suravajhala#define PMCS_TAG_NONIO_CMD 0x40000000
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_DONE 0x80000000
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_SERNO_MASK 0x0ffff000
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_INDEX_MASK 0x00000fff
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_TYPE(x) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (((x) & PMCS_TAG_TYPE_MASK) >> PMCS_TAG_TYPE_SHIFT)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_SERNO(x) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (((x) & PMCS_TAG_SERNO_MASK) >> PMCS_TAG_SERNO_SHIFT)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_INDEX(x) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (((x) & PMCS_TAG_INDEX_MASK) >> PMCS_TAG_INDEX_SHIFT)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TAG_FREE 0
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_COMMAND_DONE(x) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (((x)->htag == PMCS_TAG_FREE) || (((x)->htag & PMCS_TAG_DONE) != 0))
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_COMMAND_ACTIVE(x) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ((x)->htag != PMCS_TAG_FREE && (x)->state == PMCS_WORK_STATE_ONCHIP)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Miscellaneous Definitions
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define CLEAN_MESSAGE(m, x) { \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh int _j = x; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh while (_j < PMCS_MSG_SIZE) { \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh m[_j++] = 0; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh } \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh}
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define COPY_MESSAGE(t, f, a) { \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh int _j; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh for (_j = 0; _j < a; _j++) { \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh t[_j] = f[_j]; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh } \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh while (_j < PMCS_MSG_SIZE) { \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh t[_j++] = 0; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh } \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh}
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_PHY_ADDRESSABLE(pp) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ((pp)->level == 0 && (pp)->dtype == SATA && \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ((pp)->sas_address[0] >> 4) != 5)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define RESTART_DISCOVERY(pwp) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ASSERT(!mutex_owned(&pwp->config_lock)); \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh mutex_enter(&pwp->config_lock); \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pwp->config_changed = B_TRUE; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh mutex_exit(&pwp->config_lock); \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh SCHEDULE_WORK(pwp, PMCS_WORK_DISCOVER);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define RESTART_DISCOVERY_LOCKED(pwp) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ASSERT(mutex_owned(&pwp->config_lock)); \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pwp->config_changed = B_TRUE; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh SCHEDULE_WORK(pwp, PMCS_WORK_DISCOVER);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PHY_CHANGED(pwp, p) \
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh pmcs_prt(pwp, PMCS_PRT_DEBUG_CONFIG, p, NULL, "%s changed in " \
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh "%s line %d", p->path, __func__, __LINE__); \
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister p->changed = 1; \
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister p->enum_attempts = 0
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PHY_CHANGED_AT_LOCATION(pwp, p, func, line) \
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh pmcs_prt(pwp, PMCS_PRT_DEBUG_CONFIG, p, NULL, "%s changed in " \
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh "%s line %d", p->path, func, line); \
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister p->changed = 1; \
9aed162131f1840d0bc1cd0275f4d7144f3690f0David Hollister p->enum_attempts = 0
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PHY_TYPE(pptr) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (((pptr)->dtype == NOTHING)? "NOTHING" : \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (((pptr)->dtype == SATA)? "SATA" : \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (((pptr)->dtype == SAS)? "SAS" : "EXPANDER")))
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define IS_ROOT_PHY(pptr) (pptr->parent == NULL)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_HIPRI(pwp, oq, c) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (pwp->hipri_queue & (1 << PMCS_IQ_OTHER)) ? \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (PMCS_IOMB_HIPRI | PMCS_IOMB_IN_SAS(oq, c)) : \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (PMCS_IOMB_IN_SAS(oq, c))
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SCHEDULE_WORK(hwp, wrk) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (void) atomic_set_long_excl(&hwp->work_flags, wrk)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Check to see if the requested work bit is set. Either way, the bit will
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * be cleared upon return.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define WORK_SCHEDULED(hwp, wrk) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (atomic_clear_long_excl(&hwp->work_flags, wrk) == 0)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Check to see if the requested work bit is set. The value will not be
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * changed in this case. The atomic_xx_nv operations can be quite expensive
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * so this should not be used in non-DEBUG code.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define WORK_IS_SCHEDULED(hwp, wrk) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ((atomic_and_ulong_nv(&hwp->work_flags, (ulong_t)-1) & (1 << wrk)) != 0)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define WAIT_FOR(p, t, r) \
32b54db7d7ecdb10cc3178edf2c480c6dc5c5559Jesse Butler clock_t _lb = ddi_get_lbolt(); \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh r = 0; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh while (!PMCS_COMMAND_DONE(p)) { \
32b54db7d7ecdb10cc3178edf2c480c6dc5c5559Jesse Butler clock_t _ret = cv_timedwait(&p->sleep_cv, \
32b54db7d7ecdb10cc3178edf2c480c6dc5c5559Jesse Butler &p->lock, _lb + drv_usectohz(t * 1000)); \
32b54db7d7ecdb10cc3178edf2c480c6dc5c5559Jesse Butler if (!PMCS_COMMAND_DONE(p) && _ret < 0) { \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh r = 1; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh break; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh } \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh }
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Signal the next I/O completion thread to start running.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_CQ_RUN_LOCKED(hwp) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh if (!STAILQ_EMPTY(&hwp->cq) || hwp->iocomp_cb_head) { \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh pmcs_cq_thr_info_t *cqti; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh cqti = &hwp->cq_info.cq_thr_info \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh [hwp->cq_info.cq_next_disp_thr]; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh hwp->cq_info.cq_next_disp_thr++; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh if (hwp->cq_info.cq_next_disp_thr == \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh hwp->cq_info.cq_threads) { \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh hwp->cq_info.cq_next_disp_thr = 0; \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh } \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh mutex_enter(&cqti->cq_thr_lock); \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh cv_signal(&cqti->cq_cv); \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh mutex_exit(&cqti->cq_thr_lock); \
8f514e743bde41fe7e0ca48510a6d4c40ca51c23David Hollister }
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_CQ_RUN(hwp) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh mutex_enter(&hwp->cq_lock); \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh PMCS_CQ_RUN_LOCKED(hwp); \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh mutex_exit(&hwp->cq_lock);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Watchdog/SCSA timer definitions
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/* usecs to SCSA watchdog ticks */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define US2WT(x) (x)/10
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * More misc
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define BYTE0(x) (((x) >> 0) & 0xff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define BYTE1(x) (((x) >> 8) & 0xff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define BYTE2(x) (((x) >> 16) & 0xff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define BYTE3(x) (((x) >> 24) & 0xff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define BYTE4(x) (((x) >> 32) & 0xff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define BYTE5(x) (((x) >> 40) & 0xff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define BYTE6(x) (((x) >> 48) & 0xff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define BYTE7(x) (((x) >> 56) & 0xff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define WORD0(x) (((x) >> 0) & 0xffff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define WORD1(x) (((x) >> 16) & 0xffff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define WORD2(x) (((x) >> 32) & 0xffff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define WORD3(x) (((x) >> 48) & 0xffff)
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define DWORD0(x) ((uint32_t)(x))
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define DWORD1(x) ((uint32_t)(((uint64_t)x) >> 32))
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_ADDR_FMT "0x%02x%02x%02x%02x%02x%02x%02x%02x"
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define SAS_ADDR_PRT(x) x[0], x[1], x[2], x[3], x[4], x[5], x[6], x[7]
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_VALID_LINK_RATE(r) \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ((r == SAS_LINK_RATE_1_5GBIT) || (r == SAS_LINK_RATE_3GBIT) || \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh (r == SAS_LINK_RATE_6GBIT))
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * This is here to avoid inclusion of <sys/ctype.h> which is not lint clean.
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define HEXDIGIT(x) (((x) >= '0' && (x) <= '9') || \
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh ((x) >= 'a' && (x) <= 'f') || ((x) >= 'A' && (x) <= 'F'))
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister#define NSECS_PER_SEC 1000000000UL
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef void (*pmcs_cb_t) (pmcs_hw_t *, pmcwork_t *, uint32_t *);
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Defines and structure used for tracing/logging information
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TBUF_ELEM_SIZE 120
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#define PMCS_TBUF_NUM_ELEMS_DEF 100000
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh#define PMCS_TBUF_UA_MAX_SIZE 32
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef struct {
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh /* Target-specific data */
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh uint16_t target_num;
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh char target_ua[PMCS_TBUF_UA_MAX_SIZE];
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh /* PHY-specific data */
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh uint8_t phy_sas_address[8];
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh char phy_path[32];
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh pmcs_dtype_t phy_dtype;
c3bc407cfbd238a18e4728ad5f36f39cecdb062fdh /* Log data */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh timespec_t timestamp;
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister uint64_t fw_timestamp;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh char buf[PMCS_TBUF_ELEM_SIZE];
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh} pmcs_tbuf_t;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh/*
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh * Firmware event log header format
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh */
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dhtypedef struct pmcs_fw_event_hdr_s {
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t fw_el_signature;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t fw_el_entry_start_offset;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t fw_el_rsvd1;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t fw_el_buf_size;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t fw_el_rsvd2;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t fw_el_oldest_idx;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t fw_el_latest_idx;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh uint32_t fw_el_entry_size;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh} pmcs_fw_event_hdr_t;
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister/*
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister * Firmware event log entry format
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister */
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollistertypedef struct pmcs_fw_event_entry_s {
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister uint32_t num_words : 3,
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister reserved : 25,
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister severity: 4;
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister uint32_t ts_upper;
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister uint32_t ts_lower;
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister uint32_t seq_num;
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister uint32_t logw0;
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister uint32_t logw1;
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister uint32_t logw2;
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister uint32_t logw3;
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister} pmcs_fw_event_entry_t;
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister#define PMCS_FWLOG_TIMER_DIV 8 /* fw timer has 8ns granularity */
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister#define PMCS_FWLOG_AAP1_SIG 0x1234AAAA
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister#define PMCS_FWLOG_IOP_SIG 0x5678CCCC
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister/*
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister * Receptacle information
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister */
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister#define PMCS_NUM_RECEPTACLES 2
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister#define PMCS_RECEPT_LABEL_0 "SAS0"
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister#define PMCS_RECEPT_LABEL_1 "SAS1"
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister#define PMCS_RECEPT_PM_0 "f0"
1f81b46471e38fdeb9ab74c25510b2f903f8af12David Hollister#define PMCS_RECEPT_PM_1 "f"
658280b6253b61dbb155f43d0e3cbcffa85ccb90David Hollister
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#ifdef __cplusplus
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh}
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#endif
4c06356b0f0fffb4fc1b6eccc8e5d8e2254a84d6dh#endif /* _PMCS_DEF_H */