Bei Chen Liu / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/mbed_interface.h@13:0645d8841f51, 2013-08-05 (annotated)

Committer:
bogdanm
Date:
Mon Aug 05 14:12:34 2013 +0300
Revision:
13:0645d8841f51
Parent:
10:3bc89ef62ce7
Child:
19:398f4c622e1b
Update mbed sources to revision 64

Who changed what in which revision?

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