Greg Steiert / pegasus_dev

Development mbed library for MAX32630FTHR

Dependents:   blinky_max32630fthr

hal/port_api.h@3:1198227e6421, 2016-12-16 (annotated)

Committer:
switches
Date:
Fri Dec 16 16:27:57 2016 +0000
Revision:
3:1198227e6421
Parent:
0:5c4d7b2438d3 
Changed ADC scale for MAX32625 platforms to 1.2V full scale to match MAX32630 platforms

Who changed what in which revision?

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