Vladimir Vana / mbed

pro vyuku PSS v Jecne

mbed_interface.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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