mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/hal/Driver_Common.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

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