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