cc y / mbed

ads1115 only

Fork of mbed by mbed official

hal/Driver_Common.h@135:fce8a9387ed1, 2017-01-17 (annotated)

Committer:
kaoshen
Date:
Tue Jan 17 23:27:32 2017 +0000
Revision:
135:fce8a9387ed1
Parent:
128:9bcdf88f62b0 
333 ADS1115 ADC1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 128:9bcdf88f62b0 1
<> 128:9bcdf88f62b0 2 /** \addtogroup hal */
<> 128:9bcdf88f62b0 3 /** @{*/
<> 128:9bcdf88f62b0 4 /*
<> 128:9bcdf88f62b0 5 * Copyright (c) 2006-2016, ARM Limited, All Rights Reserved
<> 128:9bcdf88f62b0 6 * SPDX-License-Identifier: Apache-2.0
<> 128:9bcdf88f62b0 7 *
<> 128:9bcdf88f62b0 8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
<> 128:9bcdf88f62b0 9 * not use this file except in compliance with the License.
<> 128:9bcdf88f62b0 10 * You may obtain a copy of the License at
<> 128:9bcdf88f62b0 11 *
<> 128:9bcdf88f62b0 12 * http://www.apache.org/licenses/LICENSE-2.0
<> 128:9bcdf88f62b0 13 *
<> 128:9bcdf88f62b0 14 * Unless required by applicable law or agreed to in writing, software
<> 128:9bcdf88f62b0 15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
<> 128:9bcdf88f62b0 16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 128:9bcdf88f62b0 17 * See the License for the specific language governing permissions and
<> 128:9bcdf88f62b0 18 * limitations under the License.
<> 128:9bcdf88f62b0 19 */
<> 128:9bcdf88f62b0 20
<> 128:9bcdf88f62b0 21 #ifndef __DRIVER_COMMON_H
<> 128:9bcdf88f62b0 22 #define __DRIVER_COMMON_H
<> 128:9bcdf88f62b0 23
<> 128:9bcdf88f62b0 24 #include <stddef.h>
<> 128:9bcdf88f62b0 25 #include <stdint.h>
<> 128:9bcdf88f62b0 26 #include <stdbool.h>
<> 128:9bcdf88f62b0 27
<> 128:9bcdf88f62b0 28 #define ARM_DRIVER_VERSION_MAJOR_MINOR(major,minor) (((major) << 8) | (minor))
<> 128:9bcdf88f62b0 29
<> 128:9bcdf88f62b0 30 /**
<> 128:9bcdf88f62b0 31 \brief Driver Version
<> 128:9bcdf88f62b0 32 */
<> 128:9bcdf88f62b0 33 typedef struct _ARM_DRIVER_VERSION {
<> 128:9bcdf88f62b0 34 uint16_t api; ///< API version
<> 128:9bcdf88f62b0 35 uint16_t drv; ///< Driver version
<> 128:9bcdf88f62b0 36 } ARM_DRIVER_VERSION;
<> 128:9bcdf88f62b0 37
<> 128:9bcdf88f62b0 38 /* General return codes */
<> 128:9bcdf88f62b0 39 #define ARM_DRIVER_OK 0 ///< Operation succeeded
<> 128:9bcdf88f62b0 40 #define ARM_DRIVER_ERROR -1 ///< Unspecified error
<> 128:9bcdf88f62b0 41 #define ARM_DRIVER_ERROR_BUSY -2 ///< Driver is busy
<> 128:9bcdf88f62b0 42 #define ARM_DRIVER_ERROR_TIMEOUT -3 ///< Timeout occurred
<> 128:9bcdf88f62b0 43 #define ARM_DRIVER_ERROR_UNSUPPORTED -4 ///< Operation not supported
<> 128:9bcdf88f62b0 44 #define ARM_DRIVER_ERROR_PARAMETER -5 ///< Parameter error
<> 128:9bcdf88f62b0 45 #define ARM_DRIVER_ERROR_SPECIFIC -6 ///< Start of driver specific errors
<> 128:9bcdf88f62b0 46
<> 128:9bcdf88f62b0 47 /**
<> 128:9bcdf88f62b0 48 \brief General power states
<> 128:9bcdf88f62b0 49 */
<> 128:9bcdf88f62b0 50 typedef enum _ARM_POWER_STATE {
<> 128:9bcdf88f62b0 51 ARM_POWER_OFF, ///< Power off: no operation possible
<> 128:9bcdf88f62b0 52 ARM_POWER_LOW, ///< Low Power mode: retain state, detect and signal wake-up events
<> 128:9bcdf88f62b0 53 ARM_POWER_FULL ///< Power on: full operation at maximum performance
<> 128:9bcdf88f62b0 54 } ARM_POWER_STATE;
<> 128:9bcdf88f62b0 55
<> 128:9bcdf88f62b0 56 #endif /* __DRIVER_COMMON_H */
<> 128:9bcdf88f62b0 57
<> 128:9bcdf88f62b0 58 /** @}*/