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,11 +51,13 @@ union mmal_es_specific_format { ...@@ -50,11 +51,13 @@ 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
* stream.
*/
u32 encoding_variant; /* FourCC specifying the specific u32 encoding_variant; /* FourCC specifying the specific
* encoding variant of the elementary * encoding variant of the elementary
* stream. * stream.
...@@ -65,18 +68,22 @@ struct mmal_es_format_local { ...@@ -65,18 +68,22 @@ struct mmal_es_format_local {
* 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 */
u8 *extradata; /**< 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
* stream.
*/
u32 encoding_variant; /* FourCC specifying the specific u32 encoding_variant; /* FourCC specifying the specific
* encoding variant of the elementary * encoding variant of the elementary
* stream. * stream.
...@@ -87,11 +94,13 @@ struct mmal_es_format { ...@@ -87,11 +94,13 @@ struct mmal_es_format {
* 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
...@@ -62,7 +65,7 @@ struct mmal_port { ...@@ -62,7 +65,7 @@ struct mmal_port {
* 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
...@@ -103,5 +106,4 @@ struct mmal_port { ...@@ -103,5 +106,4 @@ struct mmal_port {
* portcapabilities "Port capabilities" * portcapabilities "Port capabilities"
* values. * values.
*/ */
}; };
...@@ -11,7 +11,8 @@ ...@@ -11,7 +11,8 @@
* Luke Diamand @ Broadcom * Luke Diamand @ Broadcom
*/ */
/* all the data structures which serialise the MMAL protocol. note /*
* all the data structures which serialise the MMAL protocol. note
* these are directly mapped onto the recived message data. * these are directly mapped onto the recived message data.
* *
* BEWARE: They seem to *assume* pointers are u32 and that there is no * BEWARE: They seem to *assume* pointers are u32 and that there is no
...@@ -79,13 +80,13 @@ enum mmal_msg_port_action_type { ...@@ -79,13 +80,13 @@ enum mmal_msg_port_action_type {
struct mmal_msg_header { struct mmal_msg_header {
u32 magic; u32 magic;
u32 type; /** enum mmal_msg_type */ u32 type; /* enum mmal_msg_type */
/* Opaque handle to the control service */ /* Opaque handle to the control service */
u32 control_service; u32 control_service;
u32 context; /** a u32 per message context */ u32 context; /* a u32 per message context */
u32 status; /** The status of the vchiq operation */ u32 status; /* The status of the vchiq operation */
u32 padding; u32 padding;
}; };
...@@ -121,7 +122,7 @@ struct mmal_msg_component_destroy { ...@@ -121,7 +122,7 @@ struct mmal_msg_component_destroy {
}; };
struct mmal_msg_component_destroy_reply { struct mmal_msg_component_destroy_reply {
u32 status; /** The component destruction status */ u32 status; /* The component destruction status */
}; };
/* request and reply to VC to enable a component */ /* request and reply to VC to enable a component */
...@@ -130,7 +131,7 @@ struct mmal_msg_component_enable { ...@@ -130,7 +131,7 @@ struct mmal_msg_component_enable {
}; };
struct mmal_msg_component_enable_reply { struct mmal_msg_component_enable_reply {
u32 status; /** The component enable status */ u32 status; /* The component enable status */
}; };
/* request and reply to VC to disable a component */ /* request and reply to VC to disable a component */
...@@ -139,7 +140,7 @@ struct mmal_msg_component_disable { ...@@ -139,7 +140,7 @@ struct mmal_msg_component_disable {
}; };
struct mmal_msg_component_disable_reply { struct mmal_msg_component_disable_reply {
u32 status; /** The component disable status */ u32 status; /* The component disable status */
}; };
/* request to VC to get port information */ /* request to VC to get port information */
...@@ -151,12 +152,12 @@ struct mmal_msg_port_info_get { ...@@ -151,12 +152,12 @@ struct mmal_msg_port_info_get {
/* reply from VC to get port info request */ /* reply from VC to get port info request */
struct mmal_msg_port_info_get_reply { struct mmal_msg_port_info_get_reply {
u32 status; /** enum mmal_msg_status */ u32 status; /* enum mmal_msg_status */
u32 component_handle; /* component handle port is associated with */ u32 component_handle; /* component handle port is associated with */
u32 port_type; /* enum mmal_msg_port_type */ u32 port_type; /* enum mmal_msg_port_type */
u32 port_index; /* port indexed in query */ u32 port_index; /* port indexed in query */
s32 found; /* unused */ s32 found; /* unused */
u32 port_handle; /**< Handle to use for this port */ u32 port_handle; /* Handle to use for this port */
struct mmal_port port; struct mmal_port port;
struct mmal_es_format format; /* elementary stream format */ struct mmal_es_format format; /* elementary stream format */
union mmal_es_specific_format es; /* es type specific data */ union mmal_es_specific_format es; /* es type specific data */
...@@ -181,7 +182,7 @@ struct mmal_msg_port_info_set_reply { ...@@ -181,7 +182,7 @@ struct mmal_msg_port_info_set_reply {
u32 port_type; /* enum mmal_msg_port_type */ u32 port_type; /* enum mmal_msg_port_type */
u32 index; /* port indexed in query */ u32 index; /* port indexed in query */
s32 found; /* unused */ s32 found; /* unused */
u32 port_handle; /**< Handle to use for this port */ u32 port_handle; /* Handle to use for this port */
struct mmal_port port; struct mmal_port port;
struct mmal_es_format format; struct mmal_es_format format;
union mmal_es_specific_format es; union mmal_es_specific_format es;
...@@ -206,44 +207,47 @@ struct mmal_msg_port_action_handle { ...@@ -206,44 +207,47 @@ struct mmal_msg_port_action_handle {
}; };
struct mmal_msg_port_action_reply { struct mmal_msg_port_action_reply {
u32 status; /** The port action operation status */ u32 status; /* The port action operation status */
}; };
/* MMAL buffer transfer */ /* MMAL buffer transfer */
/** Size of space reserved in a buffer message for short messages. */ /* Size of space reserved in a buffer message for short messages. */
#define MMAL_VC_SHORT_DATA 128 #define MMAL_VC_SHORT_DATA 128
/** Signals that the current payload is the end of the stream of data */ /* Signals that the current payload is the end of the stream of data */
#define MMAL_BUFFER_HEADER_FLAG_EOS BIT(0) #define MMAL_BUFFER_HEADER_FLAG_EOS BIT(0)
/** Signals that the start of the current payload starts a frame */ /* Signals that the start of the current payload starts a frame */
#define MMAL_BUFFER_HEADER_FLAG_FRAME_START BIT(1) #define MMAL_BUFFER_HEADER_FLAG_FRAME_START BIT(1)
/** Signals that the end of the current payload ends a frame */ /* Signals that the end of the current payload ends a frame */
#define MMAL_BUFFER_HEADER_FLAG_FRAME_END BIT(2) #define MMAL_BUFFER_HEADER_FLAG_FRAME_END BIT(2)
/** Signals that the current payload contains only complete frames (>1) */ /* Signals that the current payload contains only complete frames (>1) */
#define MMAL_BUFFER_HEADER_FLAG_FRAME \ #define MMAL_BUFFER_HEADER_FLAG_FRAME \
(MMAL_BUFFER_HEADER_FLAG_FRAME_START|MMAL_BUFFER_HEADER_FLAG_FRAME_END) (MMAL_BUFFER_HEADER_FLAG_FRAME_START|MMAL_BUFFER_HEADER_FLAG_FRAME_END)
/** Signals that the current payload is a keyframe (i.e. self decodable) */ /* Signals that the current payload is a keyframe (i.e. self decodable) */
#define MMAL_BUFFER_HEADER_FLAG_KEYFRAME BIT(3) #define MMAL_BUFFER_HEADER_FLAG_KEYFRAME BIT(3)
/** Signals a discontinuity in the stream of data (e.g. after a seek). /*
* Signals a discontinuity in the stream of data (e.g. after a seek).
* Can be used for instance by a decoder to reset its state * Can be used for instance by a decoder to reset its state
*/ */
#define MMAL_BUFFER_HEADER_FLAG_DISCONTINUITY BIT(4) #define MMAL_BUFFER_HEADER_FLAG_DISCONTINUITY BIT(4)
/** Signals a buffer containing some kind of config data for the component /*
* Signals a buffer containing some kind of config data for the component
* (e.g. codec config data) * (e.g. codec config data)
*/ */
#define MMAL_BUFFER_HEADER_FLAG_CONFIG BIT(5) #define MMAL_BUFFER_HEADER_FLAG_CONFIG BIT(5)
/** Signals an encrypted payload */ /* Signals an encrypted payload */
#define MMAL_BUFFER_HEADER_FLAG_ENCRYPTED BIT(6) #define MMAL_BUFFER_HEADER_FLAG_ENCRYPTED BIT(6)
/** Signals a buffer containing side information */ /* Signals a buffer containing side information */
#define MMAL_BUFFER_HEADER_FLAG_CODECSIDEINFO BIT(7) #define MMAL_BUFFER_HEADER_FLAG_CODECSIDEINFO BIT(7)
/** Signals a buffer which is the snapshot/postview image from a stills /*
* Signals a buffer which is the snapshot/postview image from a stills
* capture * capture
*/ */
#define MMAL_BUFFER_HEADER_FLAGS_SNAPSHOT BIT(8) #define MMAL_BUFFER_HEADER_FLAGS_SNAPSHOT BIT(8)
/** Signals a buffer which contains data known to be corrupted */ /* Signals a buffer which contains data known to be corrupted */
#define MMAL_BUFFER_HEADER_FLAG_CORRUPTED BIT(9) #define MMAL_BUFFER_HEADER_FLAG_CORRUPTED BIT(9)
/** Signals that a buffer failed to be transmitted */ /* Signals that a buffer failed to be transmitted */
#define MMAL_BUFFER_HEADER_FLAG_TRANSMISSION_FAILED BIT(10) #define MMAL_BUFFER_HEADER_FLAG_TRANSMISSION_FAILED BIT(10)
struct mmal_driver_buffer { struct mmal_driver_buffer {
...@@ -281,7 +285,8 @@ struct mmal_buffer_header_type_specific { ...@@ -281,7 +285,8 @@ struct mmal_buffer_header_type_specific {
}; };
struct mmal_msg_buffer_from_host { struct mmal_msg_buffer_from_host {
/* The front 32 bytes of the buffer header are copied /*
*The front 32 bytes of the buffer header are copied
* back to us in the reply to allow for context. This * back to us in the reply to allow for context. This
* area is used to store two mmal_driver_buffer structures to * area is used to store two mmal_driver_buffer structures to
* allow for multiple concurrent service users. * allow for multiple concurrent service users.
...@@ -296,7 +301,7 @@ struct mmal_msg_buffer_from_host { ...@@ -296,7 +301,7 @@ struct mmal_msg_buffer_from_host {
s32 is_zero_copy; s32 is_zero_copy;
s32 has_reference; s32 has_reference;
/** allows short data to be xfered in control message */ /* allows short data to be xfered in control message */
u32 payload_in_message; u32 payload_in_message;
u8 short_data[MMAL_VC_SHORT_DATA]; u8 short_data[MMAL_VC_SHORT_DATA];
}; };
......
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