Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 19528057 authored by Sameer Wadgaonkar's avatar Sameer Wadgaonkar Committed by Greg Kroah-Hartman
Browse files

staging: unisys: visorbus: vbuschannel.h: fixed comment formatting issues 



Removed comments from the right side of the lines.

Added kernel-doc like comments and cleaned up the inline comments in the
structures.

Signed-off-by: default avatarSameer Wadgaonkar <sameer.wadgaonkar@unisys.com>
Signed-off-by: default avatarDavid Kershner <david.kershner@unisys.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent fd307486

drivers/staging/unisys/visorbus/vbuschannel.h

+58 −33
Original line number Diff line number Diff line 
/* Copyright (C) 2010 - 2015 UNISYS CORPORATION

/*

 * Copyright (C) 2010 - 2015 UNISYS CORPORATION

 * All rights reserved.

 *

 * This program is free software; you can redistribute it and/or modify it
@@ -15,13 +16,15 @@ 
#ifndef __VBUSCHANNEL_H__

#define __VBUSCHANNEL_H__



/*  The vbus channel is the channel area provided via the BUS_CREATE controlvm

/*

 * The vbus channel is the channel area provided via the BUS_CREATE controlvm

 * message for each virtual bus.  This channel area is provided to both server

 * and client ends of the bus.  The channel header area is initialized by

 * the server, and the remaining information is filled in by the client.

 * We currently use this for the client to provide various information about

 * the client devices and client drivers for the server end to see.

 */



#include <linux/uuid.h>

#include <linux/ctype.h>

#include "channel.h"
@@ -30,11 +33,11 @@ 
#define VISOR_VBUS_CHANNEL_UUID \

	UUID_LE(0x193b331b, 0xc58f, 0x11da, \

		0x95, 0xa9, 0x0, 0xe0, 0x81, 0x61, 0x16, 0x5f)

static const uuid_le visor_vbus_channel_uuid = VISOR_VBUS_CHANNEL_UUID;



#define VISOR_VBUS_CHANNEL_SIGNATURE VISOR_CHANNEL_SIGNATURE



/* Must increment this whenever you insert or delete fields within this channel

/*

 * Must increment this whenever you insert or delete fields within this channel

 * struct.  Also increment whenever you change the meaning of fields within this

 * channel struct so as to break pre-existing software.  Note that you can

 * usually add fields to the END of the channel struct withOUT needing to
@@ -42,43 +45,65 @@ static const uuid_le visor_vbus_channel_uuid = VISOR_VBUS_CHANNEL_UUID; 
 */

#define VISOR_VBUS_CHANNEL_VERSIONID 1



/*

static const uuid_le visor_vbus_channel_uuid = VISOR_VBUS_CHANNEL_UUID;



/* struct visor_vbus_deviceinfo

 * @devtype:  Short string identifying the device type.

 * @drvname:  Driver .sys file name.

 * @infostrs: Kernel vversion.

 * @reserved: Pad size to 256 bytes.

 *

 * An array of this struct is present in the channel area for each vbus.

 * (See vbuschannel.h.)

 * It is filled in by the client side to provide info about the device

 * and driver from the client's perspective.

 * (See vbuschannel.h.). It is filled in by the client side to provide info

 * about the device and driver from the client's perspective.

 */

struct visor_vbus_deviceinfo {

	u8 devtype[16];		/* short string identifying the device type */

	u8 drvname[16];		/* driver .sys file name */

	u8 infostrs[96];	/* kernel version */

	u8 reserved[128];	/* pad size to 256 bytes */

	u8 devtype[16];

	u8 drvname[16];

	u8 infostrs[96];

	u8 reserved[128];

} __packed;



/*

 * struct visor_vbus_headerinfo

 * @struct_bytes:	      Size of this struct in bytes.

 * @device_info_struct_bytes: Size of VISOR_VBUS_DEVICEINFO.

 * @dev_info_count:	      Num of items in DevInfo member. This is the

 *			      allocated size.

 * @chp_info_offset:	      Byte offset from beginning of this struct to the

 *			      ChpInfo struct.

 * @bus_info_offset:	      Byte offset from beginning of this struct to the

 *			      BusInfo struct.

 * @dev_info_offset:	      Byte offset from beginning of this struct to the

 *			      DevInfo array.

 * @reserved:		      Natural Alignment

 */

struct visor_vbus_headerinfo {

	u32 struct_bytes;	/* size of this struct in bytes */

	u32 device_info_struct_bytes;	/* sizeof(VISOR_VBUS_DEVICEINFO) */

	u32 dev_info_count;	/* num of items in DevInfo member */

	/* (this is the allocated size) */

	u32 chp_info_offset;	/* byte offset from beginning of this struct */

	/* to the ChpInfo struct (below) */

	u32 bus_info_offset;	/* byte offset from beginning of this struct */

	/* to the BusInfo struct (below) */

	u32 dev_info_offset;	/* byte offset from beginning of this struct */

	/* to the DevInfo array (below) */

	u32 struct_bytes;

	u32 device_info_struct_bytes;

	u32 dev_info_count;

	u32 chp_info_offset;

	u32 bus_info_offset;

	u32 dev_info_offset;

	u8 reserved[104];

} __packed;



/*

 * struct visor_vbus_channel

 * @channel_header: Initialized by server.

 * @hdr_info:	    Initialized by server.

 * @chp_info:	    Describes client chipset device and driver.

 * @bus_info:	    Describes client bus device and driver.

 * @dev_info:	    Describes client device and driver for each device on the

 *		    bus.

 */

struct visor_vbus_channel {

	struct channel_header channel_header;	/* initialized by server */

	struct visor_vbus_headerinfo hdr_info;	/* initialized by server */

	/* the remainder of this channel is filled in by the client */

	struct channel_header channel_header;

	struct visor_vbus_headerinfo hdr_info;

	/* The remainder of this channel is filled in by the client */

	struct visor_vbus_deviceinfo chp_info;

	/* describes client chipset device and driver */

	struct visor_vbus_deviceinfo bus_info;

	/* describes client bus device and driver */

	struct visor_vbus_deviceinfo dev_info[0];

	/* describes client device and driver for each device on the bus */

} __packed;



#endif