jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

mbed_interface.h@71:7ec3cb6bbcc4, 2013-11-29 (annotated)

Committer:
jalp89
Date:
Fri Nov 29 09:39:46 2013 +0000
Revision:
71:7ec3cb6bbcc4
Parent:
66:9c8f0e3462fb 
...

Who changed what in which revision?

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