Cefn Hoile / mbed-dev-bin

Forked version

Fork of mbed-dev-bin by Lancaster University

mbed_interface.h@2:a715a02d198e, 2016-06-01 (annotated)

Committer:
cefn
Date:
Wed Jun 01 17:38:31 2016 +0000
Revision:
2:a715a02d198e
Parent:
0:e1a608bb55e8 
Temporary microbit tree for shipping lifedetector (with minor patches as agreed with @jamesadevine

Who changed what in which revision?

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