clement lignie / configure_ax12_test_bras_module

config AX12

Fork of configure_ax12_test_bras_module by CRAC Team

mbed/mbed_interface.h@2:91b6646ea994, 2017-02-01 (annotated)

Committer:
clementlignie
Date:
Wed Feb 01 13:42:30 2017 +0000
Revision:
2:91b6646ea994
Parent:
0:c03cffe402df 
config AX12

Who changed what in which revision?

UserRevisionLine numberNew contents of line
slowness 0:c03cffe402df 1 /* Title: mbed_interface
slowness 0:c03cffe402df 2 * Functions to control the mbed interface
slowness 0:c03cffe402df 3 *
slowness 0:c03cffe402df 4 * mbed Microcontrollers have a built-in interface to provide functionality such as
slowness 0:c03cffe402df 5 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
slowness 0:c03cffe402df 6 * system. These functions provide means to control the interface suing semihost
slowness 0:c03cffe402df 7 * calls it supports.
slowness 0:c03cffe402df 8 */
slowness 0:c03cffe402df 9
slowness 0:c03cffe402df 10 /* mbed Microcontroller Library - mbed_interface
slowness 0:c03cffe402df 11 * Copyright (c) 2009-2011 ARM Limited. All rights reserved.
slowness 0:c03cffe402df 12 */
slowness 0:c03cffe402df 13
slowness 0:c03cffe402df 14 #ifndef MBED_INTERFACE_H
slowness 0:c03cffe402df 15 #define MBED_INTERFACE_H
slowness 0:c03cffe402df 16
slowness 0:c03cffe402df 17 #ifdef __cplusplus
slowness 0:c03cffe402df 18 extern "C" {
slowness 0:c03cffe402df 19 #endif
slowness 0:c03cffe402df 20
slowness 0:c03cffe402df 21 /* Function: mbed_interface_connected
slowness 0:c03cffe402df 22 * Determine whether the mbed interface is connected, based on whether debug is enabled
slowness 0:c03cffe402df 23 *
slowness 0:c03cffe402df 24 * Variables:
slowness 0:c03cffe402df 25 * returns - 1 if interface is connected, else 0
slowness 0:c03cffe402df 26 */
slowness 0:c03cffe402df 27 int mbed_interface_connected(void);
slowness 0:c03cffe402df 28
slowness 0:c03cffe402df 29 /* Function: mbed_interface_reset
slowness 0:c03cffe402df 30 * Instruct the mbed interface to reset, as if the reset button had been pressed
slowness 0:c03cffe402df 31 *
slowness 0:c03cffe402df 32 * Variables:
slowness 0:c03cffe402df 33 * returns - 1 if successful, else 0 (e.g. interface not present)
slowness 0:c03cffe402df 34 */
slowness 0:c03cffe402df 35 int mbed_interface_reset(void);
slowness 0:c03cffe402df 36
slowness 0:c03cffe402df 37 /* Function: mbed_interface_disconnect
slowness 0:c03cffe402df 38 * This will disconnect the debug aspect of the interface, so semihosting will be disabled.
slowness 0:c03cffe402df 39 * The interface will still support the USB serial aspect
slowness 0:c03cffe402df 40 *
slowness 0:c03cffe402df 41 * Variables:
slowness 0:c03cffe402df 42 * returns - 0 if successful, else -1 (e.g. interface not present)
slowness 0:c03cffe402df 43 */
slowness 0:c03cffe402df 44 int mbed_interface_disconnect(void);
slowness 0:c03cffe402df 45
slowness 0:c03cffe402df 46 /* Function: mbed_interface_powerdown
slowness 0:c03cffe402df 47 * This will disconnect the debug aspect of the interface, and if the USB cable is not
slowness 0:c03cffe402df 48 * connected, also power down the interface. If the USB cable is connected, the interface
slowness 0:c03cffe402df 49 * will remain powered up and visible to the host
slowness 0:c03cffe402df 50 *
slowness 0:c03cffe402df 51 * Variables:
slowness 0:c03cffe402df 52 * returns - 0 if successful, else -1 (e.g. interface not present)
slowness 0:c03cffe402df 53 */
slowness 0:c03cffe402df 54 int mbed_interface_powerdown(void);
slowness 0:c03cffe402df 55
slowness 0:c03cffe402df 56 /* Function: mbed_interface_uid
slowness 0:c03cffe402df 57 * This returns a string containing the 32-character UID of the mbed interface
slowness 0:c03cffe402df 58 *
slowness 0:c03cffe402df 59 * This is a weak function that can be overwritten if required
slowness 0:c03cffe402df 60 *
slowness 0:c03cffe402df 61 * Variables:
slowness 0:c03cffe402df 62 * uid - A 33-byte array to write the null terminated 32-byte string
slowness 0:c03cffe402df 63 * returns - 0 if successful, else -1 (e.g. interface not present)
slowness 0:c03cffe402df 64 */
slowness 0:c03cffe402df 65 int mbed_interface_uid(char *uid);
slowness 0:c03cffe402df 66
slowness 0:c03cffe402df 67 /* Function: mbed_mac_address
slowness 0:c03cffe402df 68 * This returns a unique 6-byte MAC address, based on the interface UID
slowness 0:c03cffe402df 69 *
slowness 0:c03cffe402df 70 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
slowness 0:c03cffe402df 71 *
slowness 0:c03cffe402df 72 * This is a weak function that can be overwritten if you want to provide your own mechanism to
slowness 0:c03cffe402df 73 * provide a MAC address.
slowness 0:c03cffe402df 74
slowness 0:c03cffe402df 75 * Variables:
slowness 0:c03cffe402df 76 * mac - A 6-byte array to write the MAC address
slowness 0:c03cffe402df 77 */
slowness 0:c03cffe402df 78 void mbed_mac_address(char *mac);
slowness 0:c03cffe402df 79
slowness 0:c03cffe402df 80 /* Function: mbed_die
slowness 0:c03cffe402df 81 * Cause the mbed to flash the BLOD LED sequence
slowness 0:c03cffe402df 82 */
slowness 0:c03cffe402df 83 void mbed_die(void);
slowness 0:c03cffe402df 84
slowness 0:c03cffe402df 85 #ifdef __cplusplus
slowness 0:c03cffe402df 86 }
slowness 0:c03cffe402df 87 #endif
slowness 0:c03cffe402df 88
slowness 0:c03cffe402df 89 #endif