blob: b1dce26166bf1cc80526382e60253ff34047abf9 [file] [log] [blame]
Greg Kroah-Hartmanb79c0f42017-11-07 14:58:47 +01001// SPDX-License-Identifier: GPL-2.0
Sameer Wadgaonkar19528052017-06-30 15:43:03 -04002/*
3 * Copyright (C) 2010 - 2015 UNISYS CORPORATION
Ken Cox12e364b2014-03-04 07:58:07 -06004 * All rights reserved.
Ken Cox12e364b2014-03-04 07:58:07 -06005 */
6
7#ifndef __VBUSCHANNEL_H__
8#define __VBUSCHANNEL_H__
9
Sameer Wadgaonkar19528052017-06-30 15:43:03 -040010/*
11 * The vbus channel is the channel area provided via the BUS_CREATE controlvm
12 * message for each virtual bus. This channel area is provided to both server
13 * and client ends of the bus. The channel header area is initialized by
14 * the server, and the remaining information is filled in by the client.
15 * We currently use this for the client to provide various information about
16 * the client devices and client drivers for the server end to see.
Ken Cox12e364b2014-03-04 07:58:07 -060017 */
Sameer Wadgaonkar19528052017-06-30 15:43:03 -040018
Benjamin Romer90addb02014-05-06 09:58:23 -040019#include <linux/uuid.h>
David Kershner93d3ad92017-12-07 12:11:07 -050020#include <linux/visorbus.h>
Ken Cox12e364b2014-03-04 07:58:07 -060021
22/* {193b331b-c58f-11da-95a9-00e08161165f} */
Andy Shevchenkob32c5cb2017-08-22 13:26:54 -040023#define VISOR_VBUS_CHANNEL_GUID \
24 GUID_INIT(0x193b331b, 0xc58f, 0x11da, \
25 0x95, 0xa9, 0x0, 0xe0, 0x81, 0x61, 0x16, 0x5f)
Ken Cox12e364b2014-03-04 07:58:07 -060026
Sameer Wadgaonkar19528052017-06-30 15:43:03 -040027/*
28 * Must increment this whenever you insert or delete fields within this channel
Erik Arfvidsone3f8f772015-11-17 13:35:00 -050029 * struct. Also increment whenever you change the meaning of fields within this
30 * channel struct so as to break pre-existing software. Note that you can
31 * usually add fields to the END of the channel struct withOUT needing to
32 * increment this.
33 */
Sameer Wadgaonkar73472172017-05-19 16:17:44 -040034#define VISOR_VBUS_CHANNEL_VERSIONID 1
Ken Cox12e364b2014-03-04 07:58:07 -060035
Mark Foresta6f77a2e2017-08-22 13:26:55 -040036/*
37 * struct visor_vbus_deviceinfo
Sameer Wadgaonkar19528052017-06-30 15:43:03 -040038 * @devtype: Short string identifying the device type.
39 * @drvname: Driver .sys file name.
40 * @infostrs: Kernel vversion.
41 * @reserved: Pad size to 256 bytes.
42 *
Sameer Wadgaonkarb5b46dd2017-09-27 13:14:47 -040043 * An array of this struct is present in the channel area for each vbus. It is
44 * filled in by the client side to provide info about the device and driver from
45 * the client's perspective.
David Kershnerb6d0fa12016-09-02 16:41:39 -040046 */
Sameer Wadgaonkar55c71eb2017-05-19 16:17:45 -040047struct visor_vbus_deviceinfo {
Sameer Wadgaonkar19528052017-06-30 15:43:03 -040048 u8 devtype[16];
49 u8 drvname[16];
50 u8 infostrs[96];
51 u8 reserved[128];
Jon Frisch2c972732017-03-17 11:27:16 -040052} __packed;
David Kershnerb6d0fa12016-09-02 16:41:39 -040053
Sameer Wadgaonkar19528052017-06-30 15:43:03 -040054/*
55 * struct visor_vbus_headerinfo
56 * @struct_bytes: Size of this struct in bytes.
57 * @device_info_struct_bytes: Size of VISOR_VBUS_DEVICEINFO.
58 * @dev_info_count: Num of items in DevInfo member. This is the
59 * allocated size.
60 * @chp_info_offset: Byte offset from beginning of this struct to the
61 * ChpInfo struct.
62 * @bus_info_offset: Byte offset from beginning of this struct to the
63 * BusInfo struct.
64 * @dev_info_offset: Byte offset from beginning of this struct to the
65 * DevInfo array.
Sameer Wadgaonkarb5b46dd2017-09-27 13:14:47 -040066 * @reserved: Natural alignment.
Sameer Wadgaonkar19528052017-06-30 15:43:03 -040067 */
Sameer Wadgaonkar55c71eb2017-05-19 16:17:45 -040068struct visor_vbus_headerinfo {
Sameer Wadgaonkar19528052017-06-30 15:43:03 -040069 u32 struct_bytes;
70 u32 device_info_struct_bytes;
71 u32 dev_info_count;
72 u32 chp_info_offset;
73 u32 bus_info_offset;
74 u32 dev_info_offset;
Benjamin Romerc2422332014-07-29 15:09:40 -040075 u8 reserved[104];
Jon Frisch2c972732017-03-17 11:27:16 -040076} __packed;
Ken Cox12e364b2014-03-04 07:58:07 -060077
Sameer Wadgaonkar19528052017-06-30 15:43:03 -040078/*
79 * struct visor_vbus_channel
80 * @channel_header: Initialized by server.
81 * @hdr_info: Initialized by server.
82 * @chp_info: Describes client chipset device and driver.
83 * @bus_info: Describes client bus device and driver.
84 * @dev_info: Describes client device and driver for each device on the
85 * bus.
86 */
Sameer Wadgaonkar55c71eb2017-05-19 16:17:45 -040087struct visor_vbus_channel {
Sameer Wadgaonkar19528052017-06-30 15:43:03 -040088 struct channel_header channel_header;
89 struct visor_vbus_headerinfo hdr_info;
Sameer Wadgaonkar55c71eb2017-05-19 16:17:45 -040090 struct visor_vbus_deviceinfo chp_info;
Sameer Wadgaonkar55c71eb2017-05-19 16:17:45 -040091 struct visor_vbus_deviceinfo bus_info;
Sameer Wadgaonkar55c71eb2017-05-19 16:17:45 -040092 struct visor_vbus_deviceinfo dev_info[0];
Jon Frisch2c972732017-03-17 11:27:16 -040093} __packed;
Ken Cox12e364b2014-03-04 07:58:07 -060094
95#endif