2009-07-13 22:19:28 +00:00
|
|
|
/*
|
|
|
|
*
|
|
|
|
* Copyright (c) 2009, Microsoft Corporation.
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
|
|
* under the terms and conditions of the GNU General Public License,
|
|
|
|
* version 2, as published by the Free Software Foundation.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope it will be useful, but WITHOUT
|
|
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
|
|
|
|
* more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License along with
|
|
|
|
* this program; if not, write to the Free Software Foundation, Inc., 59 Temple
|
|
|
|
* Place - Suite 330, Boston, MA 02111-1307 USA.
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Haiyang Zhang <haiyangz@microsoft.com>
|
|
|
|
* Hank Janssen <hjanssen@microsoft.com>
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
#ifndef _VMBUS_API_H_
|
|
|
|
#define _VMBUS_API_H_
|
|
|
|
|
|
|
|
#include "osd.h"
|
|
|
|
|
|
|
|
//
|
|
|
|
// Defines
|
|
|
|
//
|
|
|
|
|
|
|
|
#define MAX_PAGE_BUFFER_COUNT 16
|
|
|
|
#define MAX_MULTIPAGE_BUFFER_COUNT 32 // 128K
|
|
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
// Fwd declarations
|
|
|
|
//
|
|
|
|
typedef struct _DRIVER_OBJECT *PDRIVER_OBJECT;
|
|
|
|
typedef struct _DEVICE_OBJECT *PDEVICE_OBJECT;
|
|
|
|
|
|
|
|
//
|
|
|
|
// Data types
|
|
|
|
//
|
|
|
|
|
|
|
|
#pragma pack(push,1)
|
|
|
|
|
|
|
|
// Single-page buffer
|
|
|
|
typedef struct _PAGE_BUFFER {
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 Length;
|
|
|
|
u32 Offset;
|
2009-07-14 22:10:26 +00:00
|
|
|
u64 Pfn;
|
2009-07-13 22:19:28 +00:00
|
|
|
} PAGE_BUFFER;
|
|
|
|
|
|
|
|
// Multiple-page buffer
|
|
|
|
typedef struct _MULTIPAGE_BUFFER {
|
|
|
|
// Length and Offset determines the # of pfns in the array
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 Length;
|
|
|
|
u32 Offset;
|
2009-07-14 22:10:26 +00:00
|
|
|
u64 PfnArray[MAX_MULTIPAGE_BUFFER_COUNT];
|
2009-07-13 22:19:28 +00:00
|
|
|
}MULTIPAGE_BUFFER;
|
|
|
|
|
|
|
|
//0x18 includes the proprietary packet header
|
|
|
|
#define MAX_PAGE_BUFFER_PACKET (0x18 + (sizeof(PAGE_BUFFER) * MAX_PAGE_BUFFER_COUNT))
|
|
|
|
#define MAX_MULTIPAGE_BUFFER_PACKET (0x18 + sizeof(MULTIPAGE_BUFFER))
|
|
|
|
|
|
|
|
|
|
|
|
#pragma pack(pop)
|
|
|
|
|
|
|
|
// All drivers
|
|
|
|
typedef int (*PFN_ON_DEVICEADD)(PDEVICE_OBJECT Device, void* AdditionalInfo);
|
|
|
|
typedef int (*PFN_ON_DEVICEREMOVE)(PDEVICE_OBJECT Device);
|
|
|
|
typedef char** (*PFN_ON_GETDEVICEIDS)(void);
|
|
|
|
typedef void (*PFN_ON_CLEANUP)(PDRIVER_OBJECT Driver);
|
|
|
|
|
|
|
|
// Vmbus extensions
|
|
|
|
//typedef int (*PFN_ON_MATCH)(PDEVICE_OBJECT dev, PDRIVER_OBJECT drv);
|
|
|
|
//typedef int (*PFN_ON_PROBE)(PDEVICE_OBJECT dev);
|
|
|
|
typedef int (*PFN_ON_ISR)(PDRIVER_OBJECT drv);
|
|
|
|
typedef void (*PFN_ON_DPC)(PDRIVER_OBJECT drv);
|
|
|
|
typedef void (*PFN_GET_CHANNEL_OFFERS)(void);
|
|
|
|
|
|
|
|
typedef PDEVICE_OBJECT (*PFN_ON_CHILDDEVICE_CREATE)(GUID DeviceType, GUID DeviceInstance, void *Context);
|
|
|
|
typedef void (*PFN_ON_CHILDDEVICE_DESTROY)(PDEVICE_OBJECT Device);
|
|
|
|
typedef int (*PFN_ON_CHILDDEVICE_ADD)(PDEVICE_OBJECT RootDevice, PDEVICE_OBJECT ChildDevice);
|
|
|
|
typedef void (*PFN_ON_CHILDDEVICE_REMOVE)(PDEVICE_OBJECT Device);
|
|
|
|
|
|
|
|
// Vmbus channel interface
|
2009-07-14 22:06:28 +00:00
|
|
|
typedef void (*VMBUS_CHANNEL_CALLBACK)(void * context);
|
2009-07-13 22:19:28 +00:00
|
|
|
|
|
|
|
typedef int (*VMBUS_CHANNEL_OPEN)(
|
|
|
|
PDEVICE_OBJECT Device,
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 SendBufferSize,
|
|
|
|
u32 RecvRingBufferSize,
|
2009-07-14 22:06:28 +00:00
|
|
|
void * UserData,
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 UserDataLen,
|
2009-07-13 22:19:28 +00:00
|
|
|
VMBUS_CHANNEL_CALLBACK ChannelCallback,
|
2009-07-14 22:06:28 +00:00
|
|
|
void * Context
|
2009-07-13 22:19:28 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
typedef void (*VMBUS_CHANNEL_CLOSE)(
|
|
|
|
PDEVICE_OBJECT Device
|
|
|
|
);
|
|
|
|
|
|
|
|
typedef int (*VMBUS_CHANNEL_SEND_PACKET)(
|
|
|
|
PDEVICE_OBJECT Device,
|
2009-07-14 22:06:28 +00:00
|
|
|
const void * Buffer,
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 BufferLen,
|
2009-07-14 22:10:26 +00:00
|
|
|
u64 RequestId,
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 Type,
|
|
|
|
u32 Flags
|
2009-07-13 22:19:28 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
typedef int (*VMBUS_CHANNEL_SEND_PACKET_PAGEBUFFER)(
|
|
|
|
PDEVICE_OBJECT Device,
|
|
|
|
PAGE_BUFFER PageBuffers[],
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 PageCount,
|
2009-07-14 22:06:28 +00:00
|
|
|
void * Buffer,
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 BufferLen,
|
2009-07-14 22:10:26 +00:00
|
|
|
u64 RequestId
|
2009-07-13 22:19:28 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
typedef int (*VMBUS_CHANNEL_SEND_PACKET_MULTIPAGEBUFFER)(
|
|
|
|
PDEVICE_OBJECT Device,
|
|
|
|
MULTIPAGE_BUFFER *MultiPageBuffer,
|
2009-07-14 22:06:28 +00:00
|
|
|
void * Buffer,
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 BufferLen,
|
2009-07-14 22:10:26 +00:00
|
|
|
u64 RequestId
|
2009-07-13 22:19:28 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
typedef int (*VMBUS_CHANNEL_RECV_PACKET)(
|
|
|
|
PDEVICE_OBJECT Device,
|
2009-07-14 22:06:28 +00:00
|
|
|
void * Buffer,
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 BufferLen,
|
|
|
|
u32* BufferActualLen,
|
2009-07-14 22:10:26 +00:00
|
|
|
u64* RequestId
|
2009-07-13 22:19:28 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
typedef int (*VMBUS_CHANNEL_RECV_PACKET_PAW)(
|
|
|
|
PDEVICE_OBJECT Device,
|
2009-07-14 22:06:28 +00:00
|
|
|
void * Buffer,
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 BufferLen,
|
|
|
|
u32* BufferActualLen,
|
2009-07-14 22:10:26 +00:00
|
|
|
u64* RequestId
|
2009-07-13 22:19:28 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
typedef int (*VMBUS_CHANNEL_ESTABLISH_GPADL)(
|
|
|
|
PDEVICE_OBJECT Device,
|
2009-07-14 22:06:28 +00:00
|
|
|
void * Buffer, // from kmalloc()
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 BufferLen, // page-size multiple
|
|
|
|
u32* GpadlHandle
|
2009-07-13 22:19:28 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
typedef int (*VMBUS_CHANNEL_TEARDOWN_GPADL)(
|
|
|
|
PDEVICE_OBJECT Device,
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 GpadlHandle
|
2009-07-13 22:19:28 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
|
|
|
|
typedef struct _PORT_INFO {
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 InterruptMask;
|
|
|
|
u32 ReadIndex;
|
|
|
|
u32 WriteIndex;
|
|
|
|
u32 BytesAvailToRead;
|
|
|
|
u32 BytesAvailToWrite;
|
2009-07-13 22:19:28 +00:00
|
|
|
} PORT_INFO;
|
|
|
|
|
|
|
|
|
|
|
|
typedef struct _DEVICE_INFO {
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 ChannelId;
|
|
|
|
u32 ChannelState;
|
2009-07-13 22:19:28 +00:00
|
|
|
GUID ChannelType;
|
|
|
|
GUID ChannelInstance;
|
|
|
|
|
2009-07-14 22:09:36 +00:00
|
|
|
u32 MonitorId;
|
|
|
|
u32 ServerMonitorPending;
|
|
|
|
u32 ServerMonitorLatency;
|
|
|
|
u32 ServerMonitorConnectionId;
|
|
|
|
u32 ClientMonitorPending;
|
|
|
|
u32 ClientMonitorLatency;
|
|
|
|
u32 ClientMonitorConnectionId;
|
2009-07-13 22:19:28 +00:00
|
|
|
|
|
|
|
PORT_INFO Inbound;
|
|
|
|
PORT_INFO Outbound;
|
|
|
|
} DEVICE_INFO;
|
|
|
|
|
|
|
|
typedef void (*VMBUS_GET_CHANNEL_INFO)(PDEVICE_OBJECT Device, DEVICE_INFO* DeviceInfo);
|
|
|
|
|
|
|
|
typedef struct _VMBUS_CHANNEL_INTERFACE {
|
|
|
|
VMBUS_CHANNEL_OPEN Open;
|
|
|
|
VMBUS_CHANNEL_CLOSE Close;
|
|
|
|
VMBUS_CHANNEL_SEND_PACKET SendPacket;
|
|
|
|
VMBUS_CHANNEL_SEND_PACKET_PAGEBUFFER SendPacketPageBuffer;
|
|
|
|
VMBUS_CHANNEL_SEND_PACKET_MULTIPAGEBUFFER SendPacketMultiPageBuffer;
|
|
|
|
VMBUS_CHANNEL_RECV_PACKET RecvPacket;
|
|
|
|
VMBUS_CHANNEL_RECV_PACKET_PAW RecvPacketRaw;
|
|
|
|
VMBUS_CHANNEL_ESTABLISH_GPADL EstablishGpadl;
|
|
|
|
VMBUS_CHANNEL_TEARDOWN_GPADL TeardownGpadl;
|
|
|
|
VMBUS_GET_CHANNEL_INFO GetInfo;
|
|
|
|
} VMBUS_CHANNEL_INTERFACE;
|
|
|
|
|
|
|
|
typedef void (*VMBUS_GET_CHANNEL_INTERFACE)(VMBUS_CHANNEL_INTERFACE *Interface);
|
|
|
|
|
|
|
|
// Base driver object
|
|
|
|
typedef struct _DRIVER_OBJECT {
|
|
|
|
const char* name;
|
|
|
|
GUID deviceType; // the device type supported by this driver
|
|
|
|
|
|
|
|
PFN_ON_DEVICEADD OnDeviceAdd;
|
|
|
|
PFN_ON_DEVICEREMOVE OnDeviceRemove;
|
|
|
|
PFN_ON_GETDEVICEIDS OnGetDeviceIds; // device ids supported by this driver
|
|
|
|
PFN_ON_CLEANUP OnCleanup;
|
|
|
|
|
|
|
|
VMBUS_CHANNEL_INTERFACE VmbusChannelInterface;
|
|
|
|
} DRIVER_OBJECT;
|
|
|
|
|
|
|
|
|
|
|
|
// Base device object
|
|
|
|
typedef struct _DEVICE_OBJECT {
|
|
|
|
DRIVER_OBJECT* Driver; // the driver for this device
|
|
|
|
char name[64];
|
|
|
|
GUID deviceType; // the device type id of this device
|
|
|
|
GUID deviceInstance; // the device instance id of this device
|
|
|
|
void* context;
|
|
|
|
void* Extension; // Device extension;
|
|
|
|
} DEVICE_OBJECT;
|
|
|
|
|
|
|
|
|
|
|
|
// Vmbus driver object
|
|
|
|
typedef struct _VMBUS_DRIVER_OBJECT {
|
|
|
|
DRIVER_OBJECT Base; // !! Must be the 1st field !!
|
|
|
|
|
|
|
|
// Set by the caller
|
|
|
|
PFN_ON_CHILDDEVICE_CREATE OnChildDeviceCreate;
|
|
|
|
PFN_ON_CHILDDEVICE_DESTROY OnChildDeviceDestroy;
|
|
|
|
PFN_ON_CHILDDEVICE_ADD OnChildDeviceAdd;
|
|
|
|
PFN_ON_CHILDDEVICE_REMOVE OnChildDeviceRemove;
|
|
|
|
|
|
|
|
// Set by the callee
|
|
|
|
//PFN_ON_MATCH OnMatch;
|
|
|
|
//PFN_ON_PROBE OnProbe;
|
|
|
|
PFN_ON_ISR OnIsr;
|
|
|
|
PFN_ON_DPC OnMsgDpc;
|
|
|
|
PFN_ON_DPC OnEventDpc;
|
|
|
|
PFN_GET_CHANNEL_OFFERS GetChannelOffers;
|
|
|
|
|
|
|
|
VMBUS_GET_CHANNEL_INTERFACE GetChannelInterface;
|
|
|
|
VMBUS_GET_CHANNEL_INFO GetChannelInfo;
|
|
|
|
} VMBUS_DRIVER_OBJECT;
|
|
|
|
|
|
|
|
|
|
|
|
//
|
|
|
|
// Interface
|
|
|
|
//
|
|
|
|
int
|
|
|
|
VmbusInitialize(
|
|
|
|
DRIVER_OBJECT* drv
|
|
|
|
);
|
|
|
|
|
|
|
|
#endif // _VMBUS_API_H_
|