zhang boie / mbed-dev-f30333

hal/storage_abstraction/Driver_Common.h@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

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