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.

platform/mbed_interface.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
170:e95d10626187 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1
AnnaBridge 156:ff21514d8981 2 /** \addtogroup platform */
AnnaBridge 156:ff21514d8981 3 /** @{*/
AnnaBridge 158:1c57384330a6 4 /**
AnnaBridge 158:1c57384330a6 5 * \defgroup platform_interface Network interface and other utility functions
AnnaBridge 158:1c57384330a6 6 * @{
AnnaBridge 158:1c57384330a6 7 */
AnnaBridge 158:1c57384330a6 8
AnnaBridge 156:ff21514d8981 9 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 10 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 172:65be27845400 11 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 156:ff21514d8981 12 *
AnnaBridge 156:ff21514d8981 13 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 14 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 15 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 16 *
AnnaBridge 156:ff21514d8981 17 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 18 *
AnnaBridge 156:ff21514d8981 19 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 20 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 22 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 23 * limitations under the License.
AnnaBridge 156:ff21514d8981 24 */
AnnaBridge 156:ff21514d8981 25 #ifndef MBED_INTERFACE_H
AnnaBridge 156:ff21514d8981 26 #define MBED_INTERFACE_H
AnnaBridge 156:ff21514d8981 27
AnnaBridge 156:ff21514d8981 28 #include <stdarg.h>
AnnaBridge 156:ff21514d8981 29
AnnaBridge 172:65be27845400 30 #include "mbed_toolchain.h"
AnnaBridge 156:ff21514d8981 31 #include "device.h"
AnnaBridge 156:ff21514d8981 32
AnnaBridge 156:ff21514d8981 33 /* Mbed interface mac address
AnnaBridge 156:ff21514d8981 34 * if MBED_MAC_ADD_x are zero, interface uid sets mac address,
AnnaBridge 156:ff21514d8981 35 * otherwise MAC_ADD_x are used.
AnnaBridge 156:ff21514d8981 36 */
AnnaBridge 156:ff21514d8981 37 #define MBED_MAC_ADDR_INTERFACE 0x00
AnnaBridge 156:ff21514d8981 38 #define MBED_MAC_ADDR_0 MBED_MAC_ADDR_INTERFACE
AnnaBridge 156:ff21514d8981 39 #define MBED_MAC_ADDR_1 MBED_MAC_ADDR_INTERFACE
AnnaBridge 156:ff21514d8981 40 #define MBED_MAC_ADDR_2 MBED_MAC_ADDR_INTERFACE
AnnaBridge 156:ff21514d8981 41 #define MBED_MAC_ADDR_3 MBED_MAC_ADDR_INTERFACE
AnnaBridge 156:ff21514d8981 42 #define MBED_MAC_ADDR_4 MBED_MAC_ADDR_INTERFACE
AnnaBridge 156:ff21514d8981 43 #define MBED_MAC_ADDR_5 MBED_MAC_ADDR_INTERFACE
AnnaBridge 156:ff21514d8981 44 #define MBED_MAC_ADDRESS_SUM (MBED_MAC_ADDR_0 | MBED_MAC_ADDR_1 | MBED_MAC_ADDR_2 | MBED_MAC_ADDR_3 | MBED_MAC_ADDR_4 | MBED_MAC_ADDR_5)
AnnaBridge 156:ff21514d8981 45
AnnaBridge 156:ff21514d8981 46 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 47 extern "C" {
AnnaBridge 156:ff21514d8981 48 #endif
AnnaBridge 156:ff21514d8981 49
AnnaBridge 156:ff21514d8981 50 #if DEVICE_SEMIHOST
AnnaBridge 156:ff21514d8981 51
AnnaBridge 158:1c57384330a6 52 /**
AnnaBridge 158:1c57384330a6 53 * \defgroup platform_interface interface functions
AnnaBridge 158:1c57384330a6 54 * @{
AnnaBridge 158:1c57384330a6 55 */
AnnaBridge 158:1c57384330a6 56
AnnaBridge 156:ff21514d8981 57 /** Functions to control the mbed interface
AnnaBridge 156:ff21514d8981 58 *
AnnaBridge 156:ff21514d8981 59 * mbed Microcontrollers have a built-in interface to provide functionality such as
AnnaBridge 156:ff21514d8981 60 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
AnnaBridge 156:ff21514d8981 61 * system. These functions provide means to control the interface suing semihost
AnnaBridge 156:ff21514d8981 62 * calls it supports.
AnnaBridge 156:ff21514d8981 63 */
AnnaBridge 156:ff21514d8981 64
AnnaBridge 156:ff21514d8981 65 /** Determine whether the mbed interface is connected, based on whether debug is enabled
AnnaBridge 156:ff21514d8981 66 *
AnnaBridge 156:ff21514d8981 67 * @returns
AnnaBridge 156:ff21514d8981 68 * 1 if interface is connected,
AnnaBridge 156:ff21514d8981 69 * 0 otherwise
AnnaBridge 156:ff21514d8981 70 */
AnnaBridge 156:ff21514d8981 71 int mbed_interface_connected(void);
AnnaBridge 156:ff21514d8981 72
AnnaBridge 156:ff21514d8981 73 /** Instruct the mbed interface to reset, as if the reset button had been pressed
AnnaBridge 156:ff21514d8981 74 *
AnnaBridge 156:ff21514d8981 75 * @returns
AnnaBridge 156:ff21514d8981 76 * 1 if successful,
AnnaBridge 156:ff21514d8981 77 * 0 otherwise (e.g. interface not present)
AnnaBridge 156:ff21514d8981 78 */
AnnaBridge 156:ff21514d8981 79 int mbed_interface_reset(void);
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 /** This will disconnect the debug aspect of the interface, so semihosting will be disabled.
AnnaBridge 156:ff21514d8981 82 * The interface will still support the USB serial aspect
AnnaBridge 156:ff21514d8981 83 *
AnnaBridge 156:ff21514d8981 84 * @returns
AnnaBridge 156:ff21514d8981 85 * 0 if successful,
AnnaBridge 156:ff21514d8981 86 * -1 otherwise (e.g. interface not present)
AnnaBridge 156:ff21514d8981 87 */
AnnaBridge 156:ff21514d8981 88 int mbed_interface_disconnect(void);
AnnaBridge 156:ff21514d8981 89
AnnaBridge 156:ff21514d8981 90 /** This will disconnect the debug aspect of the interface, and if the USB cable is not
AnnaBridge 156:ff21514d8981 91 * connected, also power down the interface. If the USB cable is connected, the interface
AnnaBridge 156:ff21514d8981 92 * will remain powered up and visible to the host
AnnaBridge 156:ff21514d8981 93 *
AnnaBridge 156:ff21514d8981 94 * @returns
AnnaBridge 156:ff21514d8981 95 * 0 if successful,
AnnaBridge 156:ff21514d8981 96 * -1 otherwise (e.g. interface not present)
AnnaBridge 156:ff21514d8981 97 */
AnnaBridge 156:ff21514d8981 98 int mbed_interface_powerdown(void);
AnnaBridge 156:ff21514d8981 99
AnnaBridge 156:ff21514d8981 100 /** This returns a string containing the 32-character UID of the mbed interface
AnnaBridge 156:ff21514d8981 101 * This is a weak function that can be overwritten if required
AnnaBridge 156:ff21514d8981 102 *
AnnaBridge 156:ff21514d8981 103 * @param uid A 33-byte array to write the null terminated 32-byte string
AnnaBridge 156:ff21514d8981 104 *
AnnaBridge 156:ff21514d8981 105 * @returns
AnnaBridge 156:ff21514d8981 106 * 0 if successful,
AnnaBridge 156:ff21514d8981 107 * -1 otherwise (e.g. interface not present)
AnnaBridge 156:ff21514d8981 108 */
AnnaBridge 156:ff21514d8981 109 int mbed_interface_uid(char *uid);
AnnaBridge 156:ff21514d8981 110
AnnaBridge 156:ff21514d8981 111 #endif
AnnaBridge 156:ff21514d8981 112
AnnaBridge 156:ff21514d8981 113 /** This returns a unique 6-byte MAC address, based on the interface UID
AnnaBridge 156:ff21514d8981 114 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
AnnaBridge 156:ff21514d8981 115 *
AnnaBridge 156:ff21514d8981 116 * This is a weak function that can be overwritten if you want to provide your own mechanism to
AnnaBridge 156:ff21514d8981 117 * provide a MAC address.
AnnaBridge 156:ff21514d8981 118 *
AnnaBridge 156:ff21514d8981 119 * @param mac A 6-byte array to write the MAC address
AnnaBridge 156:ff21514d8981 120 */
AnnaBridge 156:ff21514d8981 121 void mbed_mac_address(char *mac);
AnnaBridge 156:ff21514d8981 122
AnnaBridge 156:ff21514d8981 123 /** Cause the mbed to flash the BLOD (Blue LEDs Of Death) sequence
AnnaBridge 156:ff21514d8981 124 */
AnnaBridge 172:65be27845400 125 MBED_NORETURN void mbed_die(void);
AnnaBridge 156:ff21514d8981 126
AnnaBridge 156:ff21514d8981 127 /** Print out an error message. This is typically called when
AnnaBridge 156:ff21514d8981 128 * handling a crash.
AnnaBridge 156:ff21514d8981 129 *
AnnaBridge 156:ff21514d8981 130 * @note Synchronization level: Interrupt safe
AnnaBridge 172:65be27845400 131 * @note This uses an internal 128-byte buffer to format the string,
AnnaBridge 172:65be27845400 132 * so the output may be truncated. If you need to write a potentially
AnnaBridge 172:65be27845400 133 * long string, use mbed_error_puts.
AnnaBridge 156:ff21514d8981 134 *
AnnaBridge 156:ff21514d8981 135 * @param format C string that contains data stream to be printed.
AnnaBridge 156:ff21514d8981 136 * Code snippets below show valid format.
AnnaBridge 156:ff21514d8981 137 *
AnnaBridge 156:ff21514d8981 138 * @code
AnnaBridge 156:ff21514d8981 139 * mbed_error_printf("Failed: %s, file: %s, line %d \n", expr, file, line);
AnnaBridge 156:ff21514d8981 140 * @endcode
AnnaBridge 156:ff21514d8981 141 *
AnnaBridge 156:ff21514d8981 142 */
AnnaBridge 172:65be27845400 143 void mbed_error_printf(const char *format, ...) MBED_PRINTF(1, 2);
AnnaBridge 156:ff21514d8981 144
AnnaBridge 156:ff21514d8981 145 /** Print out an error message. Similar to mbed_error_printf
AnnaBridge 156:ff21514d8981 146 * but uses a va_list.
AnnaBridge 156:ff21514d8981 147 *
AnnaBridge 156:ff21514d8981 148 * @note Synchronization level: Interrupt safe
AnnaBridge 156:ff21514d8981 149 *
AnnaBridge 156:ff21514d8981 150 * @param format C string that contains data stream to be printed.
AnnaBridge 156:ff21514d8981 151 * @param arg Variable arguments list
AnnaBridge 156:ff21514d8981 152 *
AnnaBridge 156:ff21514d8981 153 */
AnnaBridge 172:65be27845400 154 void mbed_error_vprintf(const char *format, va_list arg) MBED_PRINTF(1, 0);
AnnaBridge 172:65be27845400 155
AnnaBridge 172:65be27845400 156 /** Print out an error message. This is typically called when
AnnaBridge 172:65be27845400 157 * handling a crash.
AnnaBridge 172:65be27845400 158 *
AnnaBridge 172:65be27845400 159 * Unlike mbed_error_printf, there is no limit to the maximum output
AnnaBridge 172:65be27845400 160 * length. Unlike standard puts, but like standard fputs, this does not
AnnaBridge 172:65be27845400 161 * append a '\n' character.
AnnaBridge 172:65be27845400 162 *
AnnaBridge 172:65be27845400 163 * @note Synchronization level: Interrupt safe
AnnaBridge 172:65be27845400 164 *
AnnaBridge 172:65be27845400 165 * @param str C string that contains data stream to be printed.
AnnaBridge 172:65be27845400 166 *
AnnaBridge 172:65be27845400 167 */
AnnaBridge 172:65be27845400 168 void mbed_error_puts(const char *str);
AnnaBridge 172:65be27845400 169
AnnaBridge 172:65be27845400 170 /** @deprecated Renamed to mbed_error_vprintf to match functionality */
AnnaBridge 172:65be27845400 171 MBED_DEPRECATED_SINCE("mbed-os-5.11",
AnnaBridge 172:65be27845400 172 "Renamed to mbed_error_vprintf to match functionality.")
AnnaBridge 172:65be27845400 173 void mbed_error_vfprintf(const char *format, va_list arg) MBED_PRINTF(1, 0);
AnnaBridge 158:1c57384330a6 174 /** @}*/
AnnaBridge 156:ff21514d8981 175
AnnaBridge 172:65be27845400 176
AnnaBridge 156:ff21514d8981 177 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 178 }
AnnaBridge 156:ff21514d8981 179 #endif
AnnaBridge 156:ff21514d8981 180
AnnaBridge 156:ff21514d8981 181 #endif
AnnaBridge 156:ff21514d8981 182
AnnaBridge 156:ff21514d8981 183 /** @}*/