Thomas Lyp / DevLibMemoryController

Initial commit

Dependencies:   FastPWM

mbed-dev-master/hal/port_api.h@0:bb348c97df44, 2020-09-16 (annotated)

Committer:
lypinator
Date:
Wed Sep 16 01:11:49 2020 +0000
Revision:
0:bb348c97df44
Added PWM

Who changed what in which revision?

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