Marco Mayer / Mbed OS Queue

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/hal/storage_abstraction/Driver_Common.h@2:c7897a3f5f11, 2020-04-22 (annotated)

Committer:
demayer
Date:
Wed Apr 22 11:50:00 2020 +0000
Revision:
2:c7897a3f5f11
Parent:
0:6bf0743ece18 
test

Who changed what in which revision?

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