satypes.h

Go to the documentation of this file.

/*******************************************************************************
*Copyright (c) 2014 PMC-Sierra, Inc.  All rights reserved. 
*
*Redistribution and use in source and binary forms, with or without modification, are permitted provided 
*that the following conditions are met: 
*1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
*following disclaimer. 
*2. Redistributions in binary form must reproduce the above copyright notice, 
*this list of conditions and the following disclaimer in the documentation and/or other materials provided
*with the distribution. 
*
*THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED 
*WARRANTIES,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
*FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
*FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
*NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 
*BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
*LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
*SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
*
* $FreeBSD$
*
********************************************************************************/
/*******************************************************************************/
/*******************************************************************************/
 
#ifndef  __SATYPES_H__
 
#define __SATYPES_H__
 
typedef bit32 (* agsaCallback_t) (agsaRoot_t *agRoot,
                                  bit32      Event,
                                  void       *Parm);
 
typedef struct agsaTimerDesc_s
{
  SALINK          linkNode; 
  bit32           valid;  
  bit32           timeoutTick; 
  agsaCallback_t  pfnTimeout; 
  bit32           Event; 
  void *          pParm; 
} agsaTimerDesc_t;
 
typedef struct agsaPort_s
{
  SALINK              linkNode;     
  agsaPortContext_t   portContext; 
  SALINK_LIST         listSASATADevices; 
  bit32               phyMap[AGSA_MAX_VALID_PHYS]; 
  bit32               status;  
  bit32               tobedeleted;  
  bit32               portId; 
  bit8                portIdx; 
  bit8                reserved[3];
} agsaPort_t;
 
typedef struct agsaPhy_s
{
  agsaPort_t          *pPort; 
  agsaSASIdentify_t   sasIdentify; 
  agsaContext_t       *agContext; 
  bit32               status; 
  bit8                phyId; 
  bit8                linkstatus; 
  bit8                reserved[2];
#if defined(SALLSDK_DEBUG)
  bit8                remoteSignature[8]; /* the remote signature of the phy is the phy is in native SATA mode */
#endif
} agsaPhy_t;
 
typedef union agsaSASSATADevInfo_s
{
  agsaSASDeviceInfo_t   sasDeviceInfo;  
  agsaSATADeviceInfo_t  sataDeviceInfo; 
} agsaSASSATADevInfo_t;
 
typedef struct agsaDeviceDesc_s
{
  SALINK                linkNode; 
  agsaDevHandle_t       initiatorDevHandle; 
  agsaDevHandle_t       targetDevHandle; 
  SALINK_LIST           pendingIORequests; 
  agsaPort_t            *pPort; 
  bit8                  deviceType; 
  bit8                  reserved[3];
  bit32                 option;
  bit32                 param;
  agsaSASSATADevInfo_t  devInfo; 
  bit32                 DeviceMapIndex;  
} agsaDeviceDesc_t;
 
typedef struct agsaIORequestDesc_s
{
  SALINK            linkNode;          
  agsaIORequest_t   *pIORequestContext;
  agsaDeviceDesc_t  *pDevice;          
  agsaPort_t        *pPort;            
  ossaSSPCompletedCB_t completionCB;   
  bit32             requestType;       
  bit16             HwAckType;         
  bit16             SOP;               
  bit32             startTick;         
  bit32             HTag;              
  bit8              valid;             
  bit8              IRmode;            
  bit8              modePageContext;   
  bit8              DeviceInfoCmdOption;
#ifdef FAST_IO_TEST
  SALINK            fastLink; /* Fast I/O's chain */
#endif
} agsaIORequestDesc_t;
 
typedef struct agsaSMPRspFrame_s
{
  agsaSMPFrameHeader_t smpHeader;
  bit8                 smpPayload[1020];
} agsaSMPRspFrame_t;
 
typedef struct agsaIOMap_s
{
  bit32 Tag;
  agsaIORequestDesc_t *IORequest;
  agsaContext_t *agContext;
} agsaIOMap_t;
 
typedef struct agsaPortMap_s
{
  bit32 PortID;
  bit32 PortStatus;
  void  *PortContext;
} agsaPortMap_t;
 
typedef struct agsaDeviceMap_s
{
  bit32 DeviceIdFromFW;
  void  *DeviceHandle;
} agsaDeviceMap_t;
 
#ifdef FAST_IO_TEST
/* interleaved Fast IO's are not allowed */
#define LL_FAST_IO_SIZE  1
#endif
 
