PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

mbed_src_STM32F7/api/mbed_interface.h@0:aa3fc5ad02f7, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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