mbed libraries for KL25Z
Diff: mbed_interface.h
- Revision:
- 9:663789d7729f
- Parent:
- 8:c14af7958ef5
--- a/mbed_interface.h Fri Nov 09 11:33:53 2012 +0000 +++ b/mbed_interface.h Mon Feb 18 09:41:56 2013 +0000 @@ -1,23 +1,39 @@ -/** Functions to control the mbed interface +/* mbed Microcontroller Library + * Copyright (c) 2006-2013 ARM Limited + * + * 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 * - * 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. - */ - -/* mbed Microcontroller Library - mbed_interface - * Copyright (c) 2009-2011 ARM Limited. All rights reserved. + * http://www.apache.org/licenses/LICENSE-2.0 + * + * 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 + * 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 @@ -41,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, @@ -62,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) * @@ -72,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);