Mihail Stoyanov / mbed

Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format

Dependents:   NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more

Fork of mbed by mbed official

mbed_interface.h@27:7110ebee3484, 2011-11-29 (annotated)

Committer:
emilmont
Date:
Tue Nov 29 14:59:27 2011 +0000
Revision:
27:7110ebee3484
Child:
43:aff670d0d510
New Libraries 11.11

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 27:7110ebee3484 1 /* Title: mbed_interface
emilmont 27:7110ebee3484 2 * Functions to control the mbed interface
emilmont 27:7110ebee3484 3 *
emilmont 27:7110ebee3484 4 * mbed Microcontrollers have a built-in interface to provide functionality such as
emilmont 27:7110ebee3484 5 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
emilmont 27:7110ebee3484 6 * system. These functions provide means to control the interface suing semihost
emilmont 27:7110ebee3484 7 * calls it supports.
emilmont 27:7110ebee3484 8 */
emilmont 27:7110ebee3484 9
emilmont 27:7110ebee3484 10 /* mbed Microcontroller Library - mbed_interface
emilmont 27:7110ebee3484 11 * Copyright (c) 2009-2011 ARM Limited. All rights reserved.
emilmont 27:7110ebee3484 12 */
emilmont 27:7110ebee3484 13
emilmont 27:7110ebee3484 14 #ifndef MBED_INTERFACE_H
emilmont 27:7110ebee3484 15 #define MBED_INTERFACE_H
emilmont 27:7110ebee3484 16
emilmont 27:7110ebee3484 17 #ifdef __cplusplus
emilmont 27:7110ebee3484 18 extern "C" {
emilmont 27:7110ebee3484 19 #endif
emilmont 27:7110ebee3484 20
emilmont 27:7110ebee3484 21 /* Function: mbed_interface_connected
emilmont 27:7110ebee3484 22 * Determine whether the mbed interface is connected, based on whether debug is enabled
emilmont 27:7110ebee3484 23 *
emilmont 27:7110ebee3484 24 * Variables:
emilmont 27:7110ebee3484 25 * returns - 1 if interface is connected, else 0
emilmont 27:7110ebee3484 26 */
emilmont 27:7110ebee3484 27 int mbed_interface_connected(void);
emilmont 27:7110ebee3484 28
emilmont 27:7110ebee3484 29 /* Function: mbed_interface_reset
emilmont 27:7110ebee3484 30 * Instruct the mbed interface to reset, as if the reset button had been pressed
emilmont 27:7110ebee3484 31 *
emilmont 27:7110ebee3484 32 * Variables:
emilmont 27:7110ebee3484 33 * returns - 1 if successful, else 0 (e.g. interface not present)
emilmont 27:7110ebee3484 34 */
emilmont 27:7110ebee3484 35 int mbed_interface_reset(void);
emilmont 27:7110ebee3484 36
emilmont 27:7110ebee3484 37 /* Function: mbed_interface_disconnect
emilmont 27:7110ebee3484 38 * This will disconnect the debug aspect of the interface, so semihosting will be disabled.
emilmont 27:7110ebee3484 39 * The interface will still support the USB serial aspect
emilmont 27:7110ebee3484 40 *
emilmont 27:7110ebee3484 41 * Variables:
emilmont 27:7110ebee3484 42 * returns - 0 if successful, else -1 (e.g. interface not present)
emilmont 27:7110ebee3484 43 */
emilmont 27:7110ebee3484 44 int mbed_interface_disconnect(void);
emilmont 27:7110ebee3484 45
emilmont 27:7110ebee3484 46 /* Function: mbed_interface_powerdown
emilmont 27:7110ebee3484 47 * This will disconnect the debug aspect of the interface, and if the USB cable is not
emilmont 27:7110ebee3484 48 * connected, also power down the interface. If the USB cable is connected, the interface
emilmont 27:7110ebee3484 49 * will remain powered up and visible to the host
emilmont 27:7110ebee3484 50 *
emilmont 27:7110ebee3484 51 * Variables:
emilmont 27:7110ebee3484 52 * returns - 0 if successful, else -1 (e.g. interface not present)
emilmont 27:7110ebee3484 53 */
emilmont 27:7110ebee3484 54 int mbed_interface_powerdown(void);
emilmont 27:7110ebee3484 55
emilmont 27:7110ebee3484 56 /* Function: mbed_interface_uid
emilmont 27:7110ebee3484 57 * This returns a string containing the 32-character UID of the mbed interface
emilmont 27:7110ebee3484 58 *
emilmont 27:7110ebee3484 59 * This is a weak function that can be overwritten if required
emilmont 27:7110ebee3484 60 *
emilmont 27:7110ebee3484 61 * Variables:
emilmont 27:7110ebee3484 62 * uid - A 33-byte array to write the null terminated 32-byte string
emilmont 27:7110ebee3484 63 * returns - 0 if successful, else -1 (e.g. interface not present)
emilmont 27:7110ebee3484 64 */
emilmont 27:7110ebee3484 65 int mbed_interface_uid(char *uid);
emilmont 27:7110ebee3484 66
emilmont 27:7110ebee3484 67 /* Function: mbed_mac_address
emilmont 27:7110ebee3484 68 * This returns a unique 6-byte MAC address, based on the interface UID
emilmont 27:7110ebee3484 69 *
emilmont 27:7110ebee3484 70 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
emilmont 27:7110ebee3484 71 *
emilmont 27:7110ebee3484 72 * This is a weak function that can be overwritten if you want to provide your own mechanism to
emilmont 27:7110ebee3484 73 * provide a MAC address.
emilmont 27:7110ebee3484 74
emilmont 27:7110ebee3484 75 * Variables:
emilmont 27:7110ebee3484 76 * mac - A 6-byte array to write the MAC address
emilmont 27:7110ebee3484 77 */
emilmont 27:7110ebee3484 78 void mbed_mac_address(char *mac);
emilmont 27:7110ebee3484 79
emilmont 27:7110ebee3484 80 /* Function: mbed_die
emilmont 27:7110ebee3484 81 * Cause the mbed to flash the BLOD LED sequence
emilmont 27:7110ebee3484 82 */
emilmont 27:7110ebee3484 83 void mbed_die(void);
emilmont 27:7110ebee3484 84
emilmont 27:7110ebee3484 85 #ifdef __cplusplus
emilmont 27:7110ebee3484 86 }
emilmont 27:7110ebee3484 87 #endif
emilmont 27:7110ebee3484 88
emilmont 27:7110ebee3484 89 #endif