* Annotate ntddpcm.h and apply some formatting consistency to it.

svn path=/trunk/; revision=60020
This commit is contained in:
Amine Khaldi 2013-09-10 22:20:09 +00:00
parent 074c447003
commit a56630f977

View file

@ -20,6 +20,8 @@
* *
*/ */
#pragma once
#ifndef _NTDDPCMH_ #ifndef _NTDDPCMH_
#define _NTDDPCMH_ #define _NTDDPCMH_
@ -27,10 +29,10 @@
extern "C" { extern "C" {
#endif #endif
#define IOCTL_PCMCIA_BASE FILE_DEVICE_CONTROLLER #define IOCTL_PCMCIA_BASE FILE_DEVICE_CONTROLLER
#define DD_PCMCIA_DEVICE_NAME "\\\\.\\Pcmcia" #define DD_PCMCIA_DEVICE_NAME "\\\\.\\Pcmcia"
#define DD_PCMCIA_DEVICE_NAME_U L"\\\\.\\Pcmcia" #define DD_PCMCIA_DEVICE_NAME_U L"\\\\.\\Pcmcia"
#define IOCTL_GET_TUPLE_DATA \ #define IOCTL_GET_TUPLE_DATA \
CTL_CODE(IOCTL_PCMCIA_BASE, 3000, METHOD_BUFFERED, FILE_ANY_ACCESS) CTL_CODE(IOCTL_PCMCIA_BASE, 3000, METHOD_BUFFERED, FILE_ANY_ACCESS)
@ -38,118 +40,140 @@ extern "C" {
#define IOCTL_SOCKET_INFORMATION \ #define IOCTL_SOCKET_INFORMATION \
CTL_CODE(IOCTL_PCMCIA_BASE, 3004, METHOD_BUFFERED, FILE_ANY_ACCESS) CTL_CODE(IOCTL_PCMCIA_BASE, 3004, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define DEVICE_IDENTIFIER_LENGTH 64 #define DEVICE_IDENTIFIER_LENGTH 64
#define DRIVER_NAME_LENGTH 32 #define DRIVER_NAME_LENGTH 32
#define MANUFACTURER_NAME_LENGTH 64 #define MANUFACTURER_NAME_LENGTH 64
#define PcmciaInvalidControllerType 0xffffffff #define PcmciaInvalidControllerType 0xffffffff
typedef struct _TUPLE_REQUEST { typedef struct _TUPLE_REQUEST {
USHORT Socket; USHORT Socket;
} TUPLE_REQUEST, *PTUPLE_REQUEST; } TUPLE_REQUEST, *PTUPLE_REQUEST;
typedef enum _PCMCIA_CONTROLLER_CLASS { typedef enum _PCMCIA_CONTROLLER_CLASS {
PcmciaInvalidControllerClass = -1, PcmciaInvalidControllerClass = -1,
PcmciaIntelCompatible, PcmciaIntelCompatible,
PcmciaCardBusCompatible, PcmciaCardBusCompatible,
PcmciaElcController, PcmciaElcController,
PcmciaDatabook, PcmciaDatabook,
PcmciaPciPcmciaBridge, PcmciaPciPcmciaBridge,
PcmciaCirrusLogic, PcmciaCirrusLogic,
PcmciaTI, PcmciaTI,
PcmciaTopic, PcmciaTopic,
PcmciaRicoh, PcmciaRicoh,
PcmciaDatabookCB, PcmciaDatabookCB,
PcmciaOpti, PcmciaOpti,
PcmciaTrid, PcmciaTrid,
PcmciaO2Micro, PcmciaO2Micro,
PcmciaNEC, PcmciaNEC,
PcmciaNEC_98 PcmciaNEC_98
} PCMCIA_CONTROLLER_CLASS, *PPCMCIA_CONTROLLER_CLASS; } PCMCIA_CONTROLLER_CLASS, *PPCMCIA_CONTROLLER_CLASS;
typedef struct _PCMCIA_SOCKET_INFORMATION { typedef struct _PCMCIA_SOCKET_INFORMATION {
USHORT Socket; USHORT Socket;
USHORT TupleCrc; USHORT TupleCrc;
UCHAR Manufacturer[MANUFACTURER_NAME_LENGTH]; UCHAR Manufacturer[MANUFACTURER_NAME_LENGTH];
UCHAR Identifier[DEVICE_IDENTIFIER_LENGTH]; UCHAR Identifier[DEVICE_IDENTIFIER_LENGTH];
UCHAR DriverName[DRIVER_NAME_LENGTH]; UCHAR DriverName[DRIVER_NAME_LENGTH];
UCHAR DeviceFunctionId; UCHAR DeviceFunctionId;
UCHAR Reserved; UCHAR Reserved;
UCHAR CardInSocket; UCHAR CardInSocket;
UCHAR CardEnabled; UCHAR CardEnabled;
ULONG ControllerType; ULONG ControllerType;
} PCMCIA_SOCKET_INFORMATION, *PPCMCIA_SOCKET_INFORMATION; } PCMCIA_SOCKET_INFORMATION, *PPCMCIA_SOCKET_INFORMATION;
#define PcmciaClassFromControllerType(type) ((PCMCIA_CONTROLLER_CLASS)((type) & 0xff)) #define PcmciaClassFromControllerType(type) ((PCMCIA_CONTROLLER_CLASS)((type) & 0xff))
#define PcmciaModelFromControllerType(type) (((type) >> 8) & 0x3ffff) #define PcmciaModelFromControllerType(type) (((type) >> 8) & 0x3ffff)
#define PcmciaRevisionFromControllerType(type) ((type) >> 26) #define PcmciaRevisionFromControllerType(type) ((type) >> 26)
DEFINE_GUID(GUID_PCMCIA_INTERFACE_STANDARD, \ DEFINE_GUID(GUID_PCMCIA_INTERFACE_STANDARD, \
0xbed5dadfL, 0x38fb, 0x11d1, 0x94, 0x62, 0x00, 0xc0, 0x4f, 0xb9, 0x60, 0xee); 0xbed5dadfL, 0x38fb, 0x11d1, 0x94, 0x62, 0x00, 0xc0, 0x4f, 0xb9, 0x60, 0xee);
typedef ULONG MEMORY_SPACE; typedef ULONG MEMORY_SPACE;
typedef ULONG typedef
(NTAPI *PPCMCIA_READ_WRITE_CONFIG)( _Function_class_(PCMCIA_READ_CONFIG)
IN PVOID Context, ULONG
IN ULONG WhichSpace, (NTAPI PCMCIA_READ_CONFIG)(
IN PUCHAR Buffer, _In_opt_ PVOID Context,
IN ULONG Offset, _In_ ULONG WhichSpace,
IN ULONG Length); _Out_writes_bytes_all_(Length) PUCHAR Buffer,
_In_ ULONG Offset,
_In_ ULONG Length);
typedef PCMCIA_READ_CONFIG *PPCMCIA_READ_CONFIG;
#define PCCARD_PCI_CONFIGURATION_SPACE 0 typedef
#define PCCARD_ATTRIBUTE_MEMORY 1 _Function_class_(PCMCIA_WRITE_CONFIG)
#define PCCARD_COMMON_MEMORY 2 ULONG
#define PCCARD_ATTRIBUTE_MEMORY_INDIRECT 3 (NTAPI PCMCIA_WRITE_CONFIG)(
#define PCCARD_COMMON_MEMORY_INDIRECT 4 _In_opt_ PVOID Context,
_In_ ULONG WhichSpace,
_In_reads_bytes_(Length) PUCHAR Buffer,
_In_ ULONG Offset,
_In_ ULONG Length);
typedef PCMCIA_WRITE_CONFIG *PPCMCIA_WRITE_CONFIG;
#define PCCARD_PCI_CONFIGURATION_SPACE 0
#define PCCARD_ATTRIBUTE_MEMORY 1
#define PCCARD_COMMON_MEMORY 2
#define PCCARD_ATTRIBUTE_MEMORY_INDIRECT 3
#define PCCARD_COMMON_MEMORY_INDIRECT 4
typedef struct _PCMCIA_BUS_INTERFACE_STANDARD { typedef struct _PCMCIA_BUS_INTERFACE_STANDARD {
USHORT Size; USHORT Size;
USHORT Version; USHORT Version;
PVOID Context; PVOID Context;
PINTERFACE_REFERENCE InterfaceReference; PINTERFACE_REFERENCE InterfaceReference;
PINTERFACE_DEREFERENCE InterfaceDereference; PINTERFACE_DEREFERENCE InterfaceDereference;
PPCMCIA_READ_WRITE_CONFIG ReadConfig; PPCMCIA_READ_WRITE_CONFIG ReadConfig;
PPCMCIA_READ_WRITE_CONFIG WriteConfig; PPCMCIA_READ_WRITE_CONFIG WriteConfig;
} PCMCIA_BUS_INTERFACE_STANDARD, *PPCMCIA_BUS_INTERFACE_STANDARD; } PCMCIA_BUS_INTERFACE_STANDARD, *PPCMCIA_BUS_INTERFACE_STANDARD;
#define PCMCIA_MEMORY_8BIT_ACCESS 0 #define PCMCIA_MEMORY_8BIT_ACCESS 0
#define PCMCIA_MEMORY_16BIT_ACCESS 1 #define PCMCIA_MEMORY_16BIT_ACCESS 1
typedef BOOLEAN typedef
(NTAPI *PPCMCIA_MODIFY_MEMORY_WINDOW)( _Function_class_(PCMCIA_MODIFY_MEMORY_WINDOW)
IN PVOID Context, BOOLEAN
IN ULONGLONG HostBase, (NTAPI PCMCIA_MODIFY_MEMORY_WINDOW)(
IN ULONGLONG CardBase, _In_opt_ PVOID Context,
IN BOOLEAN Enable, _In_ ULONGLONG HostBase,
IN ULONG WindowSize OPTIONAL, _In_ ULONGLONG CardBase,
IN UCHAR AccessSpeed OPTIONAL, _In_ BOOLEAN Enable,
IN UCHAR BusWidth OPTIONAL, _In_opt_ ULONG WindowSize,
IN BOOLEAN IsAttributeMemory OPTIONAL); _In_opt_ UCHAR AccessSpeed,
_In_opt_ UCHAR BusWidth,
_In_opt_ BOOLEAN IsAttributeMemory);
typedef PCMCIA_MODIFY_MEMORY_WINDOW *PPCMCIA_MODIFY_MEMORY_WINDOW;
#define PCMCIA_VPP_0V 0 #define PCMCIA_VPP_0V 0
#define PCMCIA_VPP_12V 1 #define PCMCIA_VPP_12V 1
#define PCMCIA_VPP_IS_VCC 2 #define PCMCIA_VPP_IS_VCC 2
typedef BOOLEAN typedef
(NTAPI *PPCMCIA_SET_VPP)( _Function_class_(PCMCIA_SET_VPP)
IN PVOID Context, BOOLEAN
IN UCHAR VppLevel); (NTAPI PCMCIA_SET_VPP)(
_In_opt_ PVOID Context,
_In_ UCHAR VppLevel);
typedef PCMCIA_SET_VPP *PPCMCIA_SET_VPP;
typedef BOOLEAN typedef
(NTAPI *PPCMCIA_IS_WRITE_PROTECTED)( _Function_class_(PCMCIA_IS_WRITE_PROTECTED)
IN PVOID Context); BOOLEAN
(NTAPI PCMCIA_IS_WRITE_PROTECTED)(
_In_opt_ PVOID Context);
typedef PCMCIA_IS_WRITE_PROTECTED *PPCMCIA_IS_WRITE_PROTECTED;
typedef struct _PCMCIA_INTERFACE_STANDARD { typedef struct _PCMCIA_INTERFACE_STANDARD {
USHORT Size; USHORT Size;
USHORT Version; USHORT Version;
PINTERFACE_REFERENCE InterfaceReference; PINTERFACE_REFERENCE InterfaceReference;
PINTERFACE_DEREFERENCE InterfaceDereference; PINTERFACE_DEREFERENCE InterfaceDereference;
PVOID Context; PVOID Context;
PPCMCIA_MODIFY_MEMORY_WINDOW ModifyMemoryWindow; PPCMCIA_MODIFY_MEMORY_WINDOW ModifyMemoryWindow;
PPCMCIA_SET_VPP SetVpp; PPCMCIA_SET_VPP SetVpp;
PPCMCIA_IS_WRITE_PROTECTED IsWriteProtected; PPCMCIA_IS_WRITE_PROTECTED IsWriteProtected;
} PCMCIA_INTERFACE_STANDARD, *PPCMCIA_INTERFACE_STANDARD; } PCMCIA_INTERFACE_STANDARD, *PPCMCIA_INTERFACE_STANDARD;
#ifdef __cplusplus #ifdef __cplusplus