XenBus.h

Go to the documentation of this file.

 
#ifndef __PROTOCOL_XENBUS_H__
#define __PROTOCOL_XENBUS_H__
 
#define XENBUS_PROTOCOL_GUID \
  {0x3d3ca290, 0xb9a5, 0x11e3, {0xb7, 0x5d, 0xb8, 0xac, 0x6f, 0x7d, 0x65, 0xe6}}
 
typedef struct _XENBUS_PROTOCOL XENBUS_PROTOCOL;
 
typedef enum xenbus_state XenBusState;
 
typedef struct {
  UINT32    Id;
} XENSTORE_TRANSACTION;
 
#define XST_NIL  ((XENSTORE_TRANSACTION *) NULL)
 
typedef enum {
  XENSTORE_STATUS_SUCCESS = 0,
  XENSTORE_STATUS_FAIL,
  XENSTORE_STATUS_EINVAL,
  XENSTORE_STATUS_EACCES,
  XENSTORE_STATUS_EEXIST,
  XENSTORE_STATUS_EISDIR,
  XENSTORE_STATUS_ENOENT,
  XENSTORE_STATUS_ENOMEM,
  XENSTORE_STATUS_ENOSPC,
  XENSTORE_STATUS_EIO,
  XENSTORE_STATUS_ENOTEMPTY,
  XENSTORE_STATUS_ENOSYS,
  XENSTORE_STATUS_EROFS,
  XENSTORE_STATUS_EBUSY,
  XENSTORE_STATUS_EAGAIN,
  XENSTORE_STATUS_EISCONN,
  XENSTORE_STATUS_E2BIG
} XENSTORE_STATUS;
 
#include <IndustryStandard/Xen/grant_table.h>
#include <IndustryStandard/Xen/event_channel.h>
 
 
typedef
XENSTORE_STATUS
(EFIAPI *XENBUS_XS_READ)(
  IN  XENBUS_PROTOCOL       *This,
  IN  CONST XENSTORE_TRANSACTION *Transaction,
  IN  CONST CHAR8           *Node,
  OUT VOID                  **Result
  );
 
typedef
XENSTORE_STATUS
(EFIAPI *XENBUS_XS_BACKEND_READ)(
  IN  XENBUS_PROTOCOL       *This,
  IN  CONST XENSTORE_TRANSACTION *Transaction,
  IN  CONST CHAR8           *Node,
  OUT VOID                  **Result
  );
 
typedef
XENSTORE_STATUS
(EFIAPI *XENBUS_XS_PRINTF)(
  IN XENBUS_PROTOCOL        *This,
  IN CONST XENSTORE_TRANSACTION *Transaction,
  IN CONST CHAR8            *Directory,
  IN CONST CHAR8            *Node,
  IN CONST CHAR8            *Format,
  ...
  );
 
typedef
XENSTORE_STATUS
(EFIAPI *XENBUS_XS_REMOVE)(
  IN XENBUS_PROTOCOL        *This,
  IN CONST XENSTORE_TRANSACTION *Transaction,
  IN CONST CHAR8            *Node
  );
 
typedef
XENSTORE_STATUS
(EFIAPI *XENBUS_XS_TRANSACTION_START)(
  IN  XENBUS_PROTOCOL       *This,
  OUT XENSTORE_TRANSACTION  *Transaction
  );
 
typedef
XENSTORE_STATUS
(EFIAPI *XENBUS_XS_TRANSACTION_END)(
  IN XENBUS_PROTOCOL        *This,
  IN CONST XENSTORE_TRANSACTION *Transaction,
  IN BOOLEAN                Abort
  );
 
typedef
XENSTORE_STATUS
(EFIAPI *XENBUS_SET_STATE)(
  IN XENBUS_PROTOCOL        *This,
  IN CONST XENSTORE_TRANSACTION *Transaction,
  IN XenBusState            State
  );
 
typedef
EFI_STATUS
(EFIAPI *XENBUS_GRANT_ACCESS)(
  IN  XENBUS_PROTOCOL *This,
  IN  domid_t         DomainId,
  IN  UINTN           Frame,
  IN  BOOLEAN         ReadOnly,
  OUT grant_ref_t     *refp
  );
 
typedef
EFI_STATUS
(EFIAPI *XENBUS_GRANT_END_ACCESS)(
  IN XENBUS_PROTOCOL  *This,
  IN grant_ref_t      Ref
  );
 
typedef
UINT32
(EFIAPI *XENBUS_EVENT_CHANNEL_ALLOCATE)(
  IN  XENBUS_PROTOCOL *This,
  IN  domid_t         DomainId,
  OUT evtchn_port_t   *Port
  );
 
typedef
UINT32
(EFIAPI *XENBUS_EVENT_CHANNEL_NOTIFY)(
  IN XENBUS_PROTOCOL  *This,
  IN evtchn_port_t    Port
  );
 
typedef
UINT32
(EFIAPI *XENBUS_EVENT_CHANNEL_CLOSE)(
  IN XENBUS_PROTOCOL  *This,
  IN evtchn_port_t    Port
  );
 
typedef
XENSTORE_STATUS
(EFIAPI *XENBUS_REGISTER_WATCH)(
  IN  XENBUS_PROTOCOL *This,
  IN  CONST CHAR8     *Node,
  OUT VOID            **Token
  );
 
typedef
XENSTORE_STATUS
(EFIAPI *XENBUS_REGISTER_WATCH_BACKEND)(
  IN  XENBUS_PROTOCOL *This,
  IN  CONST CHAR8     *Node,
  OUT VOID            **Token
  );
 
typedef
VOID
(EFIAPI *XENBUS_UNREGISTER_WATCH)(
  IN XENBUS_PROTOCOL  *This,
  IN VOID             *Token
  );
 
typedef
XENSTORE_STATUS
(EFIAPI *XENBUS_WAIT_FOR_WATCH)(
  IN XENBUS_PROTOCOL  *This,
  IN VOID             *Token
  );
 
struct _XENBUS_PROTOCOL {
  XENBUS_XS_READ                   XsRead;
  XENBUS_XS_BACKEND_READ           XsBackendRead;
  XENBUS_XS_PRINTF                 XsPrintf;
  XENBUS_XS_REMOVE                 XsRemove;
  XENBUS_XS_TRANSACTION_START      XsTransactionStart;
  XENBUS_XS_TRANSACTION_END        XsTransactionEnd;
  XENBUS_SET_STATE                 SetState;
 
  XENBUS_GRANT_ACCESS              GrantAccess;
  XENBUS_GRANT_END_ACCESS          GrantEndAccess;
 
  XENBUS_EVENT_CHANNEL_ALLOCATE    EventChannelAllocate;
  XENBUS_EVENT_CHANNEL_NOTIFY      EventChannelNotify;
  XENBUS_EVENT_CHANNEL_CLOSE       EventChannelClose;
 
  XENBUS_REGISTER_WATCH            RegisterWatch;
  XENBUS_REGISTER_WATCH_BACKEND    RegisterWatchBackend;
  XENBUS_UNREGISTER_WATCH          UnregisterWatch;
  XENBUS_WAIT_FOR_WATCH            WaitForWatch;
  //
  // Protocol data fields
  //
  CONST CHAR8                      *Type;
  UINT16                           DeviceId;
  CONST CHAR8                      *Node;
  CONST CHAR8                      *Backend;
};
 
extern EFI_GUID  gXenBusProtocolGuid;
 
#endif