sdk/include/ddk/miniport.h

   1 /*
   2  * miniport.h
   3  *
   4  * Type definitions for miniport drivers
   5  *
   6  * This file is part of the w32api package.
   7  *
   8  * Contributors:
   9  *   Created by Casper S. Hornstrup <chorns@users.sourceforge.net>
  10  *
  11  * THIS SOFTWARE IS NOT COPYRIGHTED
  12  *
  13  * This source code is offered for use in the public domain. You may
  14  * use, modify or distribute it freely.
  15  *
  16  * This code is distributed in the hope that it will be useful but
  17  * WITHOUT ANY WARRANTY. ALL WARRANTIES, EXPRESS OR IMPLIED ARE HEREBY
  18  * DISCLAIMED. This includes but is not limited to warranties of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  20  *
  21  */
  22
  23 #ifndef _MINIPORT_
  24 #define _MINIPORT_
  25
  26 #ifdef __cplusplus
  27 extern "C" {
  28 #endif
  29
  30 #define EMULATOR_READ_ACCESS              0x01
  31 #define EMULATOR_WRITE_ACCESS             0x02
  32
  33 typedef enum _EMULATOR_PORT_ACCESS_TYPE {
  34   Uchar,
  35   Ushort,
  36   Ulong
  37 } EMULATOR_PORT_ACCESS_TYPE, *PEMULATOR_PORT_ACCESS_TYPE;
  38
  39
  40 typedef struct _EMULATOR_ACCESS_ENTRY {
  41   ULONG BasePort;
  42   ULONG NumConsecutivePorts;
  43   EMULATOR_PORT_ACCESS_TYPE AccessType;
  44   UCHAR AccessMode;
  45   UCHAR StringSupport;
  46   PVOID Routine;
  47 } EMULATOR_ACCESS_ENTRY, *PEMULATOR_ACCESS_ENTRY;
  48
  49 typedef VOID
  50 (NTAPI *PBANKED_SECTION_ROUTINE)(
  51   IN ULONG ReadBank,
  52   IN ULONG WriteBank,
  53   IN PVOID Context);
  54
  55 #ifndef __BROKEN__
  56
  57 typedef enum _INTERFACE_TYPE {
  58   InterfaceTypeUndefined = -1,
  59   Internal,
  60   Isa,
  61   Eisa,
  62   MicroChannel,
  63   TurboChannel,
  64   PCIBus,
  65   VMEBus,
  66   NuBus,
  67   PCMCIABus,
  68   CBus,
  69   MPIBus,
  70   MPSABus,
  71   ProcessorInternal,
  72   InternalPowerBus,
  73   PNPISABus,
  74   PNPBus,
  75   Vmcs,
  76   MaximumInterfaceType
  77 } INTERFACE_TYPE, *PINTERFACE_TYPE;
  78
  79 typedef enum _KINTERRUPT_MODE {
  80   LevelSensitive,
  81   Latched
  82 } KINTERRUPT_MODE;
  83
  84 typedef VOID (*PINTERFACE_REFERENCE)(PVOID Context);
  85 typedef VOID (*PINTERFACE_DEREFERENCE)(PVOID Context);
  86
  87 typedef enum _BUS_DATA_TYPE {
  88   ConfigurationSpaceUndefined = -1,
  89   Cmos,
  90   EisaConfiguration,
  91   Pos,
  92   CbusConfiguration,
  93   PCIConfiguration,
  94   VMEConfiguration,
  95   NuBusConfiguration,
  96   PCMCIAConfiguration,
  97   MPIConfiguration,
  98   MPSAConfiguration,
  99   PNPISAConfiguration,
 100   SgiInternalConfiguration,
 101   MaximumBusDataType
 102 } BUS_DATA_TYPE, *PBUS_DATA_TYPE;
 103
 104 typedef enum _DMA_WIDTH {
 105   Width8Bits,
 106   Width16Bits,
 107   Width32Bits,
 108   MaximumDmaWidth
 109 } DMA_WIDTH, *PDMA_WIDTH;
 110
 111 typedef enum _DMA_SPEED {
 112   Compatible,
 113   TypeA,
 114   TypeB,
 115   TypeC,
 116   TypeF,
 117   MaximumDmaSpeed
 118 } DMA_SPEED, *PDMA_SPEED;
 119
 120 typedef struct _INTERFACE {
 121   USHORT Size;
 122   USHORT Version;
 123   PVOID Context;
 124   PINTERFACE_REFERENCE InterfaceReference;
 125   PINTERFACE_DEREFERENCE InterfaceDereference;
 126 } INTERFACE, *PINTERFACE;
 127
 128 typedef enum _IRQ_DEVICE_POLICY {
 129   IrqPolicyMachineDefault = 0,
 130   IrqPolicyAllCloseProcessors,
 131   IrqPolicyOneCloseProcessor,
 132   IrqPolicyAllProcessorsInMachine,
 133   IrqPolicySpecifiedProcessors,
 134   IrqPolicySpreadMessagesAcrossAllProcessors
 135 } IRQ_DEVICE_POLICY, *PIRQ_DEVICE_POLICY;
 136
 137 typedef enum _IRQ_PRIORITY {
 138   IrqPriorityUndefined = 0,
 139   IrqPriorityLow,
 140   IrqPriorityNormal,
 141   IrqPriorityHigh
 142 } IRQ_PRIORITY, *PIRQ_PRIORITY;
 143
 144 typedef struct _IO_RESOURCE_DESCRIPTOR {
 145   UCHAR Option;
 146   UCHAR Type;             // use CM_RESOURCE_TYPE
 147   UCHAR ShareDisposition; // use CM_SHARE_DISPOSITION
 148   UCHAR Spare1;
 149   USHORT Flags;           // use CM resource flag defines
 150   USHORT Spare2;          // align
 151   union {
 152     struct {
 153       ULONG Length;
 154       ULONG Alignment;
 155       PHYSICAL_ADDRESS MinimumAddress;
 156       PHYSICAL_ADDRESS MaximumAddress;
 157     } Port;
 158     struct {
 159       ULONG Length;
 160       ULONG Alignment;
 161       PHYSICAL_ADDRESS MinimumAddress;
 162       PHYSICAL_ADDRESS MaximumAddress;
 163     } Memory;
 164     struct {
 165       ULONG MinimumVector;
 166       ULONG MaximumVector;
 167       IRQ_DEVICE_POLICY AffinityPolicy;
 168       IRQ_PRIORITY PriorityPolicy;
 169       KAFFINITY TargetedProcessors;
 170     } Interrupt;
 171     struct {
 172       ULONG MinimumChannel;
 173       ULONG MaximumChannel;
 174     } Dma;
 175     struct {
 176       ULONG Length;
 177       ULONG Alignment;
 178       PHYSICAL_ADDRESS MinimumAddress;
 179       PHYSICAL_ADDRESS MaximumAddress;
 180     } Generic;
 181     struct {
 182       ULONG Data[3];
 183     } DevicePrivate;
 184     //
 185     // Bus Number information.
 186     //
 187     struct {
 188       ULONG Length;
 189       ULONG MinBusNumber;
 190       ULONG MaxBusNumber;
 191       ULONG Reserved;
 192     } BusNumber;
 193     struct {
 194       ULONG Priority;     // use LCPRI_Xxx values in cfg.h
 195       ULONG Reserved1;
 196       ULONG Reserved2;
 197     } ConfigData;
 198     //
 199     // The following structures provide descriptions
 200     // for memory resource requirement greater than MAXULONG
 201     //
 202     struct {
 203       ULONG Length40;
 204       ULONG Alignment40;
 205       PHYSICAL_ADDRESS MinimumAddress;
 206       PHYSICAL_ADDRESS MaximumAddress;
 207     } Memory40;
 208     struct {
 209       ULONG Length48;
 210       ULONG Alignment48;
 211       PHYSICAL_ADDRESS MinimumAddress;
 212       PHYSICAL_ADDRESS MaximumAddress;
 213     } Memory48;
 214     struct {
 215       ULONG Length64;
 216       ULONG Alignment64;
 217       PHYSICAL_ADDRESS MinimumAddress;
 218       PHYSICAL_ADDRESS MaximumAddress;
 219     } Memory64;
 220   } u;
 221 } IO_RESOURCE_DESCRIPTOR, *PIO_RESOURCE_DESCRIPTOR;
 222
 223 #include <guiddef.h>
 224 #endif /* ! __BROKEN__ */
 225
 226 #ifdef __cplusplus
 227 }
 228 #endif
 229
 230 #endif /* __MINIPORT_H */