mbed library sources
Fork of mbed-src by
Diff: capi/mbed_interface.h
- Revision:
- 2:143cac498751
- Parent:
- 0:fd0d7bdfcdc2
--- a/capi/mbed_interface.h Thu Nov 29 15:41:14 2012 +0000 +++ b/capi/mbed_interface.h Mon Feb 18 11:44:18 2013 +0000 @@ -1,41 +1,39 @@ /* mbed Microcontroller Library - * Copyright (c) 2006-2012 ARM Limited + * Copyright (c) 2006-2013 ARM Limited * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. + * http://www.apache.org/licenses/LICENSE-2.0 * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ #ifndef MBED_INTERFACE_H #define MBED_INTERFACE_H +#include "device.h" + #ifdef __cplusplus extern "C" { #endif +#if DEVICE_SEMIHOST + /** Functions to control the mbed interface * - * mbed Microcontrollers have a built-in interface to provide functionality such as - * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file + * mbed Microcontrollers have a built-in interface to provide functionality such as + * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file * system. These functions provide means to control the interface suing semihost * calls it supports. */ /** Determine whether the mbed interface is connected, based on whether debug is enabled - * + * * @returns * 1 if interface is connected, * 0 otherwise @@ -59,9 +57,9 @@ */ int mbed_interface_disconnect(void); -/** This will disconnect the debug aspect of the interface, and if the USB cable is not +/** This will disconnect the debug aspect of the interface, and if the USB cable is not * connected, also power down the interface. If the USB cable is connected, the interface - * will remain powered up and visible to the host + * will remain powered up and visible to the host * * @returns * 0 if successful, @@ -80,6 +78,8 @@ */ int mbed_interface_uid(char *uid); +#endif + /** This returns a unique 6-byte MAC address, based on the interface UID * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00) * @@ -90,7 +90,7 @@ */ void mbed_mac_address(char *mac); -/** Cause the mbed to flash the BLOD LED sequence +/** Cause the mbed to flash the BLOD (Blue LEDs Of Death) sequence */ void mbed_die(void);