wdc_defs.h

Go to the documentation of this file.

/* @JUNGO_COPYRIGHT@ */
 
#ifndef _WDC_DEFS_H_
#define _WDC_DEFS_H_
 
/**************************************************************************
*  File: wdc_defs.h - WD card (WDC) library low-level definitions header. *
*        This file is used by the WDC library's source files and from     *
*        device-specific sample/generated code XXX library files, but not *
*        from high-level diagnostic code (wdc_diag/xxx_diag).             *
***************************************************************************/
 
#include "wdc_lib.h"
 
#ifdef __cplusplus
    extern "C" {
#endif
 
/*************************************************************
  General definitions
 *************************************************************/
 /* -----------------------------------------------
Memory / I/O / Registers
----------------------------------------------- */
 
typedef struct WDC_ADDR_DESC {
    DWORD  dwAddrSpace;        
    BOOL   fIsMemory;          
    DWORD  dwItemIndex;        
    DWORD  reserved;
    UINT64 qwBytes;            
    KPTR   pAddr;              
    UPTR   pUserDirectMemAddr; 
    PAD_TO_64(pUserDirectMemAddr)
} WDC_ADDR_DESC;
 
/* -----------------------------------------------
    General
   ----------------------------------------------- */
 
typedef struct WDC_DEVICE {
    WD_PCI_ID               id;              
    WD_PCI_SLOT             slot;            
    DWORD                   dwNumAddrSpaces; 
    PAD_TO_64(dwNumAddrSpaces)
    WDC_ADDR_DESC          *pAddrDesc;       
    PAD_TO_64(pAddrDesc)
    WD_CARD_REGISTER        cardReg;         
    WD_KERNEL_PLUGIN        kerPlug;         
    WD_INTERRUPT            Int;             
    HANDLE                  hIntThread;
    PAD_TO_64(hIntThread)
 
    WD_EVENT                Event;           
    HANDLE                  hEvent;
    PAD_TO_64(hEvent)
 
    PVOID                   pCtx;            
    PAD_TO_64(pCtx)
} WDC_DEVICE, *PWDC_DEVICE;
 
/*************************************************************
  General utility macros
 *************************************************************/
/* -----------------------------------------------
    Memory / I/O / Registers
   ----------------------------------------------- */
/* NOTE: pAddrDesc param should be of type WDC_ADDR_DESC* */
#if defined(__KERNEL__)
  #define WDC_MEM_DIRECT_ADDR(pAddrDesc) (pAddrDesc)->pAddr
#else
  #define WDC_MEM_DIRECT_ADDR(pAddrDesc) (pAddrDesc)->pUserDirectMemAddr
#endif
 
#define WDC_ADDR_IS_MEM(pAddrDesc) (pAddrDesc)->fIsMemory
 
/* -----------------------------------------------
    Kernel PlugIn
   ----------------------------------------------- */
#define WDC_GET_KP_HANDLE(pDev) \
    ((WDC_DEVICE *)((PWDC_DEVICE)(pDev)))->kerPlug.hKernelPlugIn
 
#define WDC_IS_KP(pDev) (BOOL)(WDC_GET_KP_HANDLE(pDev))
 
/* -----------------------------------------------
    General
   ----------------------------------------------- */
 
#define WDC_GET_PCARD(pDev) (&(((PWDC_DEVICE)(pDev))->cardReg.Card))
 
#define WDC_GET_CARD_HANDLE(pDev) (((PWDC_DEVICE)(pDev))->cardReg.hCard)
 
#define WDC_GET_PPCI_SLOT(pDev) (&(((PWDC_DEVICE)(pDev))->slot))
 
#define WDC_GET_PPCI_ID(pDev) (&(((PWDC_DEVICE)(pDev))->id))
 
#define WDC_GET_ADDR_DESC(pDev, dwAddrSpace) \
    (&(((PWDC_DEVICE)(pDev))->pAddrDesc[dwAddrSpace]))
 
#define WDC_GET_ADDR_SPACE_SIZE(pDev, dwAddrSpace) \
    ((((PWDC_DEVICE)(pDev))->pAddrDesc[dwAddrSpace]).qwBytes)
 
#define WDC_GET_ENABLED_INT_TYPE(pDev) \
    (WD_ENABLED_INT_TYPE_GET_ENABLED_INT_TYPE_BITS( \
    ((PWDC_DEVICE)pDev)->Int.dwEnabledIntType))
 
#define WDC_GET_INT_OPTIONS(pDev) ((PWDC_DEVICE)pDev)->Int.dwOptions
 
#define WDC_INT_IS_MSI(dwIntType) \
    (dwIntType & (INTERRUPT_MESSAGE | INTERRUPT_MESSAGE_X))
 
#define WDC_GET_NUM_VECTORS(pDev) \
    ((pDev->Int.dwEnabledIntType) >> \
    WD_ENABLED_INT_TYPE_NUM_VECTORS_POSITION_BITS)
 
#define WDC_GET_ENABLED_INT_LAST_MSG(pDev) \
    WDC_INT_IS_MSI(WDC_GET_ENABLED_INT_TYPE(pDev)) ? \
    (((PWDC_DEVICE)pDev)->Int.dwLastMessage) : 0
 
#ifdef __cplusplus
}
#endif
 
#endif /* _WDC_DEFS_H_ */