CRAC Team / command_AX12_petit_robot_V4tempo

code ax12 petit robot 12/05/2017

Fork of command_AX12_petit_robot_V3 by CRAC Team

mbed/mbed_interface.h@7:ad4a19e26b84, 2017-05-12 (annotated)

Committer:
ClementBreteau
Date:
Fri May 12 14:35:09 2017 +0000
Revision:
7:ad4a19e26b84
Parent:
2:99b1cb0d9f5e 
position ax12

Who changed what in which revision?

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