sys/dev/mps/mpi/mpi2_hbd.h

   1 /*-
   2  * Copyright (c) 2009-2015 LSI Corp.
   3  * Copyright (c) 2013-2015 Avago Technologies
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 /*
  33  *  Copyright (c) 2009-2015 LSI Corporation.
  34  *  Copyright (c) 2013-2015 Avago Technologies
  35  *
  36  *
  37  *           Name:  mpi2_hbd.h
  38  *          Title:  MPI Host Based Discovery messages and structures
  39  *  Creation Date:  October 21, 2009
  40  *
  41  *  mpi2_hbd.h Version:  02.00.01
  42  *
  43  *  Version History
  44  *  ---------------
  45  *
  46  *  Date      Version   Description
  47  *  --------  --------  ------------------------------------------------------
  48  *  10-28-09  02.00.00  Initial version.
  49  *  08-11-10  02.00.01  Removed PortGroups, DmaGroup, and ControlGroup from
  50  *                      HBD Action request, replaced by AdditionalInfo field.
  51  *  --------------------------------------------------------------------------
  52  */
  53
  54 #ifndef MPI2_HBD_H
  55 #define MPI2_HBD_H
  56
  57 /****************************************************************************
  58 *  Host Based Discovery Action messages
  59 ****************************************************************************/
  60
  61 /* Host Based Discovery Action Request Message */
  62 typedef struct _MPI2_HBD_ACTION_REQUEST
  63 {
  64     U8                      Operation;          /* 0x00 */
  65     U8                      Reserved1;          /* 0x01 */
  66     U8                      ChainOffset;        /* 0x02 */
  67     U8                      Function;           /* 0x03 */
  68     U16                     DevHandle;          /* 0x04 */
  69     U8                      Reserved2;          /* 0x06 */
  70     U8                      MsgFlags;           /* 0x07 */
  71     U8                      VP_ID;              /* 0x08 */
  72     U8                      VF_ID;              /* 0x09 */
  73     U16                     Reserved3;          /* 0x0A */
  74     U32                     Reserved4;          /* 0x0C */
  75     U64                     SASAddress;         /* 0x10 */
  76     U32                     Reserved5;          /* 0x18 */
  77     U32                     HbdDeviceInfo;      /* 0x1C */
  78     U16                     ParentDevHandle;    /* 0x20 */
  79     U16                     MaxQDepth;          /* 0x22 */
  80     U8                      FirstPhyIdentifier; /* 0x24 */
  81     U8                      Port;               /* 0x25 */
  82     U8                      MaxConnections;     /* 0x26 */
  83     U8                      MaxRate;            /* 0x27 */
  84     U32                     AdditionalInfo;     /* 0x28 */
  85     U16                     InitialAWT;         /* 0x2C */
  86     U16                     Reserved7;          /* 0x2E */
  87     U32                     Reserved8;          /* 0x30 */
  88 } MPI2_HBD_ACTION_REQUEST, MPI2_POINTER PTR_MPI2_HBD_ACTION_REQUEST,
  89   Mpi2HbdActionRequest_t, MPI2_POINTER pMpi2HbdActionRequest_t;
  90
  91 /* values for the Operation field */
  92 #define MPI2_HBD_OP_ADD_DEVICE                  (0x01)
  93 #define MPI2_HBD_OP_REMOVE_DEVICE               (0x02)
  94 #define MPI2_HBD_OP_UPDATE_DEVICE               (0x03)
  95
  96 /* values for the HbdDeviceInfo field */
  97 #define MPI2_HBD_DEVICE_INFO_VIRTUAL_DEVICE     (0x00004000)
  98 #define MPI2_HBD_DEVICE_INFO_ATAPI_DEVICE       (0x00002000)
  99 #define MPI2_HBD_DEVICE_INFO_DIRECT_ATTACH      (0x00000800)
 100 #define MPI2_HBD_DEVICE_INFO_SSP_TARGET         (0x00000400)
 101 #define MPI2_HBD_DEVICE_INFO_STP_TARGET         (0x00000200)
 102 #define MPI2_HBD_DEVICE_INFO_SMP_TARGET         (0x00000100)
 103 #define MPI2_HBD_DEVICE_INFO_SATA_DEVICE        (0x00000080)
 104 #define MPI2_HBD_DEVICE_INFO_SSP_INITIATOR      (0x00000040)
 105 #define MPI2_HBD_DEVICE_INFO_STP_INITIATOR      (0x00000020)
 106 #define MPI2_HBD_DEVICE_INFO_SMP_INITIATOR      (0x00000010)
 107 #define MPI2_HBD_DEVICE_INFO_SATA_HOST          (0x00000008)
 108
 109 #define MPI2_HBD_DEVICE_INFO_MASK_DEVICE_TYPE   (0x00000007)
 110 #define MPI2_HBD_DEVICE_INFO_NO_DEVICE          (0x00000000)
 111 #define MPI2_HBD_DEVICE_INFO_END_DEVICE         (0x00000001)
 112 #define MPI2_HBD_DEVICE_INFO_EDGE_EXPANDER      (0x00000002)
 113 #define MPI2_HBD_DEVICE_INFO_FANOUT_EXPANDER    (0x00000003)
 114
 115 /* values for the MaxRate field */
 116 #define MPI2_HBD_MAX_RATE_MASK                  (0x0F)
 117 #define MPI2_HBD_MAX_RATE_1_5                   (0x08)
 118 #define MPI2_HBD_MAX_RATE_3_0                   (0x09)
 119 #define MPI2_HBD_MAX_RATE_6_0                   (0x0A)
 120
 121
 122 /* Host Based Discovery Action Reply Message */
 123 typedef struct _MPI2_HBD_ACTION_REPLY
 124 {
 125     U8                      Operation;          /* 0x00 */
 126     U8                      Reserved1;          /* 0x01 */
 127     U8                      MsgLength;          /* 0x02 */
 128     U8                      Function;           /* 0x03 */
 129     U16                     DevHandle;          /* 0x04 */
 130     U8                      Reserved2;          /* 0x06 */
 131     U8                      MsgFlags;           /* 0x07 */
 132     U8                      VP_ID;              /* 0x08 */
 133     U8                      VF_ID;              /* 0x09 */
 134     U16                     Reserved3;          /* 0x0A */
 135     U16                     Reserved4;          /* 0x0C */
 136     U16                     IOCStatus;          /* 0x0E */
 137     U32                     IOCLogInfo;         /* 0x10 */
 138 } MPI2_HBD_ACTION_REPLY, MPI2_POINTER PTR_MPI2_HBD_ACTION_REPLY,
 139   Mpi2HbdActionReply_t, MPI2_POINTER pMpi2HbdActionReply_t;
 140
 141
 142 #endif
 143
 144