Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 | /*
* Copyright (C) 2010 - 2013 UNISYS CORPORATION
* All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
* NON INFRINGEMENT. See the GNU General Public License for more
* details.
*/
/*
* This header file is to be included by other kernel mode components that
* implement a particular kind of visor_device. Each of these other kernel
* mode components is called a visor device driver. Refer to visortemplate
* for a minimal sample visor device driver.
*
* There should be nothing in this file that is private to the visorbus
* bus implementation itself.
*/
#ifndef __VISORBUS_H__
#define __VISORBUS_H__
#include <linux/device.h>
#include <linux/module.h>
#include <linux/slab.h>
#include "channel.h"
struct visor_device;
extern struct bus_type visorbus_type;
typedef void (*visorbus_state_complete_func) (struct visor_device *dev,
int status);
struct visorchipset_state {
u32 created:1;
u32 attached:1;
u32 configured:1;
u32 running:1;
/* Add new fields above. */
/* Remaining bits in this 32-bit word are unused. */
};
/*
* This struct describes a specific Supervisor channel, by providing its
* GUID, name, and sizes.
*/
struct visor_channeltype_descriptor {
const guid_t guid;
const char *name;
};
/**
* struct visor_driver - Information provided by each visor driver when it
* registers with the visorbus driver.
* @name: Name of the visor driver.
* @owner: The module owner.
* @channel_types: Types of channels handled by this driver, ending with
* a zero GUID. Our specialized BUS.match() method knows
* about this list, and uses it to determine whether this
* driver will in fact handle a new device that it has
* detected.
* @probe: Called when a new device comes online, by our probe()
* function specified by driver.probe() (triggered
* ultimately by some call to driver_register(),
* bus_add_driver(), or driver_attach()).
* @remove: Called when a new device is removed, by our remove()
* function specified by driver.remove() (triggered
* ultimately by some call to device_release_driver()).
* @channel_interrupt: Called periodically, whenever there is a possiblity
* that "something interesting" may have happened to the
* channel.
* @pause: Called to initiate a change of the device's state. If
* the return valu`e is < 0, there was an error and the
* state transition will NOT occur. If the return value
* is >= 0, then the state transition was INITIATED
* successfully, and complete_func() will be called (or
* was just called) with the final status when either the
* state transition fails or completes successfully.
* @resume: Behaves similar to pause.
* @driver: Private reference to the device driver. For use by bus
* driver only.
*/
struct visor_driver {
const char *name;
struct module *owner;
struct visor_channeltype_descriptor *channel_types;
int (*probe)(struct visor_device *dev);
void (*remove)(struct visor_device *dev);
void (*channel_interrupt)(struct visor_device *dev);
int (*pause)(struct visor_device *dev,
visorbus_state_complete_func complete_func);
int (*resume)(struct visor_device *dev,
visorbus_state_complete_func complete_func);
/* These fields are for private use by the bus driver only. */
struct device_driver driver;
};
#define to_visor_driver(x) (container_of(x, struct visor_driver, driver))
/**
* struct visor_device - A device type for things "plugged" into the visorbus
* bus
* @visorchannel: Points to the channel that the device is
* associated with.
* @channel_type_guid: Identifies the channel type to the bus driver.
* @device: Device struct meant for use by the bus driver
* only.
* @list_all: Used by the bus driver to enumerate devices.
* @timer: Timer fired periodically to do interrupt-type
* activity.
* @being_removed: Indicates that the device is being removed from
* the bus. Private bus driver use only.
* @visordriver_callback_lock: Used by the bus driver to lock when adding and
* removing devices.
* @pausing: Indicates that a change towards a paused state.
* is in progress. Only modified by the bus driver.
* @resuming: Indicates that a change towards a running state
* is in progress. Only modified by the bus driver.
* @chipset_bus_no: Private field used by the bus driver.
* @chipset_dev_no: Private field used the bus driver.
* @state: Used to indicate the current state of the
* device.
* @inst: Unique GUID for this instance of the device.
* @name: Name of the device.
* @pending_msg_hdr: For private use by bus driver to respond to
* hypervisor requests.
* @vbus_hdr_info: A pointer to header info. Private use by bus
* driver.
* @partition_guid: Indicates client partion id. This should be the
* same across all visor_devices in the current
* guest. Private use by bus driver only.
*/
struct visor_device {
struct visorchannel *visorchannel;
guid_t channel_type_guid;
/* These fields are for private use by the bus driver only. */
struct device device;
struct list_head list_all;
struct timer_list timer;
bool timer_active;
bool being_removed;
struct mutex visordriver_callback_lock; /* synchronize probe/remove */
bool pausing;
bool resuming;
u32 chipset_bus_no;
u32 chipset_dev_no;
struct visorchipset_state state;
guid_t inst;
u8 *name;
struct controlvm_message_header *pending_msg_hdr;
void *vbus_hdr_info;
guid_t partition_guid;
struct dentry *debugfs_dir;
struct dentry *debugfs_client_bus_info;
};
#define to_visor_device(x) container_of(x, struct visor_device, device)
int visor_check_channel(struct channel_header *ch, struct device *dev,
const guid_t *expected_uuid, char *chname,
u64 expected_min_bytes, u32 expected_version,
u64 expected_signature);
int visorbus_register_visor_driver(struct visor_driver *drv);
void visorbus_unregister_visor_driver(struct visor_driver *drv);
int visorbus_read_channel(struct visor_device *dev,
unsigned long offset, void *dest,
unsigned long nbytes);
int visorbus_write_channel(struct visor_device *dev,
unsigned long offset, void *src,
unsigned long nbytes);
int visorbus_enable_channel_interrupts(struct visor_device *dev);
void visorbus_disable_channel_interrupts(struct visor_device *dev);
/*
* Levels of severity for diagnostic events, in order from lowest severity to
* highest (i.e. fatal errors are the most severe, and should always be logged,
* but info events rarely need to be logged except during debugging). The
* values DIAG_SEVERITY_ENUM_BEGIN and DIAG_SEVERITY_ENUM_END are not valid
* severity values. They exist merely to dilineate the list, so that future
* additions won't require changes to the driver (i.e. when checking for
* out-of-range severities in SetSeverity). The values DIAG_SEVERITY_OVERRIDE
* and DIAG_SEVERITY_SHUTOFF are not valid severity values for logging events
* but they are valid for controlling the amount of event data. Changes made
* to the enum, need to be reflected in s-Par.
*/
enum diag_severity {
DIAG_SEVERITY_VERBOSE = 0,
DIAG_SEVERITY_INFO = 1,
DIAG_SEVERITY_WARNING = 2,
DIAG_SEVERITY_ERR = 3,
DIAG_SEVERITY_PRINT = 4,
};
int visorchannel_signalremove(struct visorchannel *channel, u32 queue,
void *msg);
int visorchannel_signalinsert(struct visorchannel *channel, u32 queue,
void *msg);
bool visorchannel_signalempty(struct visorchannel *channel, u32 queue);
const guid_t *visorchannel_get_guid(struct visorchannel *channel);
#define BUS_ROOT_DEVICE UINT_MAX
struct visor_device *visorbus_get_device_by_id(u32 bus_no, u32 dev_no,
struct visor_device *from);
#endif
|