Skip to content

Commit e3decfe

Browse files
Thinh Le Congduynguyenxa
authored andcommitted
drivers: adc: Remove doxygen comment blocks
Remove all doxygen comment blocks on driver Signed-off-by: Thinh Le Cong <[email protected]>
1 parent 436ad96 commit e3decfe

File tree

1 file changed

+0
-72
lines changed

1 file changed

+0
-72
lines changed

drivers/adc/adc_renesas_ra.c

Lines changed: 0 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -103,16 +103,6 @@ static adc_sample_state_reg_t map_channel_to_sample_state_reg(uint8_t channel_id
103103
return ADC_SAMPLE_STATE_CHANNEL_16_TO_31;
104104
}
105105

106-
/**
107-
* @brief Setup channels before starting to scan ADC
108-
*
109-
* @param dev RA ADC device
110-
* @param channel_cfg channel configuration
111-
*
112-
* @return 0 on success
113-
* @return -ENOTSUP if channel id or differential is wrong value
114-
* @return -EINVAL if channel configuration is invalid
115-
*/
116106
static int adc_ra_channel_setup(const struct device *dev, const struct adc_channel_cfg *channel_cfg)
117107
{
118108
fsp_err_t fsp_err = FSP_SUCCESS;
@@ -204,9 +194,6 @@ static void renesas_ra_adc_callback(adc_callback_args_t *p_args)
204194
}
205195
}
206196

207-
/**
208-
* Voltage reference covert handler
209-
*/
210197
static int adc_map_vref(const struct adc_ra_config *cfg, adc_extended_cfg_t *extend)
211198
{
212199
switch (cfg->variant) {
@@ -245,15 +232,6 @@ static int adc_map_vref(const struct adc_ra_config *cfg, adc_extended_cfg_t *ext
245232
}
246233
}
247234

248-
/**
249-
* @brief Check if buffer in @p sequence is big enough to hold all ADC samples
250-
*
251-
* @param dev RA ADC device
252-
* @param sequence ADC sequence description
253-
*
254-
* @return 0 on success
255-
* @return -ENOMEM if buffer is not big enough
256-
*/
257235
static int adc_ra_check_buffer_size(const struct device *dev, const struct adc_sequence *sequence)
258236
{
259237
uint8_t channels = 0;
@@ -273,19 +251,6 @@ static int adc_ra_check_buffer_size(const struct device *dev, const struct adc_s
273251
return 0;
274252
}
275253

276-
/**
277-
* @brief Start processing read request
278-
*
279-
* @param dev RA ADC device
280-
* @param sequence ADC sequence description
281-
*
282-
* @return 0 on success
283-
* @return -ENOTSUP if requested resolution or channel is out side of supported
284-
* range
285-
* @return -ENOMEM if buffer is not big enough
286-
* (see @ref adc_ra_check_buffer_size)
287-
* @return other error code returned by adc_context_wait_for_completion
288-
*/
289254
static int adc_ra_start_read(const struct device *dev, const struct adc_sequence *sequence)
290255
{
291256
const struct adc_ra_config *config = dev->config;
@@ -341,20 +306,6 @@ static int adc_ra_start_read(const struct device *dev, const struct adc_sequence
341306
return 0;
342307
}
343308

344-
/**
345-
* @brief Start processing read request asynchronously
346-
*
347-
* @param dev RA ADC device
348-
* @param sequence ADC sequence description
349-
* @param async async pointer to asynchronous signal
350-
*
351-
* @return 0 on success
352-
* @return -ENOTSUP if requested resolution or channel is out side of supported
353-
* range
354-
* @return -ENOMEM if buffer is not big enough
355-
* (see @ref adc_ra_check_buffer_size)
356-
* @return other error code returned by adc_context_wait_for_completion
357-
*/
358309
static int adc_ra_read_async(const struct device *dev, const struct adc_sequence *sequence,
359310
struct k_poll_signal *async)
360311
{
@@ -368,19 +319,6 @@ static int adc_ra_read_async(const struct device *dev, const struct adc_sequence
368319
return err;
369320
}
370321

371-
/**
372-
* @brief Start processing read request synchronously
373-
*
374-
* @param dev RA ADC device
375-
* @param sequence ADC sequence description
376-
*
377-
* @return 0 on success
378-
* @return -ENOTSUP if requested resolution or channel is out side of supported
379-
* range
380-
* @return -ENOMEM if buffer is not big enough
381-
* (see @ref adc_ra_check_buffer_size)
382-
* @return other error code returned by adc_context_wait_for_completion
383-
*/
384322
static int adc_ra_read(const struct device *dev, const struct adc_sequence *sequence)
385323
{
386324
return adc_ra_read_async(dev, sequence, NULL);
@@ -404,16 +342,6 @@ static void adc_context_update_buffer_pointer(struct adc_context *ctx, bool repe
404342
}
405343
}
406344

407-
/**
408-
* @brief Function called on init for each RA ADC device. It setups all
409-
* channels to return constant 0 mV and create acquisition thread.
410-
*
411-
* @param dev RA ADC device
412-
*
413-
* @return -EIO if error
414-
*
415-
* @return 0 on success
416-
*/
417345
static int adc_ra_init(const struct device *dev)
418346
{
419347
const struct adc_ra_config *config = dev->config;

0 commit comments

Comments
 (0)