typedef struct agsaLLRoot_s
{
  agsaMem_t       deviceLinkMem; 
  SALINK_LIST     freeDevicesList; 
  agsaMem_t       IORequestMem; 
  SALINK_LIST     freeIORequests; 
  SALINK_LIST     freeReservedRequests; 
  agsaMem_t       timerLinkMem; 
  SALINK_LIST     freeTimers; 
  SALINK_LIST     validTimers; 
  agsaPhy_t       phys[AGSA_MAX_VALID_PHYS]; 
  agsaPort_t      ports[AGSA_MAX_VALID_PORTS]; 
  SALINK_LIST     freePorts; 
  SALINK_LIST     validPorts; 
  bit8            phyCount; 
  bit8            portCount; 
  bit8            sysIntsActive; 
  bit8            reserved; 
  bit32           usecsPerTick; 
  bit32           minStallusecs; 
  bit32           timeTick; 
  bit32           ResetStartTick; /* Reset StartTick */
  bit32           chipStatus; 
  bit32           interruptVecIndexBitMap[MAX_NUM_VECTOR]; 
  bit32           interruptVecIndexBitMap1[MAX_NUM_VECTOR]; 
  agsaBarOffset_t SpcBarOffset[60];
  bit32           ChipId; /* Subversion PCI ID */
 
  agsaPortMap_t   PortMap[AGSA_MAX_VALID_PORTS]; 
  agsaDeviceMap_t DeviceMap[MAX_IO_DEVICE_ENTRIES]; 
  agsaIOMap_t     IOMap[MAX_ACTIVE_IO_REQUESTS]; 
  agsaDevHandle_t *DeviceHandle[MAX_IO_DEVICE_ENTRIES]; 
  agsaDevHandle_t *pDeviceHandle; 
  agsaMemoryRequirement_t memoryAllocated; 
  agsaHwConfig_t          hwConfig; 
  agsaSwConfig_t          swConfig; 
  agsaQueueConfig_t       QueueConfig; /* copy of MPI IBQ/OBQ configuration */
 
  mpiConfig_t     mpiConfig; 
  mpiMemReq_t     mpiMemoryAllocated; 
  mpiICQueue_t    inboundQueue[AGSA_MAX_INBOUND_Q];   
  mpiOCQueue_t    outboundQueue[AGSA_MAX_OUTBOUND_Q]; 
  mpiHostLLConfigDescriptor_t    mainConfigTable; 
  ossaDeviceRegistrationCB_t     DeviceRegistrationCB; 
  ossaDeregisterDeviceHandleCB_t DeviceDeregistrationCB;
  bit32           numInterruptVectors; 
  bit32           Use64bit;            
  EnadDisabHandler_t DisableInterrupts;              /*Interrupt type dependant function pointer to disable interrupts */
  EnadDisabHandler_t ReEnableInterrupts;             /*Interrupt type dependant reenable  */
  InterruptOurs_t OurInterrupt;                      /*Interrupt type dependant check for our interrupt */
 
#ifdef SA_FW_TEST_BUNCH_STARTS
  bit32           BunchStarts_Enable;       // enables/disables whole feature
  bit32           BunchStarts_Threshold;    // global min number of IOs to bunch per queue.
  bit32           BunchStarts_Pending;      // global counter collects all Q->BunchStarts_QPending
  bit32           BunchStarts_TimeoutTicks; // global time out value beyond which bunched IOs will be started even below BunchStarts_Threshold.
#endif /* SA_FW_TEST_BUNCH_STARTS */
 
#ifdef SA_FW_TIMER_READS_STATUS
  spc_GSTableDescriptor_t  mpiGSTable;
  bit32    MsguTcnt_last;             
  bit32    IopTcnt_last;              
  bit32    Iop1Tcnt_last;              
#endif /* SA_FW_TIMER_READS_STATUS */
 
  agsaControllerInfo_t ControllerInfo;
  agsaIOErrorEventStats_t   IoErrorCount;
  agsaIOErrorEventStats_t   IoEventCount;
 
  bit32           ResetFailed;
  //bit32           FatalDone;
  bit32           ForensicLastOffset;
  //bit32           FatalAccumLen;
  //bit32           NonFatalForensicLastOffset;
  //bit32           FatalCurrentLength;
  bit32           FatalForensicStep;
  bit32           FatalForensicShiftOffset;
  bit32           FatalBarLoc;
 
#ifdef HIALEAH_ENCRYPTION
  agsaEncryptGeneralPage_t EncGenPage;
#endif /* HIALEAH_ENCRYPTION */
#ifdef SA_ENABLE_TRACE_FUNCTIONS
  bit8  traceBuffLookup[16];
 
  bit32           TraceDestination;
  bit32           TraceMask;
 
  bit32           TraceBufferLength;
  bit32           CurrentTraceIndexWrapCount;
  bit32           CurrentTraceIndex;
  bit32           traceLineFeedCnt;
  bit8            *TraceBuffer;
  bit32           TraceBlockReInit;
 
#endif /*SA_ENABLE_TRACE_FUNCTIONS*/
 
  bit32           registerDump0[REGISTER_DUMP_BUFF_SIZE/4];  
  bit32           registerDump1[REGISTER_DUMP_BUFF_SIZE/4];  
  bit32           autoDeregDeviceflag[AGSA_MAX_VALID_PORTS];
 
#ifdef SA_FW_TEST_INTERRUPT_REASSERT
  bit32           CheckAll;
  bit32           OldPi[64];
  bit32           OldCi[64];
  bit32           OldFlag[64];
#endif /* SA_FW_TEST_INTERRUPT_REASSERT */
 
 
#ifdef SALL_API_TEST
  agsaLLCountInfo_t LLCounters;
#endif
#ifdef FAST_IO_TEST
  void            *freeFastReq[LL_FAST_IO_SIZE]; /* saFastRequest_t* */
  int             freeFastIdx;
#endif
} agsaLLRoot_t;
 
#ifdef FAST_IO_TEST
/*
  one struct per all prepared Fast IO's;
  freed after all IO's are posted to FW and interrupt is triggered;
  maintained for error rollback or cancel functionality
*/
typedef struct saFastRequest_s
{
  bit32       beforePI[AGSA_MAX_INBOUND_Q];
  bit32       inqList[AGSA_MAX_INBOUND_Q];
  bit32       inqMax;
  SALINK_LIST requests; /* List of all Fast IORequests */
  void        *agRoot;  /* agsaRoot_t * */
  bit8        valid;    /* to avoid usage when the struct is freed */
} saFastRequest_t;
#endif
 
#endif  /*__SATYPES_H__ */