PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/platform/mbed_interface.h@1:b36bbc1c6d27, 2020-04-11 (annotated)

Committer:
demayer
Date:
Sat Apr 11 08:15:48 2020 +0000
Revision:
1:b36bbc1c6d27
Parent:
0:6bf0743ece18 
IMU-library in .h und .cpp file aufgeteilt

Who changed what in which revision?

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