Greg Steiert / maxim_dev

Dependents:   sensomed

hal/port_api.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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