erkin yucel / mbed-os

mbed os with nrf51 internal bandgap enabled to read battery level

Dependents:   BLE_file_test BLE_Blink ExternalEncoder

hal/storage_abstraction/Driver_Common.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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