Skip to content

Commit 917f5ca

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 d9273ba commit 917f5ca

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
@@ -98,16 +98,6 @@ static adc_sample_state_reg_t map_channel_to_sample_state_reg(uint8_t channel_id
9898
return ADC_SAMPLE_STATE_CHANNEL_16_TO_31;
9999
}
100100

101-
/**
102-
* @brief Setup channels before starting to scan ADC
103-
*
104-
* @param dev RA ADC device
105-
* @param channel_cfg channel configuration
106-
*
107-
* @return 0 on success
108-
* @return -ENOTSUP if channel id or differential is wrong value
109-
* @return -EINVAL if channel configuration is invalid
110-
*/
111101
static int adc_ra_channel_setup(const struct device *dev, const struct adc_channel_cfg *channel_cfg)
112102
{
113103
fsp_err_t fsp_err = FSP_SUCCESS;
@@ -199,9 +189,6 @@ static void renesas_ra_adc_callback(adc_callback_args_t *p_args)
199189
}
200190
}
201191

202-
/**
203-
* Voltage reference covert handler
204-
*/
205192
static int adc_map_vref(const struct adc_ra_config *cfg, adc_extended_cfg_t *extend)
206193
{
207194
switch (cfg->variant) {
@@ -240,15 +227,6 @@ static int adc_map_vref(const struct adc_ra_config *cfg, adc_extended_cfg_t *ext
240227
}
241228
}
242229

243-
/**
244-
* @brief Check if buffer in @p sequence is big enough to hold all ADC samples
245-
*
246-
* @param dev RA ADC device
247-
* @param sequence ADC sequence description
248-
*
249-
* @return 0 on success
250-
* @return -ENOMEM if buffer is not big enough
251-
*/
252230
static int adc_ra_check_buffer_size(const struct device *dev, const struct adc_sequence *sequence)
253231
{
254232
uint8_t channels = 0;
@@ -268,19 +246,6 @@ static int adc_ra_check_buffer_size(const struct device *dev, const struct adc_s
268246
return 0;
269247
}
270248

271-
/**
272-
* @brief Start processing read request
273-
*
274-
* @param dev RA ADC device
275-
* @param sequence ADC sequence description
276-
*
277-
* @return 0 on success
278-
* @return -ENOTSUP if requested resolution or channel is out side of supported
279-
* range
280-
* @return -ENOMEM if buffer is not big enough
281-
* (see @ref adc_ra_check_buffer_size)
282-
* @return other error code returned by adc_context_wait_for_completion
283-
*/
284249
static int adc_ra_start_read(const struct device *dev, const struct adc_sequence *sequence)
285250
{
286251
const struct adc_ra_config *config = dev->config;
@@ -336,20 +301,6 @@ static int adc_ra_start_read(const struct device *dev, const struct adc_sequence
336301
return 0;
337302
}
338303

339-
/**
340-
* @brief Start processing read request asynchronously
341-
*
342-
* @param dev RA ADC device
343-
* @param sequence ADC sequence description
344-
* @param async async pointer to asynchronous signal
345-
*
346-
* @return 0 on success
347-
* @return -ENOTSUP if requested resolution or channel is out side of supported
348-
* range
349-
* @return -ENOMEM if buffer is not big enough
350-
* (see @ref adc_ra_check_buffer_size)
351-
* @return other error code returned by adc_context_wait_for_completion
352-
*/
353304
static int adc_ra_read_async(const struct device *dev, const struct adc_sequence *sequence,
354305
struct k_poll_signal *async)
355306
{
@@ -363,19 +314,6 @@ static int adc_ra_read_async(const struct device *dev, const struct adc_sequence
363314
return err;
364315
}
365316

366-
/**
367-
* @brief Start processing read request synchronously
368-
*
369-
* @param dev RA ADC device
370-
* @param sequence ADC sequence description
371-
*
372-
* @return 0 on success
373-
* @return -ENOTSUP if requested resolution or channel is out side of supported
374-
* range
375-
* @return -ENOMEM if buffer is not big enough
376-
* (see @ref adc_ra_check_buffer_size)
377-
* @return other error code returned by adc_context_wait_for_completion
378-
*/
379317
static int adc_ra_read(const struct device *dev, const struct adc_sequence *sequence)
380318
{
381319
return adc_ra_read_async(dev, sequence, NULL);
@@ -399,16 +337,6 @@ static void adc_context_update_buffer_pointer(struct adc_context *ctx, bool repe
399337
}
400338
}
401339

402-
/**
403-
* @brief Function called on init for each RA ADC device. It setups all
404-
* channels to return constant 0 mV and create acquisition thread.
405-
*
406-
* @param dev RA ADC device
407-
*
408-
* @return -EIO if error
409-
*
410-
* @return 0 on success
411-
*/
412340
static int adc_ra_init(const struct device *dev)
413341
{
414342
const struct adc_ra_config *config = dev->config;

0 commit comments

Comments
 (0)