erez i / mbed

version_2.0

Dependents:   cc3000_ping_demo_try_2

Fork of mbed by mbed official

mbed_interface.h@59:0883845fe643, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 11:12:58 2013 +0000
Revision:
59:0883845fe643
Parent:
55:d722ed6a4237
Child:
65:5798e58a58b1
Add pinmap NC terminators for LPC1768 CAN.

Update the license from MIT to Apache v2.

Make the semihost code target independent using opportune defines for the UID and MAC.

Who changed what in which revision?

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