mbed official / mbed-src

mbed library sources

Dependents:   Encrypted my_mbed lklk CyaSSL_DTLS_Cellular ... more

Superseded

This library was superseded by mbed-dev - https://os.mbed.com/users/mbed_official/code/mbed-dev/.

Development branch of the mbed library sources. This library is kept in synch with the latest changes from the mbed SDK and it is not guaranteed to work.

If you are looking for a stable and tested release, please import one of the official mbed library releases:

Import librarymbed

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

Last commit 20 Feb 2019 by mbed official

capi/mbed_interface.h@0:fd0d7bdfcdc2, 2012-11-20 (annotated)

Committer:
mbed_official
Date:
Tue Nov 20 17:24:08 2012 +0000
Revision:
0:fd0d7bdfcdc2
Child:
2:143cac498751
mbed sources

Who changed what in which revision?

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