jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

mbed_interface.h@65:5798e58a58b1, 2013-08-12 (annotated)

Committer:
bogdanm
Date:
Mon Aug 12 13:17:46 2013 +0300
Revision:
65:5798e58a58b1
Parent:
59:0883845fe643
Child:
66:9c8f0e3462fb
New target (LPC4088), new features (interrupt chaining), bug fixes (KL25Z I2C).

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 65:5798e58a58b1 21 #ifdef __cplusplus
bogdanm 65:5798e58a58b1 22 extern "C" {
bogdanm 65:5798e58a58b1 23 #endif
bogdanm 65:5798e58a58b1 24
bogdanm 65:5798e58a58b1 25 #if DEVICE_SEMIHOST
bogdanm 65:5798e58a58b1 26
bogdanm 65:5798e58a58b1 27 /** Functions to control the mbed interface
bogdanm 65:5798e58a58b1 28 *
bogdanm 65:5798e58a58b1 29 * mbed Microcontrollers have a built-in interface to provide functionality such as
bogdanm 65:5798e58a58b1 30 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
bogdanm 65:5798e58a58b1 31 * system. These functions provide means to control the interface suing semihost
bogdanm 65:5798e58a58b1 32 * calls it supports.
bogdanm 65:5798e58a58b1 33 */
bogdanm 65:5798e58a58b1 34
bogdanm 65:5798e58a58b1 35 /** Determine whether the mbed interface is connected, based on whether debug is enabled
bogdanm 65:5798e58a58b1 36 *
bogdanm 65:5798e58a58b1 37 * @returns
bogdanm 65:5798e58a58b1 38 * 1 if interface is connected,
bogdanm 65:5798e58a58b1 39 * 0 otherwise
bogdanm 65:5798e58a58b1 40 */
bogdanm 65:5798e58a58b1 41 int mbed_interface_connected(void);
bogdanm 65:5798e58a58b1 42
bogdanm 65:5798e58a58b1 43 /** Instruct the mbed interface to reset, as if the reset button had been pressed
bogdanm 65:5798e58a58b1 44 *
bogdanm 65:5798e58a58b1 45 * @returns
bogdanm 65:5798e58a58b1 46 * 1 if successful,
bogdanm 65:5798e58a58b1 47 * 0 otherwise (e.g. interface not present)
bogdanm 65:5798e58a58b1 48 */
bogdanm 65:5798e58a58b1 49 int mbed_interface_reset(void);
bogdanm 65:5798e58a58b1 50
bogdanm 65:5798e58a58b1 51 /** This will disconnect the debug aspect of the interface, so semihosting will be disabled.
bogdanm 65:5798e58a58b1 52 * The interface will still support the USB serial aspect
bogdanm 65:5798e58a58b1 53 *
bogdanm 65:5798e58a58b1 54 * @returns
bogdanm 65:5798e58a58b1 55 * 0 if successful,
bogdanm 65:5798e58a58b1 56 * -1 otherwise (e.g. interface not present)
bogdanm 65:5798e58a58b1 57 */
bogdanm 65:5798e58a58b1 58 int mbed_interface_disconnect(void);
bogdanm 65:5798e58a58b1 59
bogdanm 65:5798e58a58b1 60 /** This will disconnect the debug aspect of the interface, and if the USB cable is not
bogdanm 65:5798e58a58b1 61 * connected, also power down the interface. If the USB cable is connected, the interface
bogdanm 65:5798e58a58b1 62 * will remain powered up and visible to the host
bogdanm 65:5798e58a58b1 63 *
bogdanm 65:5798e58a58b1 64 * @returns
bogdanm 65:5798e58a58b1 65 * 0 if successful,
bogdanm 65:5798e58a58b1 66 * -1 otherwise (e.g. interface not present)
bogdanm 65:5798e58a58b1 67 */
bogdanm 65:5798e58a58b1 68 int mbed_interface_powerdown(void);
bogdanm 65:5798e58a58b1 69
bogdanm 65:5798e58a58b1 70 /** This returns a string containing the 32-character UID of the mbed interface
bogdanm 65:5798e58a58b1 71 * This is a weak function that can be overwritten if required
bogdanm 65:5798e58a58b1 72 *
bogdanm 65:5798e58a58b1 73 * @param uid A 33-byte array to write the null terminated 32-byte string
bogdanm 65:5798e58a58b1 74 *
bogdanm 65:5798e58a58b1 75 * @returns
bogdanm 65:5798e58a58b1 76 * 0 if successful,
bogdanm 65:5798e58a58b1 77 * -1 otherwise (e.g. interface not present)
bogdanm 65:5798e58a58b1 78 */
bogdanm 65:5798e58a58b1 79 int mbed_interface_uid(char *uid);
bogdanm 65:5798e58a58b1 80
bogdanm 65:5798e58a58b1 81 #endif
bogdanm 65:5798e58a58b1 82
bogdanm 65:5798e58a58b1 83 /** This returns a unique 6-byte MAC address, based on the interface UID
bogdanm 65:5798e58a58b1 84 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
bogdanm 65:5798e58a58b1 85 *
bogdanm 65:5798e58a58b1 86 * This is a weak function that can be overwritten if you want to provide your own mechanism to
bogdanm 65:5798e58a58b1 87 * provide a MAC address.
bogdanm 65:5798e58a58b1 88 *
bogdanm 65:5798e58a58b1 89 * @param mac A 6-byte array to write the MAC address
bogdanm 65:5798e58a58b1 90 */
bogdanm 65:5798e58a58b1 91 void mbed_mac_address(char *mac);
bogdanm 65:5798e58a58b1 92
bogdanm 65:5798e58a58b1 93 /** Cause the mbed to flash the BLOD (Blue LEDs Of Death) sequence
bogdanm 65:5798e58a58b1 94 */
bogdanm 65:5798e58a58b1 95 void mbed_die(void);
bogdanm 65:5798e58a58b1 96
bogdanm 65:5798e58a58b1 97 #ifdef __cplusplus
bogdanm 65:5798e58a58b1 98 }
bogdanm 65:5798e58a58b1 99 #endif
bogdanm 65:5798e58a58b1 100
bogdanm 65:5798e58a58b1 101 #endif