mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

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

hal/storage_abstraction/Driver_Common.h@181:57724642e740, 2018-02-16 (annotated)

Committer:
AnnaBridge
Date:
Fri Feb 16 16:09:33 2018 +0000
Revision:
181:57724642e740
Parent:
167:e84263d55307 
mbed-dev library. Release version 159.

Who changed what in which revision?

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