Commit 15dd144c authored by Erik Arfvidson's avatar Erik Arfvidson Committed by Greg Kroah-Hartman
Browse files

staging: unisys: cleanup and align iochannel.h comments 



This patch reorganizes, aligns, and corrects grammar mistakes on
comments.

Signed-off-by: default avatarErik Arfvidson <erik.arfvidson@unisys.com>
Signed-off-by: default avatarBenjamin Romer <benjamin.romer@unisys.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 67ec962a

drivers/staging/unisys/common-spar/include/channels/iochannel.h

+124 −116
Original line number Diff line number Diff line
@@ -38,11 +38,6 @@ 
#include "vbuschannel.h"

#undef _ULTRA_CONTROLVM_CHANNEL_INLINE_

#include "channel.h"



/*

 * CHANNEL Guids

 */



#include "channel_guid.h"



#define ULTRA_VHBA_CHANNEL_PROTOCOL_SIGNATURE ULTRA_CHANNEL_PROTOCOL_SIGNATURE
@@ -54,7 +49,8 @@ 
 * 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

* increment this. */

 * increment this.

 */

#define ULTRA_VHBA_CHANNEL_PROTOCOL_VERSIONID 2

#define ULTRA_VNIC_CHANNEL_PROTOCOL_VERSIONID 2

#define ULTRA_VSWITCH_CHANNEL_PROTOCOL_VERSIONID 1
@@ -73,7 +69,8 @@ 


/*

 * Everything necessary to handle SCSI & NIC traffic between Guest Partition and

* IO Partition is defined below.  */

 * IO Partition is defined below.

 */



/*

 * Defines and enums.
@@ -83,7 +80,8 @@ 
#define MAXNUM(a, b) (((a) > (b)) ? (a) : (b))



/* these define the two queues per data channel between iopart and

 * ioguestparts */

 * ioguestparts

 */

#define IOCHAN_TO_IOPART 0 /* used by ioguestpart to 'insert' signals to

			    * iopart */
@@ -149,8 +147,7 @@ enum vdisk_mgmt_types { 
	VDISK_MGMT_RELEASE,

};



/*

 * structs with pragma pack  */

/* structs with pragma pack  */



/* ///////////// BEGIN PRAGMA PACK PUSH 1 ///////////////////////// */

/* ///////////// ONLY STRUCT TYPE SHOULD BE BELOW */
@@ -221,17 +218,19 @@ struct uiscmdrsp_scsi { 
	/* see that struct for details. */

	void *vdisk; /* contains pointer to the vdisk so that we can clean up

		      * when the IO completes. */

	int no_disk_result;	/* used to return no disk inquiry result */

	/* when no_disk_result is set to 1,  */

	/* scsi.scsistat is SAM_STAT_GOOD */

	/* scsi.addlstat is 0 */

	/* scsi.linuxstat is SAM_STAT_GOOD */

	/* That is, there is NO error. */

	int no_disk_result;

	/* used to return no disk inquiry result

	 * when no_disk_result is set to 1,

	 * scsi.scsistat is SAM_STAT_GOOD

	 * scsi.addlstat is 0

	 * scsi.linuxstat is SAM_STAT_GOOD

	 * That is, there is NO error.

	 */

};



/*

* Defines to support sending correct inquiry result when no disk is

* configured.  */

/* Defines to support sending correct inquiry result when no disk is

 * configured.

 */



/* From SCSI SPC2 -

 *
@@ -258,7 +257,8 @@ struct uiscmdrsp_scsi { 
/* NOTE: Linux code assumes inquiry contains 36 bytes. Without checking length

 * in buf[4] some linux code accesses bytes beyond 5 to retrieve vendor, product

 * & revision.  Yikes! So let us always send back 36 bytes, the minimum for

* inquiry result. */

 * inquiry result.

 */

#define NO_DISK_INQUIRY_RESULT_LEN 36



