Skip to content

Commit

Permalink
staging: hv: Corrected all header comment formats kernel-doc format
Browse files Browse the repository at this point in the history 
Removed kerneldoc /** from functions that should not have them.
Added proper kerneldoc headers to functions that should have them.

This includes fixes as pointed out by Randy Dunlap and Joe Perches.

Cc: Joe Perches <joe@perches.com>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Hank Janssen <hjanssen@microsoft.com>
Signed-off-by: Haiyang Zhang <haiyangz@microsoft.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
  • Loading branch information
Hank Janssen authored and Greg Kroah-Hartman committed May 11, 2010
1 parent 173f346 commit 3e18951
Show file tree
Hide file tree
Showing 14 changed files with 234 additions and 114 deletions.
49 changes: 27 additions & 22 deletions drivers/staging/hv/Channel.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ static void DumpMonitorPage(struct hv_monitor_page *MonitorPage)
}
#endif

/**
* VmbusChannelSetEvent - Trigger an event notification on the specified channel.
/*
* VmbusChannelSetEvent - Trigger an event notification on the specified
* channel.
*/
static void VmbusChannelSetEvent(struct vmbus_channel *Channel)
{
Expand Down Expand Up @@ -120,7 +121,7 @@ static void VmbusChannelClearEvent(struct vmbus_channel *channel)
}

#endif
/**
/*
* VmbusChannelGetDebugInfo -Retrieve various channel debug info
*/
void VmbusChannelGetDebugInfo(struct vmbus_channel *Channel,
Expand Down Expand Up @@ -165,7 +166,7 @@ void VmbusChannelGetDebugInfo(struct vmbus_channel *Channel,
RingBufferGetDebugInfo(&Channel->Outbound, &DebugInfo->Outbound);
}

/**
/*
* VmbusChannelOpen - Open the specified channel.
*/
int VmbusChannelOpen(struct vmbus_channel *NewChannel, u32 SendRingBufferSize,
Expand Down Expand Up @@ -283,8 +284,9 @@ int VmbusChannelOpen(struct vmbus_channel *NewChannel, u32 SendRingBufferSize,
return 0;
}

/**
* DumpGpadlBody - Dump the gpadl body message to the console for debugging purposes.
/*
* DumpGpadlBody - Dump the gpadl body message to the console for
* debugging purposes.
*/
static void DumpGpadlBody(struct vmbus_channel_gpadl_body *Gpadl, u32 Len)
{
Expand All @@ -300,8 +302,9 @@ static void DumpGpadlBody(struct vmbus_channel_gpadl_body *Gpadl, u32 Len)
i, Gpadl->Pfn[i]);
}

/**
* DumpGpadlHeader - Dump the gpadl header message to the console for debugging purposes.
/*
* DumpGpadlHeader - Dump the gpadl header message to the console for
* debugging purposes.
*/
static void DumpGpadlHeader(struct vmbus_channel_gpadl_header *Gpadl)
{
Expand All @@ -325,7 +328,7 @@ static void DumpGpadlHeader(struct vmbus_channel_gpadl_header *Gpadl)
}
}

/**
/*
* VmbusChannelCreateGpadlHeader - Creates a gpadl for the specified buffer
*/
static int VmbusChannelCreateGpadlHeader(void *Kbuffer, u32 Size,
Expand Down Expand Up @@ -441,7 +444,7 @@ static int VmbusChannelCreateGpadlHeader(void *Kbuffer, u32 Size,
return 0;
}

/**
/*
* VmbusChannelEstablishGpadl - Estabish a GPADL for the specified buffer
*
* @Channel: a channel
Expand Down Expand Up @@ -545,7 +548,7 @@ int VmbusChannelEstablishGpadl(struct vmbus_channel *Channel, void *Kbuffer,
return ret;
}

/**
/*
* VmbusChannelTeardownGpadl -Teardown the specified GPADL handle
*/
int VmbusChannelTeardownGpadl(struct vmbus_channel *Channel, u32 GpadlHandle)
Expand Down Expand Up @@ -598,7 +601,7 @@ int VmbusChannelTeardownGpadl(struct vmbus_channel *Channel, u32 GpadlHandle)
return ret;
}

/**
/*
* VmbusChannelClose - Close the specified channel
*/
void VmbusChannelClose(struct vmbus_channel *Channel)
Expand Down Expand Up @@ -663,7 +666,7 @@ void VmbusChannelClose(struct vmbus_channel *Channel)
DPRINT_EXIT(VMBUS);
}

