Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/hal/port_api.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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