#define MIN_INQUIRY_RESULT_LEN 5 /* we need at least 5 bytes minimum for inquiry
@@ -379,7 +379,8 @@ struct net_pkt_xmtdone { 
 * virtnic requires that there is "overhead" in the buffer, and pads 16 bytes. I

 * prefer to use 1 full cache line size for "overhead" so that transfers are

 * better.  IOVM requires that a buffer be represented by 1 phys_info structure

* which can only cover page_size. */

 * which can only cover page_size.

 */

#define RCVPOST_BUF_SIZE 4032

#define MAX_NET_RCV_CHAIN \

	((ETH_MAX_MTU+ETH_HEADER_SIZE + RCVPOST_BUF_SIZE-1) / RCVPOST_BUF_SIZE)
@@ -392,7 +393,7 @@ struct net_pkt_rcvpost { 
					 * single fragment 2K rcv buf */

	    u64 unique_num;		/* This is used to make sure that

					 * receive posts are returned to  */

	    /* the Adapter which sent them origonally. */

	    /* the Adapter which we sent them originally. */

};



struct net_pkt_rcv {
@@ -446,8 +447,9 @@ struct uiscmdrsp_scsitaskmgmt { 
	void *scsicmd;



	    /* This is some handle that the guest has saved off for its own use.

	    * Its value is preserved by iopart & returned as is in the task mgmt

	    * rsp. */

	     * Its value is preserved by iopart & returned as is in the task

	     * mgmt rsp.

	     */

	void *notify;



	   /* For linux guests, this is a pointer to wait_queue_head that a
@@ -457,13 +459,15 @@ struct uiscmdrsp_scsitaskmgmt { 
	    * When the rsp is received by guest, the thread receiving the

	    * response uses this to notify the thread waiting for taskmgmt

	    * command completion.  Its value is preserved by iopart & returned

	    * as is in the task mgmt rsp. */

	    * as is in the task mgmt rsp.

	    */

	void *notifyresult;



	    /* this is a handle to location in guest where the result of the

	     * taskmgmt command (result field) is to saved off when the response

	     * is handled.  Its value is preserved by iopart & returned as is in

	    * the task mgmt rsp. */

	     * the task mgmt rsp.

	     */

	char result;



	    /* result of taskmgmt command - set by IOPart - values are: */
@@ -492,24 +496,27 @@ struct uiscmdrsp_vdiskmgmt { 
	void *scsicmd;



	    /* This is some handle that the guest has saved off for its own use.

	    * Its value is preserved by iopart & returned as is in the task mgmt

	    * rsp. */

	     * Its value is preserved by iopart & returned as is in the task

	     * mgmt rsp.

	     */

	void *notify;



	    /* For linux guests, this is a pointer to wait_queue_head that a

	    * thread is waiting on to see if the taskmgmt command has completed.

	    * For windows guests, this is a pointer to a location that a waiting

	     * thread is waiting on to see if the tskmgmt command has completed.

	     * For win32 guests, this is a pointer to a location that a waiting

	     * thread is testing to see if the taskmgmt command has completed.

	     * When the rsp is received by guest, the thread receiving the

	     * response uses this to notify the thread waiting for taskmgmt

	     * command completion.  Its value is preserved by iopart & returned

	    * as is in the task mgmt rsp. */

	     * as is in the task mgmt rsp.

	     */

	void *notifyresult;



	    /* this is a handle to location in guest where the result of the

	     * taskmgmt command (result field) is to saved off when the response

	     * is handled.  Its value is preserved by iopart & returned as is in

	    * the task mgmt rsp. */

	     * the task mgmt rsp.

	     */

	char result;



	    /* result of taskmgmt command - set by IOPart - values are: */
@@ -542,7 +549,8 @@ struct uiscmdrsp { 


/* This is just the header of the IO channel.  It is assumed that directly after

 * this header there is a large region of memory which contains the command and

* response queues as specified in cmd_q and rsp_q SIGNAL_QUEUE_HEADERS. */

 * response queues as specified in cmd_q and rsp_q SIGNAL_QUEUE_HEADERS.

 */

struct spar_io_channel_protocol {

	struct channel_header channel_header;

	struct signal_queue_header cmd_q;
@@ -551,13 +559,13 @@ struct spar_io_channel_protocol { 
		struct {

			struct vhba_wwnn wwnn;		/* 8 bytes */

			struct vhba_config_max max;	/* 20 bytes */

		} vhba;		/* 28 */

		} vhba;					/* total = 28 bytes */

		struct {

			u8 macaddr[MAX_MACADDR_LEN];	/* 6 bytes */

			u32 num_rcv_bufs;	/* 4 */

			u32 mtu;	/* 4 */

			uuid_le zone_uuid;	/* 16 */

		} vnic;		/* total     30 */

			u32 num_rcv_bufs;		/* 4 bytes */

			u32 mtu;			/* 4 bytes */

			uuid_le zone_uuid;		/* 16 bytes */

		} vnic;					/* total = 30 bytes */

	};



#define MAX_CLIENTSTRING_LEN 1024

CRA Git | Maintained and supported by SUSTech CRA and CCSE