Skip to content

Commit 3dabfb2

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 2d19154 commit 3dabfb2

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
@@ -89,16 +89,6 @@ struct adc_ra_data {
8989
struct k_sem calibrate_sem;
9090
};
9191

92-
/**
93-
* @brief Setup channels before starting to scan ADC
94-
*
95-
* @param dev RA ADC device
96-
* @param channel_cfg channel configuration
97-
*
98-
* @return 0 on success
99-
* @return -ENOTSUP if channel id or differential is wrong value
100-
* @return -EINVAL if channel configuration is invalid
101-
*/
10292
static int adc_ra_channel_setup(const struct device *dev, const struct adc_channel_cfg *channel_cfg)
10393
{
10494
fsp_err_t fsp_err = FSP_SUCCESS;
@@ -176,9 +166,6 @@ static void renesas_ra_adc_callback(adc_callback_args_t *p_args)
176166
}
177167
}
178168

179-
/**
180-
* Voltage reference covert handler
181-
*/
182169
static int adc_map_vref(const struct adc_ra_config *cfg, adc_extended_cfg_t *extend)
183170
{
184171
switch (cfg->variant) {
@@ -217,15 +204,6 @@ static int adc_map_vref(const struct adc_ra_config *cfg, adc_extended_cfg_t *ext
217204
}
218205
}
219206

220-
/**
221-
* @brief Check if buffer in @p sequence is big enough to hold all ADC samples
222-
*
223-
* @param dev RA ADC device
224-
* @param sequence ADC sequence description
225-
*
226-
* @return 0 on success
227-
* @return -ENOMEM if buffer is not big enough
228-
*/
229207
static int adc_ra_check_buffer_size(const struct device *dev, const struct adc_sequence *sequence)
230208
{
231209
uint8_t channels = 0;
@@ -245,19 +223,6 @@ static int adc_ra_check_buffer_size(const struct device *dev, const struct adc_s
245223
return 0;
246224
}
247225

248-
/**
249-
* @brief Start processing read request
250-
*
251-
* @param dev RA ADC device
252-
* @param sequence ADC sequence description
253-
*
254-
* @return 0 on success
255-
* @return -ENOTSUP if requested resolution or channel is out side of supported
256-
* range
257-
* @return -ENOMEM if buffer is not big enough
258-
* (see @ref adc_ra_check_buffer_size)
259-
* @return other error code returned by adc_context_wait_for_completion
260-
*/
261226
static int adc_ra_start_read(const struct device *dev, const struct adc_sequence *sequence)
262227
{
263228
const struct adc_ra_config *config = dev->config;
@@ -313,20 +278,6 @@ static int adc_ra_start_read(const struct device *dev, const struct adc_sequence
313278
return 0;
314279
}
315280

316-
/**
317-
* @brief Start processing read request asynchronously
318-
*
319-
* @param dev RA ADC device
320-
* @param sequence ADC sequence description
321-
* @param async async pointer to asynchronous signal
322-
*
323-
* @return 0 on success
324-
* @return -ENOTSUP if requested resolution or channel is out side of supported
325-
* range
326-
* @return -ENOMEM if buffer is not big enough
327-
* (see @ref adc_ra_check_buffer_size)
328-
* @return other error code returned by adc_context_wait_for_completion
329-
*/
330281
static int adc_ra_read_async(const struct device *dev, const struct adc_sequence *sequence,
331282
struct k_poll_signal *async)
332283
{
@@ -340,19 +291,6 @@ static int adc_ra_read_async(const struct device *dev, const struct adc_sequence
340291
return err;
341292
}
342293

343-
/**
344-
* @brief Start processing read request synchronously
345-
*
346-
* @param dev RA ADC device
347-
* @param sequence ADC sequence description
348-
*
349-
* @return 0 on success
350-
* @return -ENOTSUP if requested resolution or channel is out side of supported
351-
* range
352-
* @return -ENOMEM if buffer is not big enough
353-
* (see @ref adc_ra_check_buffer_size)
354-
* @return other error code returned by adc_context_wait_for_completion
355-
*/
356294
static int adc_ra_read(const struct device *dev, const struct adc_sequence *sequence)
357295
{
358296
return adc_ra_read_async(dev, sequence, NULL);
@@ -376,16 +314,6 @@ static void adc_context_update_buffer_pointer(struct adc_context *ctx, bool repe
376314
}
377315
}
378316

379-
/**
380-
* @brief Function called on init for each RA ADC device. It setups all
381-
* channels to return constant 0 mV and create acquisition thread.
382-
*
383-
* @param dev RA ADC device
384-
*
385-
* @return -EIO if error
386-
*
387-
* @return 0 on success
388-
*/
389317
static int adc_ra_init(const struct device *dev)
390318
{
391319
const struct adc_ra_config *config = dev->config;

0 commit comments

Comments
 (0)