Palacios Public Git Repository

To checkout Palacios execute

  git clone http://v3vee.org/palacios/palacios.web/palacios.git
This will give you the master branch. You probably want the devel branch or one of the release branches. To switch to the devel branch, simply execute
  cd palacios
  git checkout --track -b devel origin/devel
The other branches are similar.


added virtio console, finished the stream interface implementation, added v3_stream...
[palacios.git] / palacios / include / interfaces / vmm_host_dev.h
index 9f7ea91..2b893b5 100644 (file)
@@ -23,7 +23,6 @@
 
 #include <palacios/vmm.h>
 
-
 /*
 
   The purpose of this interface is to make it possible to implement
@@ -74,18 +73,23 @@ typedef void * v3_guest_dev_t;
 
 
 /* There is a notion of a bus class to which the device is attached */
-typedef enum { DIRECT, PCI } v3_bus_class_t;
+typedef enum { V3_BUS_CLASS_DIRECT, V3_BUS_CLASS_PCI } v3_bus_class_t;
 
 #ifdef __V3VEE__
 
+struct v3_vm_info;
+
 v3_host_dev_t v3_host_dev_open(char *impl, 
                               v3_bus_class_t bus,
-                              v3_guest_dev_t gdev); 
+                              v3_guest_dev_t gdev,
+                              struct v3_vm_info *vm); 
 
-uin64_t v3_host_dev_read_io(v3_host_dev_t hostdev, 
-                           uint16_t      port,
-                           void          *dest
-                           uint64_t      len);
+int v3_host_dev_close(v3_host_dev_t hdev);
+    
+uint64_t v3_host_dev_read_io(v3_host_dev_t hostdev,  
+                            uint16_t      port,
+                            void          *dest,
+                            uint64_t      len);
 
 uint64_t v3_host_dev_write_io(v3_host_dev_t hostdev, 
                              uint16_t      port,
@@ -102,13 +106,15 @@ uint64_t v3_host_dev_write_mem(v3_host_dev_t hostdev,
                               void          *src,
                               uint64_t      len);
 
-int v3_host_dev_ack_irq(v3_host_dev_t hostdev, uint32_t irq);
+int v3_host_dev_ack_irq(v3_host_dev_t hostdev, uint8_t irq);
 
-uint64_t v3_host_dev_config_read(v3_host_dev_t hostdev, 
+uint64_t v3_host_dev_read_config(v3_host_dev_t hostdev, 
+                                uint64_t      offset,
                                 void          *dest,
                                 uint64_t      len);
 
-uint64_t v3_host_dev_config_write(v3_host_dev_t hostdev, 
+uint64_t v3_host_dev_write_config(v3_host_dev_t hostdev, 
+                                 uint64_t      offset,
                                  void          *src,
                                  uint64_t      len);
  
@@ -120,10 +126,14 @@ struct v3_host_dev_hooks {
     // this device is attached to and an opaque pointer back to the
     // guest device.  It returns an opaque representation of 
     // the host device it has attached to, with zero indicating
-    // failure
+    // failure.  The host_priv_data arguement supplies to the 
+    // host the pointer that the VM was originally registered with
     v3_host_dev_t (*open)(char *impl, 
                          v3_bus_class_t bus,
-                         v3_guest_dev_t gdev);
+                         v3_guest_dev_t gdev,
+                         void *host_priv_data);
+
+    int (*close)(v3_host_dev_t hdev);
     
     // Read/Write from/to an IO port. The read must either
     // completely succeed, returning len or completely
@@ -131,7 +141,7 @@ struct v3_host_dev_hooks {
     // Callee gets the host dev id and the port in the guest
     uint64_t (*read_io)(v3_host_dev_t hostdev, 
                        uint16_t      port,
-                       void          *dest
+                       void          *dest,
                        uint64_t      len);
 
     uint64_t (*write_io)(v3_host_dev_t hostdev, 
@@ -144,24 +154,20 @@ struct v3_host_dev_hooks {
     // fail, returning != len
     // Callee gets the host dev id, and the guest physical address
     uint64_t (*read_mem)(v3_host_dev_t hostdev, 
-                        addr_t        gpa,
+                        void *        gpa,
                         void          *dest,
                         uint64_t      len);
     
     uint64_t (*write_mem)(v3_host_dev_t hostdev, 
-                         addr_t        gpa,
+                         void *        gpa,
                          void          *src,
                          uint64_t      len);
     
-    // Palacis will call this when it has taken posession of the 
-    // IRQ ad wants the host device to lower it
-    // This interface is unclear 
+    //
+    // Palacios or the guest device will call this
+    // function when it has injected the irq
+    // requested by the guest
     // 
-    // One potential use would be to allow for a palacios
-    // side device to raise the irq asynchronously from
-    // the host device.  If this is permitted, then we
-    // need a way of informing the host device that the
-    // irq has actually been signalled.
     int (*ack_irq)(v3_host_dev_t hostdev, uint8_t irq);
 
     // Configuration space reads/writes for devices that
@@ -175,11 +181,17 @@ struct v3_host_dev_hooks {
     // config space info.   However, a read will return
     // the host device's config, while a write will affect
     // both the palacios-internal config and the hsot device's config
-    uint64_t (*config_read)(v3_host_dev_t hostdev, 
+    //
+    // for V3_BUS_CLASS_PCI they correspond to PCI config space (e.g., BARS, etc)
+    // reads and writes
+    //
+    uint64_t (*read_config)(v3_host_dev_t hostdev, 
+                           uint64_t      offset,
                            void          *dest,
                            uint64_t      len);
-
-    uint64_t (*config_write)(v3_host_dev_t hostdev, 
+    
+    uint64_t (*write_config)(v3_host_dev_t hostdev,
+                            uint64_t      offset,
                             void          *src,
                             uint64_t      len);
  
@@ -194,19 +206,16 @@ int v3_host_dev_raise_irq(v3_host_dev_t hostdev,
 
 /* These functions allow the host to read and write the guest
    memory by physical address, for example to implement DMA 
-
-   These functions are incremental - that is, they can return
-   a smaller amount than requested
 */
 uint64_t v3_host_dev_read_guest_mem(v3_host_dev_t  hostdev,
                                    v3_guest_dev_t guest_dev,
-                                   addr_t         gpa,
+                                   void *         gpa,
                                    void           *dest,
                                    uint64_t       len);
 
 uint64_t v3_host_dev_write_guest_mem(v3_host_dev_t  hostdev,
                                     v3_guest_dev_t guest_dev,
-                                    addr_t         gpa,
+                                    void *         gpa,
                                     void           *src,
                                     uint64_t       len);