EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

hal/storage_abstraction/Driver_Common.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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