/**
/*
* VmbusChannelSendPacket - Send the specified buffer on the given channel
*/
int VmbusChannelSendPacket(struct vmbus_channel *Channel, const void *Buffer,
Expand Down Expand Up @@ -709,8 +712,9 @@ int VmbusChannelSendPacket(struct vmbus_channel *Channel, const void *Buffer,
return ret;
}

/**
* VmbusChannelSendPacketPageBuffer - Send a range of single-page buffer packets using a GPADL Direct packet type.
/*
* VmbusChannelSendPacketPageBuffer - Send a range of single-page buffer
* packets using a GPADL Direct packet type.
*/
int VmbusChannelSendPacketPageBuffer(struct vmbus_channel *Channel,
struct hv_page_buffer PageBuffers[],
Expand Down Expand Up @@ -774,8 +778,9 @@ int VmbusChannelSendPacketPageBuffer(struct vmbus_channel *Channel,
return ret;
}

/**
* VmbusChannelSendPacketMultiPageBuffer - Send a multi-page buffer packet using a GPADL Direct packet type.
/*
* VmbusChannelSendPacketMultiPageBuffer - Send a multi-page buffer packet
* using a GPADL Direct packet type.
*/
int VmbusChannelSendPacketMultiPageBuffer(struct vmbus_channel *Channel,
struct hv_multipage_buffer *MultiPageBuffer,
Expand Down Expand Up @@ -843,7 +848,7 @@ int VmbusChannelSendPacketMultiPageBuffer(struct vmbus_channel *Channel,
return ret;
}

/**
/*
* VmbusChannelRecvPacket - Retrieve the user packet on the specified channel
*/
/* TODO: Do we ever receive a gpa direct packet other than the ones we send ? */
Expand Down Expand Up @@ -909,7 +914,7 @@ int VmbusChannelRecvPacket(struct vmbus_channel *Channel, void *Buffer,
return 0;
}

/**
/*
* VmbusChannelRecvPacketRaw - Retrieve the raw packet on the specified channel
*/
int VmbusChannelRecvPacketRaw(struct vmbus_channel *Channel, void *Buffer,
Expand Down Expand Up @@ -972,7 +977,7 @@ int VmbusChannelRecvPacketRaw(struct vmbus_channel *Channel, void *Buffer,
return 0;
}

/**
/*
* VmbusChannelOnChannelEvent - Channel event callback
*/
void VmbusChannelOnChannelEvent(struct vmbus_channel *Channel)
Expand All @@ -985,7 +990,7 @@ void VmbusChannelOnChannelEvent(struct vmbus_channel *Channel)
mod_timer(&Channel->poll_timer, jiffies + usecs_to_jiffies(100));
}

/**
/*
* VmbusChannelOnTimer - Timer event callback
*/
void VmbusChannelOnTimer(unsigned long data)
Expand All @@ -996,7 +1001,7 @@ void VmbusChannelOnTimer(unsigned long data)
channel->OnChannelCallback(channel->ChannelCallbackContext);
}

/**
/*
* DumpVmbusChannel - Dump vmbus channel info to the console
*/
static void DumpVmbusChannel(struct vmbus_channel *Channel)
Expand Down
33 changes: 17 additions & 16 deletions drivers/staging/hv/ChannelMgmt.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ static const struct hv_guid
},
};

/**
/*
* AllocVmbusChannel - Allocate and initialize a vmbus channel object
*/
struct vmbus_channel *AllocVmbusChannel(void)
Expand All @@ -97,7 +97,7 @@ struct vmbus_channel *AllocVmbusChannel(void)
return channel;
}

/**
/*
* ReleaseVmbusChannel - Release the vmbus channel object itself
*/
static inline void ReleaseVmbusChannel(void *context)
Expand All @@ -115,7 +115,7 @@ static inline void ReleaseVmbusChannel(void *context)
DPRINT_EXIT(VMBUS);
}

/**
/*
* FreeVmbusChannel - Release the resources used by the vmbus channel object
*/
void FreeVmbusChannel(struct vmbus_channel *Channel)
Expand All @@ -131,7 +131,7 @@ void FreeVmbusChannel(struct vmbus_channel *Channel)
Channel);
}

/**
/*
* VmbusChannelProcessOffer - Process the offer by creating a channel/device associated with this offer
*/
static void VmbusChannelProcessOffer(void *context)
Expand Down Expand Up @@ -213,7 +213,7 @@ static void VmbusChannelProcessOffer(void *context)
DPRINT_EXIT(VMBUS);
}

/**
/*
* VmbusChannelProcessRescindOffer - Rescind the offer by initiating a device removal
*/
static void VmbusChannelProcessRescindOffer(void *context)
Expand All @@ -225,7 +225,7 @@ static void VmbusChannelProcessRescindOffer(void *context)
DPRINT_EXIT(VMBUS);
}

