mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

mbed_interface.h@55:d722ed6a4237, 2013-01-16 (annotated)

Committer:
emilmont
Date:
Wed Jan 16 12:56:34 2013 +0000
Revision:
55:d722ed6a4237
Parent:
54:71b101360fb9
Child:
59:0883845fe643
Include "sleep_api.h" in "mbed.h"

Add initial IAR toolchain support

LPC I2C: better handling of status

Add sleep mode support for the LPC1768

Correct GCC "__semihost" definition

Correct GCC "_isatty" retargeting

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 54:71b101360fb9 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
emilmont 44:24d45a770a51 22 #ifndef MBED_INTERFACE_H
emilmont 44:24d45a770a51 23 #define MBED_INTERFACE_H
emilmont 44:24d45a770a51 24
emilmont 55:d722ed6a4237 25 #include "device.h"
emilmont 55:d722ed6a4237 26
emilmont 44:24d45a770a51 27 #ifdef __cplusplus
emilmont 44:24d45a770a51 28 extern "C" {
emilmont 44:24d45a770a51 29 #endif
emilmont 44:24d45a770a51 30
emilmont 55:d722ed6a4237 31 #if DEVICE_SEMIHOST
emilmont 55:d722ed6a4237 32
emilmont 43:e2ed12d17f06 33 /** Functions to control the mbed interface
emilmont 27:7110ebee3484 34 *
emilmont 55:d722ed6a4237 35 * mbed Microcontrollers have a built-in interface to provide functionality such as
emilmont 55:d722ed6a4237 36 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
emilmont 27:7110ebee3484 37 * system. These functions provide means to control the interface suing semihost
emilmont 27:7110ebee3484 38 * calls it supports.
emilmont 27:7110ebee3484 39 */
emilmont 27:7110ebee3484 40
emilmont 43:e2ed12d17f06 41 /** Determine whether the mbed interface is connected, based on whether debug is enabled
emilmont 55:d722ed6a4237 42 *
emilmont 43:e2ed12d17f06 43 * @returns
emilmont 43:e2ed12d17f06 44 * 1 if interface is connected,
emilmont 43:e2ed12d17f06 45 * 0 otherwise
emilmont 27:7110ebee3484 46 */
emilmont 27:7110ebee3484 47 int mbed_interface_connected(void);
emilmont 27:7110ebee3484 48
emilmont 43:e2ed12d17f06 49 /** Instruct the mbed interface to reset, as if the reset button had been pressed
emilmont 27:7110ebee3484 50 *
emilmont 43:e2ed12d17f06 51 * @returns
emilmont 43:e2ed12d17f06 52 * 1 if successful,
emilmont 43:e2ed12d17f06 53 * 0 otherwise (e.g. interface not present)
emilmont 27:7110ebee3484 54 */
emilmont 27:7110ebee3484 55 int mbed_interface_reset(void);
emilmont 27:7110ebee3484 56
emilmont 43:e2ed12d17f06 57 /** This will disconnect the debug aspect of the interface, so semihosting will be disabled.
emilmont 44:24d45a770a51 58 * The interface will still support the USB serial aspect
emilmont 27:7110ebee3484 59 *
emilmont 43:e2ed12d17f06 60 * @returns
emilmont 43:e2ed12d17f06 61 * 0 if successful,
emilmont 43:e2ed12d17f06 62 * -1 otherwise (e.g. interface not present)
emilmont 27:7110ebee3484 63 */
emilmont 27:7110ebee3484 64 int mbed_interface_disconnect(void);
emilmont 27:7110ebee3484 65
emilmont 55:d722ed6a4237 66 /** This will disconnect the debug aspect of the interface, and if the USB cable is not
emilmont 44:24d45a770a51 67 * connected, also power down the interface. If the USB cable is connected, the interface
emilmont 55:d722ed6a4237 68 * will remain powered up and visible to the host
emilmont 27:7110ebee3484 69 *
emilmont 43:e2ed12d17f06 70 * @returns
emilmont 43:e2ed12d17f06 71 * 0 if successful,
emilmont 43:e2ed12d17f06 72 * -1 otherwise (e.g. interface not present)
emilmont 27:7110ebee3484 73 */
emilmont 27:7110ebee3484 74 int mbed_interface_powerdown(void);
emilmont 27:7110ebee3484 75
emilmont 43:e2ed12d17f06 76 /** This returns a string containing the 32-character UID of the mbed interface
emilmont 43:e2ed12d17f06 77 * This is a weak function that can be overwritten if required
emilmont 27:7110ebee3484 78 *
emilmont 43:e2ed12d17f06 79 * @param uid A 33-byte array to write the null terminated 32-byte string
emilmont 27:7110ebee3484 80 *
emilmont 43:e2ed12d17f06 81 * @returns
emilmont 43:e2ed12d17f06 82 * 0 if successful,
emilmont 43:e2ed12d17f06 83 * -1 otherwise (e.g. interface not present)
emilmont 27:7110ebee3484 84 */
emilmont 27:7110ebee3484 85 int mbed_interface_uid(char *uid);
emilmont 27:7110ebee3484 86
emilmont 55:d722ed6a4237 87 #endif
emilmont 55:d722ed6a4237 88
emilmont 43:e2ed12d17f06 89 /** This returns a unique 6-byte MAC address, based on the interface UID
emilmont 44:24d45a770a51 90 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
emilmont 27:7110ebee3484 91 *
emilmont 44:24d45a770a51 92 * This is a weak function that can be overwritten if you want to provide your own mechanism to
emilmont 44:24d45a770a51 93 * provide a MAC address.
emilmont 43:e2ed12d17f06 94 *
emilmont 43:e2ed12d17f06 95 * @param mac A 6-byte array to write the MAC address
emilmont 27:7110ebee3484 96 */
emilmont 27:7110ebee3484 97 void mbed_mac_address(char *mac);
emilmont 27:7110ebee3484 98
emilmont 55:d722ed6a4237 99 /** Cause the mbed to flash the BLOD (Blue LEDs Of Death) sequence
emilmont 27:7110ebee3484 100 */
emilmont 27:7110ebee3484 101 void mbed_die(void);
emilmont 27:7110ebee3484 102
emilmont 27:7110ebee3484 103 #ifdef __cplusplus
emilmont 27:7110ebee3484 104 }
emilmont 27:7110ebee3484 105 #endif
emilmont 27:7110ebee3484 106
emilmont 27:7110ebee3484 107 #endif