Commit 98fbcbb1 authored by Dave Stevenson's avatar Dave Stevenson Committed by Greg Kroah-Hartman

staging: bcm2835-camera: Fix comment style violations.

Fix comment style violations in the header files.
Signed-off-by: default avatarDave Stevenson <dave.stevenson@raspberrypi.org>
Signed-off-by: default avatarStefan Wahren <wahrenst@gmx.net>
Acked-by: default avatarHans Verkuil <hverkuil-cisco@xs4all.nl>
Acked-by: default avatarMauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent be2f87c3
...@@ -19,22 +19,23 @@ ...@@ -19,22 +19,23 @@
/* MMAL_ES_FORMAT_T */ /* MMAL_ES_FORMAT_T */
struct mmal_audio_format { struct mmal_audio_format {
u32 channels; /**< Number of audio channels */ u32 channels; /* Number of audio channels */
u32 sample_rate; /**< Sample rate */ u32 sample_rate; /* Sample rate */
u32 bits_per_sample; /**< Bits per sample */ u32 bits_per_sample; /* Bits per sample */
u32 block_align; /**< Size of a block of data */ u32 block_align; /* Size of a block of data */
}; };
struct mmal_video_format { struct mmal_video_format {
u32 width; /**< Width of frame in pixels */ u32 width; /* Width of frame in pixels */
u32 height; /**< Height of frame in rows of pixels */ u32 height; /* Height of frame in rows of pixels */
struct mmal_rect crop; /**< Visible region of the frame */ struct mmal_rect crop; /* Visible region of the frame */
struct mmal_rational frame_rate; /**< Frame rate */ struct mmal_rational frame_rate; /* Frame rate */
struct mmal_rational par; /**< Pixel aspect ratio */ struct mmal_rational par; /* Pixel aspect ratio */
/* FourCC specifying the color space of the video stream. See the /*
* \ref MmalColorSpace "pre-defined color spaces" for some examples. * FourCC specifying the color space of the video stream. See the
* MmalColorSpace "pre-defined color spaces" for some examples.
*/ */
u32 color_space; u32 color_space;
}; };
...@@ -50,48 +51,56 @@ union mmal_es_specific_format { ...@@ -50,48 +51,56 @@ union mmal_es_specific_format {
struct mmal_subpicture_format subpicture; struct mmal_subpicture_format subpicture;
}; };
/** Definition of an elementary stream format (MMAL_ES_FORMAT_T) */ /* Definition of an elementary stream format (MMAL_ES_FORMAT_T) */
struct mmal_es_format_local { struct mmal_es_format_local {
u32 type; /* enum mmal_es_type */ u32 type; /* enum mmal_es_type */
u32 encoding; /* FourCC specifying encoding of the elementary stream.*/ u32 encoding; /* FourCC specifying encoding of the elementary
u32 encoding_variant; /* FourCC specifying the specific * stream.
* encoding variant of the elementary */
* stream. u32 encoding_variant; /* FourCC specifying the specific
*/ * encoding variant of the elementary
* stream.
union mmal_es_specific_format *es; /* Type specific */
* information for the
* elementary stream union mmal_es_specific_format *es; /* Type specific
*/ * information for the
* elementary stream
u32 bitrate; /**< Bitrate in bits per second */ */
u32 flags; /**< Flags describing properties of the elementary stream. */
u32 bitrate; /* Bitrate in bits per second */
u32 extradata_size; /**< Size of the codec specific data */ u32 flags; /* Flags describing properties of the elementary
u8 *extradata; /**< Codec specific data */ * stream.
*/
u32 extradata_size; /* Size of the codec specific data */
u8 *extradata; /* Codec specific data */
}; };
/** Remote definition of an elementary stream format (MMAL_ES_FORMAT_T) */ /* Remote definition of an elementary stream format (MMAL_ES_FORMAT_T) */
struct mmal_es_format { struct mmal_es_format {
u32 type; /* enum mmal_es_type */ u32 type; /* enum mmal_es_type */
u32 encoding; /* FourCC specifying encoding of the elementary stream.*/ u32 encoding; /* FourCC specifying encoding of the elementary
u32 encoding_variant; /* FourCC specifying the specific * stream.
* encoding variant of the elementary */
* stream. u32 encoding_variant; /* FourCC specifying the specific
*/ * encoding variant of the elementary
* stream.
*/
u32 es; /* Type specific u32 es; /* Type specific
* information for the * information for the
* elementary stream * elementary stream
*/ */
u32 bitrate; /**< Bitrate in bits per second */ u32 bitrate; /* Bitrate in bits per second */
u32 flags; /**< Flags describing properties of the elementary stream. */ u32 flags; /* Flags describing properties of the elementary
* stream.
*/
u32 extradata_size; /**< Size of the codec specific data */ u32 extradata_size; /* Size of the codec specific data */
u32 extradata; /**< Codec specific data */ u32 extradata; /* Codec specific data */
}; };
#endif /* MMAL_MSG_FORMAT_H */ #endif /* MMAL_MSG_FORMAT_H */
...@@ -13,28 +13,31 @@ ...@@ -13,28 +13,31 @@
/* MMAL_PORT_TYPE_T */ /* MMAL_PORT_TYPE_T */
enum mmal_port_type { enum mmal_port_type {
MMAL_PORT_TYPE_UNKNOWN = 0, /**< Unknown port type */ MMAL_PORT_TYPE_UNKNOWN = 0, /* Unknown port type */
MMAL_PORT_TYPE_CONTROL, /**< Control port */ MMAL_PORT_TYPE_CONTROL, /* Control port */
MMAL_PORT_TYPE_INPUT, /**< Input port */ MMAL_PORT_TYPE_INPUT, /* Input port */
MMAL_PORT_TYPE_OUTPUT, /**< Output port */ MMAL_PORT_TYPE_OUTPUT, /* Output port */
MMAL_PORT_TYPE_CLOCK, /**< Clock port */ MMAL_PORT_TYPE_CLOCK, /* Clock port */
}; };
/** The port is pass-through and doesn't need buffer headers allocated */ /* The port is pass-through and doesn't need buffer headers allocated */
#define MMAL_PORT_CAPABILITY_PASSTHROUGH 0x01 #define MMAL_PORT_CAPABILITY_PASSTHROUGH 0x01
/** The port wants to allocate the buffer payloads. /*
*The port wants to allocate the buffer payloads.
* This signals a preference that payload allocation should be done * This signals a preference that payload allocation should be done
* on this port for efficiency reasons. * on this port for efficiency reasons.
*/ */
#define MMAL_PORT_CAPABILITY_ALLOCATION 0x02 #define MMAL_PORT_CAPABILITY_ALLOCATION 0x02
/** The port supports format change events. /*
* The port supports format change events.
* This applies to input ports and is used to let the client know * This applies to input ports and is used to let the client know
* whether the port supports being reconfigured via a format * whether the port supports being reconfigured via a format
* change event (i.e. without having to disable the port). * change event (i.e. without having to disable the port).
*/ */
#define MMAL_PORT_CAPABILITY_SUPPORTS_EVENT_FORMAT_CHANGE 0x04 #define MMAL_PORT_CAPABILITY_SUPPORTS_EVENT_FORMAT_CHANGE 0x04
/* mmal port structure (MMAL_PORT_T) /*
* mmal port structure (MMAL_PORT_T)
* *
* most elements are informational only, the pointer values for * most elements are informational only, the pointer values for
* interogation messages are generally provided as additional * interogation messages are generally provided as additional
...@@ -42,50 +45,50 @@ enum mmal_port_type { ...@@ -42,50 +45,50 @@ enum mmal_port_type {
* buffer_num, buffer_size and userdata parameters are writable. * buffer_num, buffer_size and userdata parameters are writable.
*/ */
struct mmal_port { struct mmal_port {
u32 priv; /* Private member used by the framework */ u32 priv; /* Private member used by the framework */
u32 name; /* Port name. Used for debugging purposes (RO) */ u32 name; /* Port name. Used for debugging purposes (RO) */
u32 type; /* Type of the port (RO) enum mmal_port_type */ u32 type; /* Type of the port (RO) enum mmal_port_type */
u16 index; /* Index of the port in its type list (RO) */ u16 index; /* Index of the port in its type list (RO) */
u16 index_all; /* Index of the port in the list of all ports (RO) */ u16 index_all; /* Index of the port in the list of all ports (RO) */
u32 is_enabled; /* Indicates whether the port is enabled or not (RO) */ u32 is_enabled; /* Indicates whether the port is enabled or not (RO) */
u32 format; /* Format of the elementary stream */ u32 format; /* Format of the elementary stream */
u32 buffer_num_min; /* Minimum number of buffers the port u32 buffer_num_min; /* Minimum number of buffers the port
* requires (RO). This is set by the * requires (RO). This is set by the
* component. * component.
*/ */
u32 buffer_size_min; /* Minimum size of buffers the port u32 buffer_size_min; /* Minimum size of buffers the port
* requires (RO). This is set by the * requires (RO). This is set by the
* component. * component.
*/ */
u32 buffer_alignment_min; /* Minimum alignment requirement for u32 buffer_alignment_min;/* Minimum alignment requirement for
* the buffers (RO). A value of * the buffers (RO). A value of
* zero means no special alignment * zero means no special alignment
* requirements. This is set by the * requirements. This is set by the
* component. * component.
*/ */
u32 buffer_num_recommended; /* Number of buffers the port u32 buffer_num_recommended; /* Number of buffers the port
* recommends for optimal * recommends for optimal
* performance (RO). A value of * performance (RO). A value of
* zero means no special * zero means no special
* recommendation. This is set * recommendation. This is set
* by the component. * by the component.
*/ */
u32 buffer_size_recommended; /* Size of buffers the port u32 buffer_size_recommended; /* Size of buffers the port
* recommends for optimal * recommends for optimal
* performance (RO). A value of * performance (RO). A value of
* zero means no special * zero means no special
* recommendation. This is set * recommendation. This is set
* by the component. * by the component.
*/ */
u32 buffer_num; /* Actual number of buffers the port will use. u32 buffer_num; /* Actual number of buffers the port will use.
* This is set by the client. * This is set by the client.
*/ */
...@@ -94,14 +97,13 @@ struct mmal_port { ...@@ -94,14 +97,13 @@ struct mmal_port {
* the client. * the client.
*/ */
u32 component; /* Component this port belongs to (Read Only) */ u32 component; /* Component this port belongs to (Read Only) */
u32 userdata; /* Field reserved for use by the client */
u32 capabilities; /* Flags describing the capabilities of a u32 userdata; /* Field reserved for use by the client */
* port (RO). Bitwise combination of \ref
* portcapabilities "Port capabilities"
* values.
*/
u32 capabilities; /* Flags describing the capabilities of a
* port (RO). Bitwise combination of \ref
* portcapabilities "Port capabilities"
* values.
*/
}; };
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