Morpheus / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

api/mbed_interface.h@20:06bbf6d2334c, 2016-04-22 (annotated)

Committer:
screamer
Date:
Fri Apr 22 13:40:25 2016 +0100
Revision:
20:06bbf6d2334c
Parent:
0:9c59db1fbc9e 
Update library references

Who changed what in which revision?

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