Commit b7937dc4 authored by Christian Gromm's avatar Christian Gromm Committed by Greg Kroah-Hartman

staging: most: fix comment sections

This patch updates and corrects the comment sections of the code.
Signed-off-by: default avatarChristian Gromm <christian.gromm@microchip.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 6822ba8a
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/* /*
* cdev.c - Application interfacing module for character devices * cdev.c - Character device component for Mostcore
* *
* Copyright (C) 2013-2015 Microchip Technology Germany II GmbH & Co. KG * Copyright (C) 2013-2015 Microchip Technology Germany II GmbH & Co. KG
*/ */
...@@ -553,4 +553,4 @@ module_init(mod_init); ...@@ -553,4 +553,4 @@ module_init(mod_init);
module_exit(mod_exit); module_exit(mod_exit);
MODULE_AUTHOR("Christian Gromm <christian.gromm@microchip.com>"); MODULE_AUTHOR("Christian Gromm <christian.gromm@microchip.com>");
MODULE_LICENSE("GPL"); MODULE_LICENSE("GPL");
MODULE_DESCRIPTION("character device AIM for mostcore"); MODULE_DESCRIPTION("character device component for mostcore");
This diff is collapsed.
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/* /*
* most.h - Interface between MostCore, * most.h - API for component and adapter drivers
* Hardware Dependent Module (HDM) and Application Interface Module (AIM).
* *
* Copyright (C) 2013-2015, Microchip Technology Germany II GmbH & Co. KG * Copyright (C) 2013-2015, Microchip Technology Germany II GmbH & Co. KG
*/ */
/*
* Authors:
* Andrey Shvetsov <andrey.shvetsov@k2l.de>
* Christian Gromm <christian.gromm@microchip.com>
* Sebastian Graf
*/
#ifndef __MOST_CORE_H__ #ifndef __MOST_CORE_H__
#define __MOST_CORE_H__ #define __MOST_CORE_H__
...@@ -74,22 +66,22 @@ enum mbo_status_flags { ...@@ -74,22 +66,22 @@ enum mbo_status_flags {
* The value is bitwise OR-combination of the values from the * The value is bitwise OR-combination of the values from the
* enumeration most_channel_data_type. Zero is allowed value and means * enumeration most_channel_data_type. Zero is allowed value and means
* "channel may not be used". * "channel may not be used".
* @num_buffer_packet: Maximum number of buffers supported by this channel * @num_buffers_packet: Maximum number of buffers supported by this channel
* for packet data types (Async,Control,QoS) * for packet data types (Async,Control,QoS)
* @buffer_size_packet: Maximum buffer size supported by this channel * @buffer_size_packet: Maximum buffer size supported by this channel
* for packet data types (Async,Control,QoS) * for packet data types (Async,Control,QoS)
* @num_buffer_streaming: Maximum number of buffers supported by this channel * @num_buffers_streaming: Maximum number of buffers supported by this channel
* for streaming data types (Sync,AV Packetized) * for streaming data types (Sync,AV Packetized)
* @buffer_size_streaming: Maximum buffer size supported by this channel * @buffer_size_streaming: Maximum buffer size supported by this channel
* for streaming data types (Sync,AV Packetized) * for streaming data types (Sync,AV Packetized)
* @name_suffix: Optional suffix providean by an HDM that is attached to the * @name_suffix: Optional suffix providean by an HDM that is attached to the
* regular channel name. * regular channel name.
* *
* Describes the capabilities of a MostCore channel like supported Data Types * Describes the capabilities of a MOST channel like supported Data Types
* and directions. This information is provided by an HDM for the MostCore. * and directions. This information is provided by an HDM for the MostCore.
* *
* The Core creates read only sysfs attribute files in * The Core creates read only sysfs attribute files in
* /sys/devices/virtual/most/mostcore/devices/mdev-#/mdev#-ch#/ with the * /sys/devices/most/mdev#/<channel>/ with the
* following attributes: * following attributes:
* -available_directions * -available_directions
* -available_datatypes * -available_datatypes
...@@ -124,7 +116,7 @@ struct most_channel_capability { ...@@ -124,7 +116,7 @@ struct most_channel_capability {
* @packets_per_xact: number of MOST frames that are packet inside one USB * @packets_per_xact: number of MOST frames that are packet inside one USB
* packet. This is USB specific * packet. This is USB specific
* *
* Describes the configuration for a MostCore channel. This information is * Describes the configuration for a MOST channel. This information is
* provided from the MostCore to a HDM (like the Medusa PCIe Interface) as a * provided from the MostCore to a HDM (like the Medusa PCIe Interface) as a
* parameter of the "configure" function call. * parameter of the "configure" function call.
*/ */
...@@ -148,6 +140,7 @@ struct most_channel_config { ...@@ -148,6 +140,7 @@ struct most_channel_config {
* *
* @list: list head for use by the mbo's current owner * @list: list head for use by the mbo's current owner
* @ifp: (in) associated interface instance * @ifp: (in) associated interface instance
* @num_buffers_ptr: amount of pool buffers
* @hdm_channel_id: (in) HDM channel instance * @hdm_channel_id: (in) HDM channel instance
* @virt_address: (in) kernel virtual address of the buffer * @virt_address: (in) kernel virtual address of the buffer
* @bus_address: (in) bus address of the buffer * @bus_address: (in) bus address of the buffer
...@@ -156,15 +149,15 @@ struct most_channel_config { ...@@ -156,15 +149,15 @@ struct most_channel_config {
* @status: (out) transfer status * @status: (out) transfer status
* @complete: (in) completion routine * @complete: (in) completion routine
* *
* The MostCore allocates and initializes the MBO. * The core allocates and initializes the MBO.
* *
* The HDM receives MBO for transfer from MostCore with the call to enqueue(). * The HDM receives MBO for transfer from the core with the call to enqueue().
* The HDM copies the data to- or from the buffer depending on configured * The HDM copies the data to- or from the buffer depending on configured
* channel direction, set "processed_length" and "status" and completes * channel direction, set "processed_length" and "status" and completes
* the transfer procedure by calling the completion routine. * the transfer procedure by calling the completion routine.
* *
* At the end the MostCore deallocates the MBO or recycles it for further * Finally, the MBO is being deallocated or recycled for further
* transfers for the same or different HDM. * transfers of the same or a different HDM.
* *
* Directions of usage: * Directions of usage:
* The core driver should never access any MBO fields (even if marked * The core driver should never access any MBO fields (even if marked
...@@ -197,10 +190,12 @@ struct mbo { ...@@ -197,10 +190,12 @@ struct mbo {
/** /**
* Interface instance description. * Interface instance description.
* *
* Describes one instance of an interface like Medusa PCIe or Vantage USB. * Describes an interface of a MOST device the core driver is bound to.
* This structure is allocated and initialized in the HDM. MostCore may not * This structure is allocated and initialized in the HDM. MostCore may not
* modify this structure. * modify this structure.
* *
* @dev: the actual device
* @mod: module
* @interface Interface type. \sa most_interface_type. * @interface Interface type. \sa most_interface_type.
* @description PRELIMINARY. * @description PRELIMINARY.
* Unique description of the device instance from point of view of the * Unique description of the device instance from point of view of the
...@@ -255,13 +250,13 @@ struct most_interface { ...@@ -255,13 +250,13 @@ struct most_interface {
#define to_most_interface(d) container_of(d, struct most_interface, dev) #define to_most_interface(d) container_of(d, struct most_interface, dev)
/** /**
* struct most_aim - identifies MOST device driver to mostcore * struct core_component - identifies a loadable component for the mostcore
* @name: Driver name * @list: list_head
* @name: component name
* @probe_channel: function for core to notify driver about channel connection * @probe_channel: function for core to notify driver about channel connection
* @disconnect_channel: callback function to disconnect a certain channel * @disconnect_channel: callback function to disconnect a certain channel
* @rx_completion: completion handler for received packets * @rx_completion: completion handler for received packets
* @tx_completion: completion handler for transmitted packets * @tx_completion: completion handler for transmitted packets
* @context: context pointer to be used by mostcore
*/ */
struct core_component { struct core_component {
struct list_head list; struct list_head list;
......
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/* /*
* Networking component - Networking Application Interface Module for MostCore * net.c - Networking component for Mostcore
* *
* Copyright (C) 2015, Microchip Technology Germany II GmbH & Co. KG * Copyright (C) 2015, Microchip Technology Germany II GmbH & Co. KG
*/ */
...@@ -557,4 +557,4 @@ module_init(most_net_init); ...@@ -557,4 +557,4 @@ module_init(most_net_init);
module_exit(most_net_exit); module_exit(most_net_exit);
MODULE_LICENSE("GPL"); MODULE_LICENSE("GPL");
MODULE_AUTHOR("Andrey Shvetsov <andrey.shvetsov@k2l.de>"); MODULE_AUTHOR("Andrey Shvetsov <andrey.shvetsov@k2l.de>");
MODULE_DESCRIPTION("Networking Application Interface Module for MostCore"); MODULE_DESCRIPTION("Networking Component Module for Mostcore");
...@@ -755,4 +755,4 @@ module_exit(audio_exit); ...@@ -755,4 +755,4 @@ module_exit(audio_exit);
MODULE_LICENSE("GPL"); MODULE_LICENSE("GPL");
MODULE_AUTHOR("Christian Gromm <christian.gromm@microchip.com>"); MODULE_AUTHOR("Christian Gromm <christian.gromm@microchip.com>");
MODULE_DESCRIPTION("Audio Application Interface Module for MostCore"); MODULE_DESCRIPTION("Sound Component Module for Mostcore");
// SPDX-License-Identifier: GPL-2.0 // SPDX-License-Identifier: GPL-2.0
/* /*
* V4L2 Component - V4L2 Application Interface Module for MostCore * video.c - V4L2 component for Mostcore
* *
* Copyright (C) 2015, Microchip Technology Germany II GmbH & Co. KG * Copyright (C) 2015, Microchip Technology Germany II GmbH & Co. KG
*/ */
...@@ -604,6 +604,6 @@ static void __exit comp_exit(void) ...@@ -604,6 +604,6 @@ static void __exit comp_exit(void)
module_init(comp_init); module_init(comp_init);
module_exit(comp_exit); module_exit(comp_exit);
MODULE_DESCRIPTION("V4L2 Component Module for MostCore"); MODULE_DESCRIPTION("V4L2 Component Module for Mostcore");
MODULE_AUTHOR("Andrey Shvetsov <andrey.shvetsov@k2l.de>"); MODULE_AUTHOR("Andrey Shvetsov <andrey.shvetsov@k2l.de>");
MODULE_LICENSE("GPL"); MODULE_LICENSE("GPL");
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment