iot_adc.h

Go to the documentation of this file.

/*
 * FreeRTOS Common IO V1.0.0
 * Copyright (C) 2019 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */

#ifndef _IOT_ADC_H_
#define _IOT_ADC_H_

#define IOT_ADC_SUCCESS                   ( 0 )     
#define IOT_ADC_FAILED                    ( 1 )     
#define IOT_ADC_INVALID_VALUE             ( 2 )     
#define IOT_ADC_NOT_OPEN                  ( 3 )     
#define IOT_ADC_FUNCTION_NOT_SUPPORTED    ( 4 )     
#define IOT_ADC_CH_BUSY                   ( 5 )     
struct IotAdcDescriptor;

typedef struct IotAdcDescriptor * IotAdcHandle_t;

typedef void ( * IotAdcCallback_t )( uint16_t * pusConvertedData,
                                     void * pvUserContext );

IotAdcHandle_t iot_adc_open( int32_t lAdc );

int32_t iot_adc_close( IotAdcHandle_t const pxAdc );

void iot_adc_set_callback( IotAdcHandle_t const pxAdc,
                           uint8_t ucAdcChannel,
                           IotAdcCallback_t xAdcCallback,
                           void * pvUserContext );

int32_t iot_adc_start( IotAdcHandle_t const pxAdc,
                       uint8_t ucAdcChannel );

int32_t iot_adc_stop( IotAdcHandle_t const pxAdc,
                      uint8_t ucAdcChannel );

int32_t iot_adc_read_sample( IotAdcHandle_t const pxAdc,
                             uint8_t ucAdcChannel,
                             uint16_t * pusAdcSample );

typedef struct IotAdcConfig_s
{
    uint32_t ulAdcSampleTime; 
    uint8_t ucAdcResolution;  
} IotAdcConfig_t;

typedef enum
{
    eChStateIdle,     
    eChStateBusy,     
} IotAdcChState_t;

typedef struct IotAdcChStatus_s
{
    uint8_t ucAdcChannel;           
    IotAdcChState_t xAdcChState;    
} IotAdcChStatus_t;

typedef struct IotAdcChBuffer_s
{
    uint8_t ucAdcChannel;    
    void * pvBuffer;         
    uint8_t ucBufLen;        
} IotAdcChBuffer_t;

typedef struct IoTAdcChain_s
{
    uint8_t ucAdcChannel; 
    void * pvBuffer;      
    uint8_t ucBufLen;     
    uint16_t usChainMask; 
} IotAdcChain_t;

typedef enum IotAdcIoctlRequest_s
{
    eSetAdcConfig,     
    eGetAdcConfig,     
    eGetChStatus,      
    eSetChBuffer,      
    eSetAdcChain,      
} IotAdcIoctlRequest_t;

int32_t iot_adc_ioctl( IotAdcHandle_t const pxAdc,
                       IotAdcIoctlRequest_t xRequest,
                       void * const pvBuffer );

#endif /* _IOT_ADC_H_ */