/**
/*
* VmbusChannelOnOffer - Handler for channel offers from vmbus in parent partition.
*
* We ignore all offers except network and storage offers. For each network and
Expand Down Expand Up @@ -308,7 +308,7 @@ static void VmbusChannelOnOffer(struct vmbus_channel_message_header *hdr)
DPRINT_EXIT(VMBUS);
}

/**
/*
* VmbusChannelOnOfferRescind - Rescind offer handler.
*
* We queue a work item to process this offer synchronously
Expand All @@ -335,7 +335,7 @@ static void VmbusChannelOnOfferRescind(struct vmbus_channel_message_header *hdr)
DPRINT_EXIT(VMBUS);
}

/**
/*
* VmbusChannelOnOffersDelivered - This is invoked when all offers have been delivered.
*
* Nothing to do here.
Expand All @@ -347,7 +347,7 @@ static void VmbusChannelOnOffersDelivered(
DPRINT_EXIT(VMBUS);
}

/**
/*
* VmbusChannelOnOpenResult - Open result handler.
*
* This is invoked when we received a response to our channel open request.
Expand Down Expand Up @@ -395,7 +395,7 @@ static void VmbusChannelOnOpenResult(struct vmbus_channel_message_header *hdr)
DPRINT_EXIT(VMBUS);
}

/**
/*
* VmbusChannelOnGpadlCreated - GPADL created handler.
*
* This is invoked when we received a response to our gpadl create request.
Expand Down Expand Up @@ -447,7 +447,7 @@ static void VmbusChannelOnGpadlCreated(struct vmbus_channel_message_header *hdr)
DPRINT_EXIT(VMBUS);
}

/**
/*
* VmbusChannelOnGpadlTorndown - GPADL torndown handler.
*
* This is invoked when we received a response to our gpadl teardown request.
Expand Down Expand Up @@ -495,7 +495,7 @@ static void VmbusChannelOnGpadlTorndown(
DPRINT_EXIT(VMBUS);
}

/**
/*
* VmbusChannelOnVersionResponse - Version response handler
*
* This is invoked when we received a response to our initiate contact request.
Expand Down Expand Up @@ -558,7 +558,7 @@ static struct vmbus_channel_message_table_entry
{ChannelMessageUnload, NULL},
};

/**
/*
* VmbusOnChannelMessage - Handler for channel protocol messages.
*
* This is invoked in the vmbus worker thread context.
Expand Down Expand Up @@ -597,7 +597,7 @@ void VmbusOnChannelMessage(void *Context)
DPRINT_EXIT(VMBUS);
}

/**
/*
* VmbusChannelRequestOffers - Send a request to get all our pending offers.
*/
int VmbusChannelRequestOffers(void)
Expand Down Expand Up @@ -651,8 +651,9 @@ int VmbusChannelRequestOffers(void)
return ret;
}

/**
* VmbusChannelReleaseUnattachedChannels - Release channels that are unattached/unconnected ie (no drivers associated)
/*
* VmbusChannelReleaseUnattachedChannels - Release channels that are
* unattached/unconnected ie (no drivers associated)
*/
void VmbusChannelReleaseUnattachedChannels(void)
{
Expand Down
14 changes: 7 additions & 7 deletions drivers/staging/hv/Connection.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ struct VMBUS_CONNECTION gVmbusConnection = {
.NextGpadlHandle = ATOMIC_INIT(0xE1E10),
};

/**
/*
* VmbusConnect - Sends a connect request on the partition service connection
*/
int VmbusConnect(void)
Expand Down Expand Up @@ -180,7 +180,7 @@ int VmbusConnect(void)
return ret;
}

/**
/*
* VmbusDisconnect - Sends a disconnect request on the partition service connection
*/
int VmbusDisconnect(void)
Expand Down Expand Up @@ -218,7 +218,7 @@ int VmbusDisconnect(void)
return ret;
}

/**
/*
* GetChannelFromRelId - Get the channel object given its child relative id (ie channel id)
*/
struct vmbus_channel *GetChannelFromRelId(u32 relId)
Expand All @@ -239,7 +239,7 @@ struct vmbus_channel *GetChannelFromRelId(u32 relId)
return foundChannel;
}

/**
/*
* VmbusProcessChannelEvent - Process a channel event notification
*/
static void VmbusProcessChannelEvent(void *context)
Expand Down Expand Up @@ -267,7 +267,7 @@ static void VmbusProcessChannelEvent(void *context)
}
}

/**
/*
* VmbusOnEvents - Handler for events
*/
void VmbusOnEvents(void)
Expand Down Expand Up @@ -308,7 +308,7 @@ void VmbusOnEvents(void)
return;
}

/**
/*
* VmbusPostMessage - Send a msg on the vmbus's message connection
*/
int VmbusPostMessage(void *buffer, size_t bufferLen)
Expand All @@ -320,7 +320,7 @@ int VmbusPostMessage(void *buffer, size_t bufferLen)
return HvPostMessage(connId, 1, buffer, bufferLen);
}

/**
/*
* VmbusSetEvent - Send an event notification to the parent
*/
int VmbusSetEvent(u32 childRelId)
Expand Down
Loading

0 comments on commit 3e18951

Please sign in to comment.