zhang boie / mbed-dev-f30333

platform/mbed_interface.h@0:bdf663c61a82, 2022-06-14 (annotated)

Committer:
abe5b02d-a2d4-4fe9-818e-c4e57c809ea4
Date:
Tue Jun 14 09:21:18 2022 +0000
Revision:
0:bdf663c61a82
lib

Who changed what in which revision?

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