Update comments

This commit is contained in:
kkitayam 2021-09-29 22:59:46 +09:00
parent 9bcab53c2c
commit 4ca466b00b
2 changed files with 11 additions and 8 deletions

View File

@ -554,6 +554,7 @@ static bool _open_vs_itf(uint8_t rhport, videod_streaming_interface_t *stm, uint
return true;
}
/** Prepare the next packet payload. */
static uint_fast16_t _prepare_in_payload(videod_streaming_interface_t *stm)
{
uint_fast16_t remaining = stm->bufsize - stm->offset;
@ -857,7 +858,6 @@ static int handle_video_stm_req(uint8_t rhport, uint8_t stage,
// APPLICATION API
//--------------------------------------------------------------------+
/* ctl_idx instance number of video control interface */
bool tud_video_n_connected(uint_fast8_t ctl_idx)
{
TU_ASSERT(ctl_idx < CFG_TUD_VIDEO);
@ -867,8 +867,6 @@ bool tud_video_n_connected(uint_fast8_t ctl_idx)
return false;
}
/* ctl_idx instance number of video control interface
* stm_idx index number of streaming interface as per video control */
bool tud_video_n_streaming(uint_fast8_t ctl_idx, uint_fast8_t stm_idx)
{
TU_ASSERT(ctl_idx < CFG_TUD_VIDEO);

View File

@ -39,11 +39,15 @@ extern "C" {
// Application API (Multiple Ports)
// CFG_TUD_VIDEO > 1
//--------------------------------------------------------------------+
/* ctl_idx instance number of control interface
* stm_idx instance number of streaming interface */
/** Return true if streaming
*
* @param[in] ctl_idx Destination control interface index
* @param[in] stm_idx Destination streaming interface index */
bool tud_video_n_streaming(uint_fast8_t ctl_idx, uint_fast8_t stm_idx);
/**
/** Transfer a frame
*
* @param[in] ctl_idx Destination control interface index
* @param[in] stm_idx Destination streaming interface index
* @param[in] buffer Frame buffer. The caller must not use this buffer until the operation is completed.
@ -70,8 +74,9 @@ TU_ATTR_WEAK int tud_video_power_mode_cb(uint_fast8_t ctl_idx, uint8_t power_mod
/** Invoked when VS_COMMIT_CONTROL(SET_CUR) request received
*
* @param[in] ctl_idx Destination control interface index
* @param[in] stm_idx Destination streaming interface index
* @param[in] ctl_idx Destination control interface index
* @param[in] stm_idx Destination streaming interface index
* @param[in] parameters Video streaming parameters
* @return video_error_code_t */
TU_ATTR_WEAK int tud_video_commit_cb(uint_fast8_t ctl_idx, uint_fast8_t stm_idx,
video_probe_and_commit_control_t const *parameters);