mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

hal/Driver_Common.h@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
156:ff21514d8981 
mbed library. Release version 162

Who changed what in which revision?

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