Julien Kern / mbed

mbed library

Dependents:   Printf

Fork of mbed by mbed official

mbed_interface.h@53:63cdd78b2dc1, 2012-12-06 (annotated)

Committer:
emilmont
Date:
Thu Dec 06 17:03:27 2012 +0000
Revision:
53:63cdd78b2dc1
Parent:
44:24d45a770a51
Child:
54:71b101360fb9
I2C LPC: fix status after start bit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 44:24d45a770a51 2 * Copyright (c) 2006-2012 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 44:24d45a770a51 25 #ifdef __cplusplus
emilmont 44:24d45a770a51 26 extern "C" {
emilmont 44:24d45a770a51 27 #endif
emilmont 44:24d45a770a51 28
emilmont 43:e2ed12d17f06 29 /** Functions to control the mbed interface
emilmont 27:7110ebee3484 30 *
emilmont 27:7110ebee3484 31 * mbed Microcontrollers have a built-in interface to provide functionality such as
emilmont 27:7110ebee3484 32 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
emilmont 27:7110ebee3484 33 * system. These functions provide means to control the interface suing semihost
emilmont 27:7110ebee3484 34 * calls it supports.
emilmont 27:7110ebee3484 35 */
emilmont 27:7110ebee3484 36
emilmont 43:e2ed12d17f06 37 /** Determine whether the mbed interface is connected, based on whether debug is enabled
emilmont 27:7110ebee3484 38 *
emilmont 43:e2ed12d17f06 39 * @returns
emilmont 43:e2ed12d17f06 40 * 1 if interface is connected,
emilmont 43:e2ed12d17f06 41 * 0 otherwise
emilmont 27:7110ebee3484 42 */
emilmont 27:7110ebee3484 43 int mbed_interface_connected(void);
emilmont 27:7110ebee3484 44
emilmont 43:e2ed12d17f06 45 /** Instruct the mbed interface to reset, as if the reset button had been pressed
emilmont 27:7110ebee3484 46 *
emilmont 43:e2ed12d17f06 47 * @returns
emilmont 43:e2ed12d17f06 48 * 1 if successful,
emilmont 43:e2ed12d17f06 49 * 0 otherwise (e.g. interface not present)
emilmont 27:7110ebee3484 50 */
emilmont 27:7110ebee3484 51 int mbed_interface_reset(void);
emilmont 27:7110ebee3484 52
emilmont 43:e2ed12d17f06 53 /** This will disconnect the debug aspect of the interface, so semihosting will be disabled.
emilmont 44:24d45a770a51 54 * The interface will still support the USB serial aspect
emilmont 27:7110ebee3484 55 *
emilmont 43:e2ed12d17f06 56 * @returns
emilmont 43:e2ed12d17f06 57 * 0 if successful,
emilmont 43:e2ed12d17f06 58 * -1 otherwise (e.g. interface not present)
emilmont 27:7110ebee3484 59 */
emilmont 27:7110ebee3484 60 int mbed_interface_disconnect(void);
emilmont 27:7110ebee3484 61
emilmont 43:e2ed12d17f06 62 /** This will disconnect the debug aspect of the interface, and if the USB cable is not
emilmont 44:24d45a770a51 63 * connected, also power down the interface. If the USB cable is connected, the interface
emilmont 44:24d45a770a51 64 * will remain powered up and visible to the host
emilmont 27:7110ebee3484 65 *
emilmont 43:e2ed12d17f06 66 * @returns
emilmont 43:e2ed12d17f06 67 * 0 if successful,
emilmont 43:e2ed12d17f06 68 * -1 otherwise (e.g. interface not present)
emilmont 27:7110ebee3484 69 */
emilmont 27:7110ebee3484 70 int mbed_interface_powerdown(void);
emilmont 27:7110ebee3484 71
emilmont 43:e2ed12d17f06 72 /** This returns a string containing the 32-character UID of the mbed interface
emilmont 43:e2ed12d17f06 73 * This is a weak function that can be overwritten if required
emilmont 27:7110ebee3484 74 *
emilmont 43:e2ed12d17f06 75 * @param uid A 33-byte array to write the null terminated 32-byte string
emilmont 27:7110ebee3484 76 *
emilmont 43:e2ed12d17f06 77 * @returns
emilmont 43:e2ed12d17f06 78 * 0 if successful,
emilmont 43:e2ed12d17f06 79 * -1 otherwise (e.g. interface not present)
emilmont 27:7110ebee3484 80 */
emilmont 27:7110ebee3484 81 int mbed_interface_uid(char *uid);
emilmont 27:7110ebee3484 82
emilmont 43:e2ed12d17f06 83 /** This returns a unique 6-byte MAC address, based on the interface UID
emilmont 44:24d45a770a51 84 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
emilmont 27:7110ebee3484 85 *
emilmont 44:24d45a770a51 86 * This is a weak function that can be overwritten if you want to provide your own mechanism to
emilmont 44:24d45a770a51 87 * provide a MAC address.
emilmont 43:e2ed12d17f06 88 *
emilmont 43:e2ed12d17f06 89 * @param mac A 6-byte array to write the MAC address
emilmont 27:7110ebee3484 90 */
emilmont 27:7110ebee3484 91 void mbed_mac_address(char *mac);
emilmont 27:7110ebee3484 92
emilmont 43:e2ed12d17f06 93 /** Cause the mbed to flash the BLOD LED sequence
emilmont 27:7110ebee3484 94 */
emilmont 27:7110ebee3484 95 void mbed_die(void);
emilmont 27:7110ebee3484 96
emilmont 27:7110ebee3484 97 #ifdef __cplusplus
emilmont 27:7110ebee3484 98 }
emilmont 27:7110ebee3484 99 #endif
emilmont 27:7110ebee3484 100
emilmont 27:7110ebee3484 101 #endif