Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/mbed_interface.h@57:dd901dec6bd0, 2016-01-30 (annotated)

Committer:
Splith
Date:
Sat Jan 30 16:48:54 2016 +0000
Revision:
57:dd901dec6bd0
Parent:
0:9b334a45a8ff 
Add USART3 pin mapping to Seeed arch max

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:9b334a45a8ff 1 /* mbed Microcontroller Library
bogdanm 0:9b334a45a8ff 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 0:9b334a45a8ff 3 *
bogdanm 0:9b334a45a8ff 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 0:9b334a45a8ff 5 * you may not use this file except in compliance with the License.
bogdanm 0:9b334a45a8ff 6 * You may obtain a copy of the License at
bogdanm 0:9b334a45a8ff 7 *
bogdanm 0:9b334a45a8ff 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 0:9b334a45a8ff 9 *
bogdanm 0:9b334a45a8ff 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 0:9b334a45a8ff 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 0:9b334a45a8ff 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 0:9b334a45a8ff 13 * See the License for the specific language governing permissions and
bogdanm 0:9b334a45a8ff 14 * limitations under the License.
bogdanm 0:9b334a45a8ff 15 */
bogdanm 0:9b334a45a8ff 16 #ifndef MBED_INTERFACE_H
bogdanm 0:9b334a45a8ff 17 #define MBED_INTERFACE_H
bogdanm 0:9b334a45a8ff 18
bogdanm 0:9b334a45a8ff 19 #include "device.h"
bogdanm 0:9b334a45a8ff 20
bogdanm 0:9b334a45a8ff 21 /* Mbed interface mac address
bogdanm 0:9b334a45a8ff 22 * if MBED_MAC_ADD_x are zero, interface uid sets mac address,
bogdanm 0:9b334a45a8ff 23 * otherwise MAC_ADD_x are used.
bogdanm 0:9b334a45a8ff 24 */
bogdanm 0:9b334a45a8ff 25 #define MBED_MAC_ADDR_INTERFACE 0x00
bogdanm 0:9b334a45a8ff 26 #define MBED_MAC_ADDR_0 MBED_MAC_ADDR_INTERFACE
bogdanm 0:9b334a45a8ff 27 #define MBED_MAC_ADDR_1 MBED_MAC_ADDR_INTERFACE
bogdanm 0:9b334a45a8ff 28 #define MBED_MAC_ADDR_2 MBED_MAC_ADDR_INTERFACE
bogdanm 0:9b334a45a8ff 29 #define MBED_MAC_ADDR_3 MBED_MAC_ADDR_INTERFACE
bogdanm 0:9b334a45a8ff 30 #define MBED_MAC_ADDR_4 MBED_MAC_ADDR_INTERFACE
bogdanm 0:9b334a45a8ff 31 #define MBED_MAC_ADDR_5 MBED_MAC_ADDR_INTERFACE
bogdanm 0:9b334a45a8ff 32 #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)
bogdanm 0:9b334a45a8ff 33
bogdanm 0:9b334a45a8ff 34 #ifdef __cplusplus
bogdanm 0:9b334a45a8ff 35 extern "C" {
bogdanm 0:9b334a45a8ff 36 #endif
bogdanm 0:9b334a45a8ff 37
bogdanm 0:9b334a45a8ff 38 #if DEVICE_SEMIHOST
bogdanm 0:9b334a45a8ff 39
bogdanm 0:9b334a45a8ff 40 /** Functions to control the mbed interface
bogdanm 0:9b334a45a8ff 41 *
bogdanm 0:9b334a45a8ff 42 * mbed Microcontrollers have a built-in interface to provide functionality such as
bogdanm 0:9b334a45a8ff 43 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
bogdanm 0:9b334a45a8ff 44 * system. These functions provide means to control the interface suing semihost
bogdanm 0:9b334a45a8ff 45 * calls it supports.
bogdanm 0:9b334a45a8ff 46 */
bogdanm 0:9b334a45a8ff 47
bogdanm 0:9b334a45a8ff 48 /** Determine whether the mbed interface is connected, based on whether debug is enabled
bogdanm 0:9b334a45a8ff 49 *
bogdanm 0:9b334a45a8ff 50 * @returns
bogdanm 0:9b334a45a8ff 51 * 1 if interface is connected,
bogdanm 0:9b334a45a8ff 52 * 0 otherwise
bogdanm 0:9b334a45a8ff 53 */
bogdanm 0:9b334a45a8ff 54 int mbed_interface_connected(void);
bogdanm 0:9b334a45a8ff 55
bogdanm 0:9b334a45a8ff 56 /** Instruct the mbed interface to reset, as if the reset button had been pressed
bogdanm 0:9b334a45a8ff 57 *
bogdanm 0:9b334a45a8ff 58 * @returns
bogdanm 0:9b334a45a8ff 59 * 1 if successful,
bogdanm 0:9b334a45a8ff 60 * 0 otherwise (e.g. interface not present)
bogdanm 0:9b334a45a8ff 61 */
bogdanm 0:9b334a45a8ff 62 int mbed_interface_reset(void);
bogdanm 0:9b334a45a8ff 63
bogdanm 0:9b334a45a8ff 64 /** This will disconnect the debug aspect of the interface, so semihosting will be disabled.
bogdanm 0:9b334a45a8ff 65 * The interface will still support the USB serial aspect
bogdanm 0:9b334a45a8ff 66 *
bogdanm 0:9b334a45a8ff 67 * @returns
bogdanm 0:9b334a45a8ff 68 * 0 if successful,
bogdanm 0:9b334a45a8ff 69 * -1 otherwise (e.g. interface not present)
bogdanm 0:9b334a45a8ff 70 */
bogdanm 0:9b334a45a8ff 71 int mbed_interface_disconnect(void);
bogdanm 0:9b334a45a8ff 72
bogdanm 0:9b334a45a8ff 73 /** This will disconnect the debug aspect of the interface, and if the USB cable is not
bogdanm 0:9b334a45a8ff 74 * connected, also power down the interface. If the USB cable is connected, the interface
bogdanm 0:9b334a45a8ff 75 * will remain powered up and visible to the host
bogdanm 0:9b334a45a8ff 76 *
bogdanm 0:9b334a45a8ff 77 * @returns
bogdanm 0:9b334a45a8ff 78 * 0 if successful,
bogdanm 0:9b334a45a8ff 79 * -1 otherwise (e.g. interface not present)
bogdanm 0:9b334a45a8ff 80 */
bogdanm 0:9b334a45a8ff 81 int mbed_interface_powerdown(void);
bogdanm 0:9b334a45a8ff 82
bogdanm 0:9b334a45a8ff 83 /** This returns a string containing the 32-character UID of the mbed interface
bogdanm 0:9b334a45a8ff 84 * This is a weak function that can be overwritten if required
bogdanm 0:9b334a45a8ff 85 *
bogdanm 0:9b334a45a8ff 86 * @param uid A 33-byte array to write the null terminated 32-byte string
bogdanm 0:9b334a45a8ff 87 *
bogdanm 0:9b334a45a8ff 88 * @returns
bogdanm 0:9b334a45a8ff 89 * 0 if successful,
bogdanm 0:9b334a45a8ff 90 * -1 otherwise (e.g. interface not present)
bogdanm 0:9b334a45a8ff 91 */
bogdanm 0:9b334a45a8ff 92 int mbed_interface_uid(char *uid);
bogdanm 0:9b334a45a8ff 93
bogdanm 0:9b334a45a8ff 94 #endif
bogdanm 0:9b334a45a8ff 95
bogdanm 0:9b334a45a8ff 96 /** This returns a unique 6-byte MAC address, based on the interface UID
bogdanm 0:9b334a45a8ff 97 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
bogdanm 0:9b334a45a8ff 98 *
bogdanm 0:9b334a45a8ff 99 * This is a weak function that can be overwritten if you want to provide your own mechanism to
bogdanm 0:9b334a45a8ff 100 * provide a MAC address.
bogdanm 0:9b334a45a8ff 101 *
bogdanm 0:9b334a45a8ff 102 * @param mac A 6-byte array to write the MAC address
bogdanm 0:9b334a45a8ff 103 */
bogdanm 0:9b334a45a8ff 104 void mbed_mac_address(char *mac);
bogdanm 0:9b334a45a8ff 105
bogdanm 0:9b334a45a8ff 106 /** Cause the mbed to flash the BLOD (Blue LEDs Of Death) sequence
bogdanm 0:9b334a45a8ff 107 */
bogdanm 0:9b334a45a8ff 108 void mbed_die(void);
bogdanm 0:9b334a45a8ff 109
bogdanm 0:9b334a45a8ff 110 #ifdef __cplusplus
bogdanm 0:9b334a45a8ff 111 }
bogdanm 0:9b334a45a8ff 112 #endif
bogdanm 0:9b334a45a8ff 113
bogdanm 0:9b334a45a8ff 114 #endif