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/platform/mbed_interface.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 platform */
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_INTERFACE_H
vipinranka 12:9a20164dcc47 20 #define MBED_INTERFACE_H
vipinranka 12:9a20164dcc47 21
vipinranka 12:9a20164dcc47 22 #include <stdarg.h>
vipinranka 12:9a20164dcc47 23
vipinranka 12:9a20164dcc47 24 #include "device.h"
vipinranka 12:9a20164dcc47 25
vipinranka 12:9a20164dcc47 26 /* Mbed interface mac address
vipinranka 12:9a20164dcc47 27 * if MBED_MAC_ADD_x are zero, interface uid sets mac address,
vipinranka 12:9a20164dcc47 28 * otherwise MAC_ADD_x are used.
vipinranka 12:9a20164dcc47 29 */
vipinranka 12:9a20164dcc47 30 #define MBED_MAC_ADDR_INTERFACE 0x00
vipinranka 12:9a20164dcc47 31 #define MBED_MAC_ADDR_0 MBED_MAC_ADDR_INTERFACE
vipinranka 12:9a20164dcc47 32 #define MBED_MAC_ADDR_1 MBED_MAC_ADDR_INTERFACE
vipinranka 12:9a20164dcc47 33 #define MBED_MAC_ADDR_2 MBED_MAC_ADDR_INTERFACE
vipinranka 12:9a20164dcc47 34 #define MBED_MAC_ADDR_3 MBED_MAC_ADDR_INTERFACE
vipinranka 12:9a20164dcc47 35 #define MBED_MAC_ADDR_4 MBED_MAC_ADDR_INTERFACE
vipinranka 12:9a20164dcc47 36 #define MBED_MAC_ADDR_5 MBED_MAC_ADDR_INTERFACE
vipinranka 12:9a20164dcc47 37 #define MBED_MAC_ADDRESS_SUM (MBED_MAC_ADDR_0 | MBED_MAC_ADDR_1 | MBED_MAC_ADDR_2 | MBED_MAC_ADDR_3 | MBED_MAC_ADDR_4 | MBED_MAC_ADDR_5)
vipinranka 12:9a20164dcc47 38
vipinranka 12:9a20164dcc47 39 #ifdef __cplusplus
vipinranka 12:9a20164dcc47 40 extern "C" {
vipinranka 12:9a20164dcc47 41 #endif
vipinranka 12:9a20164dcc47 42
vipinranka 12:9a20164dcc47 43 #if DEVICE_SEMIHOST
vipinranka 12:9a20164dcc47 44
vipinranka 12:9a20164dcc47 45 /** Functions to control the mbed interface
vipinranka 12:9a20164dcc47 46 *
vipinranka 12:9a20164dcc47 47 * mbed Microcontrollers have a built-in interface to provide functionality such as
vipinranka 12:9a20164dcc47 48 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
vipinranka 12:9a20164dcc47 49 * system. These functions provide means to control the interface suing semihost
vipinranka 12:9a20164dcc47 50 * calls it supports.
vipinranka 12:9a20164dcc47 51 */
vipinranka 12:9a20164dcc47 52
vipinranka 12:9a20164dcc47 53 /** Determine whether the mbed interface is connected, based on whether debug is enabled
vipinranka 12:9a20164dcc47 54 *
vipinranka 12:9a20164dcc47 55 * @returns
vipinranka 12:9a20164dcc47 56 * 1 if interface is connected,
vipinranka 12:9a20164dcc47 57 * 0 otherwise
vipinranka 12:9a20164dcc47 58 */
vipinranka 12:9a20164dcc47 59 int mbed_interface_connected(void);
vipinranka 12:9a20164dcc47 60
vipinranka 12:9a20164dcc47 61 /** Instruct the mbed interface to reset, as if the reset button had been pressed
vipinranka 12:9a20164dcc47 62 *
vipinranka 12:9a20164dcc47 63 * @returns
vipinranka 12:9a20164dcc47 64 * 1 if successful,
vipinranka 12:9a20164dcc47 65 * 0 otherwise (e.g. interface not present)
vipinranka 12:9a20164dcc47 66 */
vipinranka 12:9a20164dcc47 67 int mbed_interface_reset(void);
vipinranka 12:9a20164dcc47 68
vipinranka 12:9a20164dcc47 69 /** This will disconnect the debug aspect of the interface, so semihosting will be disabled.
vipinranka 12:9a20164dcc47 70 * The interface will still support the USB serial aspect
vipinranka 12:9a20164dcc47 71 *
vipinranka 12:9a20164dcc47 72 * @returns
vipinranka 12:9a20164dcc47 73 * 0 if successful,
vipinranka 12:9a20164dcc47 74 * -1 otherwise (e.g. interface not present)
vipinranka 12:9a20164dcc47 75 */
vipinranka 12:9a20164dcc47 76 int mbed_interface_disconnect(void);
vipinranka 12:9a20164dcc47 77
vipinranka 12:9a20164dcc47 78 /** This will disconnect the debug aspect of the interface, and if the USB cable is not
vipinranka 12:9a20164dcc47 79 * connected, also power down the interface. If the USB cable is connected, the interface
vipinranka 12:9a20164dcc47 80 * will remain powered up and visible to the host
vipinranka 12:9a20164dcc47 81 *
vipinranka 12:9a20164dcc47 82 * @returns
vipinranka 12:9a20164dcc47 83 * 0 if successful,
vipinranka 12:9a20164dcc47 84 * -1 otherwise (e.g. interface not present)
vipinranka 12:9a20164dcc47 85 */
vipinranka 12:9a20164dcc47 86 int mbed_interface_powerdown(void);
vipinranka 12:9a20164dcc47 87
vipinranka 12:9a20164dcc47 88 /** This returns a string containing the 32-character UID of the mbed interface
vipinranka 12:9a20164dcc47 89 * This is a weak function that can be overwritten if required
vipinranka 12:9a20164dcc47 90 *
vipinranka 12:9a20164dcc47 91 * @param uid A 33-byte array to write the null terminated 32-byte string
vipinranka 12:9a20164dcc47 92 *
vipinranka 12:9a20164dcc47 93 * @returns
vipinranka 12:9a20164dcc47 94 * 0 if successful,
vipinranka 12:9a20164dcc47 95 * -1 otherwise (e.g. interface not present)
vipinranka 12:9a20164dcc47 96 */
vipinranka 12:9a20164dcc47 97 int mbed_interface_uid(char *uid);
vipinranka 12:9a20164dcc47 98
vipinranka 12:9a20164dcc47 99 #endif
vipinranka 12:9a20164dcc47 100
vipinranka 12:9a20164dcc47 101 /** This returns a unique 6-byte MAC address, based on the interface UID
vipinranka 12:9a20164dcc47 102 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
vipinranka 12:9a20164dcc47 103 *
vipinranka 12:9a20164dcc47 104 * This is a weak function that can be overwritten if you want to provide your own mechanism to
vipinranka 12:9a20164dcc47 105 * provide a MAC address.
vipinranka 12:9a20164dcc47 106 *
vipinranka 12:9a20164dcc47 107 * @param mac A 6-byte array to write the MAC address
vipinranka 12:9a20164dcc47 108 */
vipinranka 12:9a20164dcc47 109 void mbed_mac_address(char *mac);
vipinranka 12:9a20164dcc47 110
vipinranka 12:9a20164dcc47 111 /** Cause the mbed to flash the BLOD (Blue LEDs Of Death) sequence
vipinranka 12:9a20164dcc47 112 */
vipinranka 12:9a20164dcc47 113 void mbed_die(void);
vipinranka 12:9a20164dcc47 114
vipinranka 12:9a20164dcc47 115 /** Print out an error message. This is typically called when
vipinranka 12:9a20164dcc47 116 * hanlding a crash.
vipinranka 12:9a20164dcc47 117 *
vipinranka 12:9a20164dcc47 118 * @Note Synchronization level: Interrupt safe
vipinranka 12:9a20164dcc47 119 */
vipinranka 12:9a20164dcc47 120 void mbed_error_printf(const char* format, ...);
vipinranka 12:9a20164dcc47 121
vipinranka 12:9a20164dcc47 122 /** Print out an error message. Similar to mbed_error_printf
vipinranka 12:9a20164dcc47 123 * but uses a va_list.
vipinranka 12:9a20164dcc47 124 *
vipinranka 12:9a20164dcc47 125 * @Note Synchronization level: Interrupt safe
vipinranka 12:9a20164dcc47 126 */
vipinranka 12:9a20164dcc47 127 void mbed_error_vfprintf(const char * format, va_list arg);
vipinranka 12:9a20164dcc47 128
vipinranka 12:9a20164dcc47 129 #ifdef __cplusplus
vipinranka 12:9a20164dcc47 130 }
vipinranka 12:9a20164dcc47 131 #endif
vipinranka 12:9a20164dcc47 132
vipinranka 12:9a20164dcc47 133 #endif
vipinranka 12:9a20164dcc47 134
vipinranka 12:9a20164dcc47 135 /** @}*/