ad_sdadc.h File Reference

SDADC adapter API. More...

#include "ad.h"
#include "hw_gpio.h"
#include "hw_sdadc.h"
#include "osal.h"
#include "resmgmt.h"

Go to the source code of this file.

Data Structures
struct	ad_sdadc_io_conf
	SDADC I/O configuration. More...
struct	ad_sdadc_controller_conf
	SDADC controller configuration. More...

Macros
#define	HW_SDADC   ((void *)SDADC_BASE)
	SDADC Id.

Typedefs
typedef struct ad_sdadc_io_conf	ad_sdadc_io_conf_t
	SDADC I/O configuration.
typedef hw_sdadc_config_t	ad_sdadc_driver_conf_t
	SDADC driver configuration. More...
typedef struct ad_sdadc_controller_conf	ad_sdadc_controller_conf_t
	SDADC controller configuration. More...
typedef void *	ad_sdadc_handle_t
	SDADC Handle returned by ad_sdadc_open()
typedef void(*	ad_sdadc_user_cb) (void *user_data, uint32_t conversions)
	Asynchronous callback function. More...

Enumerations
enum	AD_SDADC_ERROR
	Error Codes. More...

Functions
void	ad_sdadc_init (void)
	Initialize SDADC adapter and some required variables. More...
ad_sdadc_handle_t	ad_sdadc_open (const ad_sdadc_controller_conf_t *conf)
	Open SDADC controller. More...
int	ad_sdadc_reconfig (const ad_sdadc_handle_t handle, const ad_sdadc_driver_conf_t *drv)
	Reconfigure SDADC controller. More...
int	ad_sdadc_close (const ad_sdadc_handle_t handle, bool forced)
	Close SDADC controller. More...
int	ad_sdadc_io_config (const HW_SDADC_ID id, const ad_sdadc_io_conf_t *io, AD_IO_CONF_STATE state)
	Initialize controller pins to on / off io configuration. More...
int	ad_sdadc_read_async (const ad_sdadc_handle_t handle, uint32_t nof_conv, uint16_t *outbuf, ad_sdadc_user_cb read_async_cb, void *user_data)
	Read asynchronously nof_conv conversions from the selected source. More...
int	ad_sdadc_read (const ad_sdadc_handle_t handle, uint32_t nof_conv, uint16_t *outbuf)
	Read synchronously nof_conv conversions from the selected source. More...
__STATIC_FORCEINLINE int32_t	ad_sdadc_conv_to_mvolt (const ad_sdadc_controller_conf_t *conf, uint32_t raw_value)
	Convert raw value read from SDADC to voltage in mV. The same configuration which was used to obtain the adc_value is needed for the conversion. More...
__STATIC_FORCEINLINE void	ad_sdadc_store_ext_ref_calibration_values (int16_t gain, int16_t offset)
	Store external reference voltage calibration values. More...

Detailed Description

SDADC adapter API.

Copyright (C) 2015-2023 Renesas Electronics Corporation and/or its affiliates. All rights reserved. Confidential Information.

This software ("Software") is supplied by Renesas Electronics Corporation and/or its affiliates ("Renesas"). Renesas grants you a personal, non-exclusive, non-transferable, revocable, non-sub-licensable right and license to use the Software, solely if used in or together with Renesas products. You may make copies of this Software, provided this copyright notice and disclaimer ("Notice") is included in all such copies. Renesas reserves the right to change or discontinue the Software at any time without notice.

THE SOFTWARE IS PROVIDED "AS IS". RENESAS DISCLAIMS ALL WARRANTIES OF ANY KIND, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. TO THE MAXIMUM EXTENT PERMITTED UNDER LAW, IN NO EVENT SHALL RENESAS BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE, EVEN IF RENESAS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. USE OF THIS SOFTWARE MAY BE SUBJECT TO TERMS AND CONDITIONS CONTAINED IN AN ADDITIONAL AGREEMENT BETWEEN YOU AND RENESAS. IN CASE OF CONFLICT BETWEEN THE TERMS OF THIS NOTICE AND ANY SUCH ADDITIONAL LICENSE AGREEMENT, THE TERMS OF THE AGREEMENT SHALL TAKE PRECEDENCE. BY CONTINUING TO USE THIS SOFTWARE, YOU AGREE TO THE TERMS OF THIS NOTICE.IF YOU DO NOT AGREE TO THESE TERMS, YOU ARE NOT PERMITTED TO USE THIS SOFTWARE.