1 /* 2 * Copyright (c) 2022 FuZhou Lockzhiner Electronic Co., Ltd. All rights reserved. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 /** 17 * @addtogroup Lockzhiner 18 * 19 * @file saradc.h 20 */ 21 22 #ifndef LZ_HARDWARE_SARADC_H 23 #define LZ_HARDWARE_SARADC_H 24 25 /** 26 * @brief Initializes an SARADC device. 27 * 28 * 29 * 30 * @return Returns {@link LZ_HARDWARE_SUCCESS} if the SARADC device is initialized; 31 * returns {@link LZ_HARDWARE_FAILURE} otherwise. For details about other return values, see the chip description. 32 */ 33 int LzSaradcInit(void); 34 35 /** 36 * @brief Deinitializes an SARADC device. 37 * 38 * @return Returns {@link LZ_HARDWARE_SUCCESS} if the SARADC device is deinitialized; 39 * returns {@link LZ_HARDWARE_FAILURE} otherwise. For details about other return values, see the chip description. 40 */ 41 int LzSaradcDeinit(void); 42 43 /** 44 * @brief transfer data with an SARADC device. 45 * 46 * 47 * 48 * @param ch Indicates the SARADC channel number. 49 * @param val Indicates the pointer to save the adc value. 50 * @return Returns {@link LZ_HARDWARE_SUCCESS} if the data is written to the SARADC device successfully; 51 * returns {@link LZ_HARDWARE_FAILURE} otherwise. For details about other return values, see the chip description. 52 */ 53 int LzSaradcReadValue(unsigned int chn, unsigned int *val); 54 55 #endif 56 57