sys/dev/raid/mps/mpi/mpi2_hbd.h

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