Knight KE / Mbed OS Game_Master

游戏王对战板，目前code还是空的

mbed-os/hal/port_api.h@0:9b3d4731edbb, 2018-06-21 (annotated)

Committer:
WFKnight
Date:
Thu Jun 21 13:51:43 2018 +0000
Revision:
0:9b3d4731edbb
UART, RTOS, LED

Who changed what in which revision?

UserRevisionLine numberNew contents of line
WFKnight 0:9b3d4731edbb 1
WFKnight 0:9b3d4731edbb 2 /** \addtogroup hal */
WFKnight 0:9b3d4731edbb 3 /** @{*/
WFKnight 0:9b3d4731edbb 4 /* mbed Microcontroller Library
WFKnight 0:9b3d4731edbb 5 * Copyright (c) 2006-2013 ARM Limited
WFKnight 0:9b3d4731edbb 6 *
WFKnight 0:9b3d4731edbb 7 * Licensed under the Apache License, Version 2.0 (the "License");
WFKnight 0:9b3d4731edbb 8 * you may not use this file except in compliance with the License.
WFKnight 0:9b3d4731edbb 9 * You may obtain a copy of the License at
WFKnight 0:9b3d4731edbb 10 *
WFKnight 0:9b3d4731edbb 11 * http://www.apache.org/licenses/LICENSE-2.0
WFKnight 0:9b3d4731edbb 12 *
WFKnight 0:9b3d4731edbb 13 * Unless required by applicable law or agreed to in writing, software
WFKnight 0:9b3d4731edbb 14 * distributed under the License is distributed on an "AS IS" BASIS,
WFKnight 0:9b3d4731edbb 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
WFKnight 0:9b3d4731edbb 16 * See the License for the specific language governing permissions and
WFKnight 0:9b3d4731edbb 17 * limitations under the License.
WFKnight 0:9b3d4731edbb 18 */
WFKnight 0:9b3d4731edbb 19 #ifndef MBED_PORTMAP_H
WFKnight 0:9b3d4731edbb 20 #define MBED_PORTMAP_H
WFKnight 0:9b3d4731edbb 21
WFKnight 0:9b3d4731edbb 22 #include "device.h"
WFKnight 0:9b3d4731edbb 23
WFKnight 0:9b3d4731edbb 24 #if DEVICE_PORTIN || DEVICE_PORTOUT
WFKnight 0:9b3d4731edbb 25
WFKnight 0:9b3d4731edbb 26 #ifdef __cplusplus
WFKnight 0:9b3d4731edbb 27 extern "C" {
WFKnight 0:9b3d4731edbb 28 #endif
WFKnight 0:9b3d4731edbb 29
WFKnight 0:9b3d4731edbb 30 /** Port HAL structure. port_s is declared in the target's HAL
WFKnight 0:9b3d4731edbb 31 */
WFKnight 0:9b3d4731edbb 32 typedef struct port_s port_t;
WFKnight 0:9b3d4731edbb 33
WFKnight 0:9b3d4731edbb 34 /**
WFKnight 0:9b3d4731edbb 35 * \defgroup hal_port Port HAL functions
WFKnight 0:9b3d4731edbb 36 * @{
WFKnight 0:9b3d4731edbb 37 */
WFKnight 0:9b3d4731edbb 38
WFKnight 0:9b3d4731edbb 39 /** Get the pin name from the port's pin number
WFKnight 0:9b3d4731edbb 40 *
WFKnight 0:9b3d4731edbb 41 * @param port The port name
WFKnight 0:9b3d4731edbb 42 * @param pin_n The pin number within the specified port
WFKnight 0:9b3d4731edbb 43 * @return The pin name for the port's pin number
WFKnight 0:9b3d4731edbb 44 */
WFKnight 0:9b3d4731edbb 45 PinName port_pin(PortName port, int pin_n);
WFKnight 0:9b3d4731edbb 46
WFKnight 0:9b3d4731edbb 47 /** Initilize the port
WFKnight 0:9b3d4731edbb 48 *
WFKnight 0:9b3d4731edbb 49 * @param obj The port object to initialize
WFKnight 0:9b3d4731edbb 50 * @param port The port name
WFKnight 0:9b3d4731edbb 51 * @param mask The bitmask to identify which bits in the port should be included (0 - ignore)
WFKnight 0:9b3d4731edbb 52 * @param dir The port direction
WFKnight 0:9b3d4731edbb 53 */
WFKnight 0:9b3d4731edbb 54 void port_init(port_t *obj, PortName port, int mask, PinDirection dir);
WFKnight 0:9b3d4731edbb 55
WFKnight 0:9b3d4731edbb 56 /** Set the input port mode
WFKnight 0:9b3d4731edbb 57 *
WFKnight 0:9b3d4731edbb 58 * @param obj The port object
WFKnight 0:9b3d4731edbb 59 * @param mode THe port mode to be set
WFKnight 0:9b3d4731edbb 60 */
WFKnight 0:9b3d4731edbb 61 void port_mode(port_t *obj, PinMode mode);
WFKnight 0:9b3d4731edbb 62
WFKnight 0:9b3d4731edbb 63 /** Set port direction (in/out)
WFKnight 0:9b3d4731edbb 64 *
WFKnight 0:9b3d4731edbb 65 * @param obj The port object
WFKnight 0:9b3d4731edbb 66 * @param dir The port direction to be set
WFKnight 0:9b3d4731edbb 67 */
WFKnight 0:9b3d4731edbb 68 void port_dir(port_t *obj, PinDirection dir);
WFKnight 0:9b3d4731edbb 69
WFKnight 0:9b3d4731edbb 70 /** Write value to the port
WFKnight 0:9b3d4731edbb 71 *
WFKnight 0:9b3d4731edbb 72 * @param obj The port object
WFKnight 0:9b3d4731edbb 73 * @param value The value to be set
WFKnight 0:9b3d4731edbb 74 */
WFKnight 0:9b3d4731edbb 75 void port_write(port_t *obj, int value);
WFKnight 0:9b3d4731edbb 76
WFKnight 0:9b3d4731edbb 77 /** Read the current value on the port
WFKnight 0:9b3d4731edbb 78 *
WFKnight 0:9b3d4731edbb 79 * @param obj The port object
WFKnight 0:9b3d4731edbb 80 * @return An integer with each bit corresponding to an associated port pin setting
WFKnight 0:9b3d4731edbb 81 */
WFKnight 0:9b3d4731edbb 82 int port_read(port_t *obj);
WFKnight 0:9b3d4731edbb 83
WFKnight 0:9b3d4731edbb 84 /**@}*/
WFKnight 0:9b3d4731edbb 85
WFKnight 0:9b3d4731edbb 86 #ifdef __cplusplus
WFKnight 0:9b3d4731edbb 87 }
WFKnight 0:9b3d4731edbb 88 #endif
WFKnight 0:9b3d4731edbb 89 #endif
WFKnight 0:9b3d4731edbb 90
WFKnight 0:9b3d4731edbb 91 #endif
WFKnight 0:9b3d4731edbb 92
WFKnight 0:9b3d4731edbb 93 /** @}*/