Mark Turner / mbed

mbed library for slider v2

Dependents:   kl46z_slider_v2

port_api.h@0:b7116bd48af6, 2016-09-14 (annotated)

Committer:
mturner5
Date:
Wed Sep 14 07:04:27 2016 +0000
Revision:
0:b7116bd48af6
Tried to use the timer.

Who changed what in which revision?

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