mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

mbed_interface.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
66:9c8f0e3462fb 
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

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
Kojto 122:f9eeca106725 19 #include <stdarg.h>
Kojto 122:f9eeca106725 20
bogdanm 65:5798e58a58b1 21 #include "device.h"
bogdanm 65:5798e58a58b1 22
bogdanm 66:9c8f0e3462fb 23 /* Mbed interface mac address
bogdanm 66:9c8f0e3462fb 24 * if MBED_MAC_ADD_x are zero, interface uid sets mac address,
bogdanm 66:9c8f0e3462fb 25 * otherwise MAC_ADD_x are used.
bogdanm 66:9c8f0e3462fb 26 */
bogdanm 66:9c8f0e3462fb 27 #define MBED_MAC_ADDR_INTERFACE 0x00
bogdanm 66:9c8f0e3462fb 28 #define MBED_MAC_ADDR_0 MBED_MAC_ADDR_INTERFACE
bogdanm 66:9c8f0e3462fb 29 #define MBED_MAC_ADDR_1 MBED_MAC_ADDR_INTERFACE
bogdanm 66:9c8f0e3462fb 30 #define MBED_MAC_ADDR_2 MBED_MAC_ADDR_INTERFACE
bogdanm 66:9c8f0e3462fb 31 #define MBED_MAC_ADDR_3 MBED_MAC_ADDR_INTERFACE
bogdanm 66:9c8f0e3462fb 32 #define MBED_MAC_ADDR_4 MBED_MAC_ADDR_INTERFACE
bogdanm 66:9c8f0e3462fb 33 #define MBED_MAC_ADDR_5 MBED_MAC_ADDR_INTERFACE
bogdanm 66:9c8f0e3462fb 34 #define MBED_MAC_ADDRESS_SUM (MBED_MAC_ADDR_0 | MBED_MAC_ADDR_1 | MBED_MAC_ADDR_2 | MBED_MAC_ADDR_3 | MBED_MAC_ADDR_4 | MBED_MAC_ADDR_5)
bogdanm 66:9c8f0e3462fb 35
bogdanm 65:5798e58a58b1 36 #ifdef __cplusplus
bogdanm 65:5798e58a58b1 37 extern "C" {
bogdanm 65:5798e58a58b1 38 #endif
bogdanm 65:5798e58a58b1 39
bogdanm 65:5798e58a58b1 40 #if DEVICE_SEMIHOST
bogdanm 65:5798e58a58b1 41
bogdanm 65:5798e58a58b1 42 /** Functions to control the mbed interface
bogdanm 65:5798e58a58b1 43 *
bogdanm 65:5798e58a58b1 44 * mbed Microcontrollers have a built-in interface to provide functionality such as
bogdanm 65:5798e58a58b1 45 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
bogdanm 65:5798e58a58b1 46 * system. These functions provide means to control the interface suing semihost
bogdanm 65:5798e58a58b1 47 * calls it supports.
bogdanm 65:5798e58a58b1 48 */
bogdanm 65:5798e58a58b1 49
bogdanm 65:5798e58a58b1 50 /** Determine whether the mbed interface is connected, based on whether debug is enabled
bogdanm 65:5798e58a58b1 51 *
bogdanm 65:5798e58a58b1 52 * @returns
bogdanm 65:5798e58a58b1 53 * 1 if interface is connected,
bogdanm 65:5798e58a58b1 54 * 0 otherwise
bogdanm 65:5798e58a58b1 55 */
bogdanm 65:5798e58a58b1 56 int mbed_interface_connected(void);
bogdanm 65:5798e58a58b1 57
bogdanm 65:5798e58a58b1 58 /** Instruct the mbed interface to reset, as if the reset button had been pressed
bogdanm 65:5798e58a58b1 59 *
bogdanm 65:5798e58a58b1 60 * @returns
bogdanm 65:5798e58a58b1 61 * 1 if successful,
bogdanm 65:5798e58a58b1 62 * 0 otherwise (e.g. interface not present)
bogdanm 65:5798e58a58b1 63 */
bogdanm 65:5798e58a58b1 64 int mbed_interface_reset(void);
bogdanm 65:5798e58a58b1 65
bogdanm 65:5798e58a58b1 66 /** This will disconnect the debug aspect of the interface, so semihosting will be disabled.
bogdanm 65:5798e58a58b1 67 * The interface will still support the USB serial aspect
bogdanm 65:5798e58a58b1 68 *
bogdanm 65:5798e58a58b1 69 * @returns
bogdanm 65:5798e58a58b1 70 * 0 if successful,
bogdanm 65:5798e58a58b1 71 * -1 otherwise (e.g. interface not present)
bogdanm 65:5798e58a58b1 72 */
bogdanm 65:5798e58a58b1 73 int mbed_interface_disconnect(void);
bogdanm 65:5798e58a58b1 74
bogdanm 65:5798e58a58b1 75 /** This will disconnect the debug aspect of the interface, and if the USB cable is not
bogdanm 65:5798e58a58b1 76 * connected, also power down the interface. If the USB cable is connected, the interface
bogdanm 65:5798e58a58b1 77 * will remain powered up and visible to the host
bogdanm 65:5798e58a58b1 78 *
bogdanm 65:5798e58a58b1 79 * @returns
bogdanm 65:5798e58a58b1 80 * 0 if successful,
bogdanm 65:5798e58a58b1 81 * -1 otherwise (e.g. interface not present)
bogdanm 65:5798e58a58b1 82 */
bogdanm 65:5798e58a58b1 83 int mbed_interface_powerdown(void);
bogdanm 65:5798e58a58b1 84
bogdanm 65:5798e58a58b1 85 /** This returns a string containing the 32-character UID of the mbed interface
bogdanm 65:5798e58a58b1 86 * This is a weak function that can be overwritten if required
bogdanm 65:5798e58a58b1 87 *
bogdanm 65:5798e58a58b1 88 * @param uid A 33-byte array to write the null terminated 32-byte string
bogdanm 65:5798e58a58b1 89 *
bogdanm 65:5798e58a58b1 90 * @returns
bogdanm 65:5798e58a58b1 91 * 0 if successful,
bogdanm 65:5798e58a58b1 92 * -1 otherwise (e.g. interface not present)
bogdanm 65:5798e58a58b1 93 */
bogdanm 65:5798e58a58b1 94 int mbed_interface_uid(char *uid);
bogdanm 65:5798e58a58b1 95
bogdanm 65:5798e58a58b1 96 #endif
bogdanm 65:5798e58a58b1 97
bogdanm 65:5798e58a58b1 98 /** This returns a unique 6-byte MAC address, based on the interface UID
bogdanm 65:5798e58a58b1 99 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
bogdanm 65:5798e58a58b1 100 *
bogdanm 65:5798e58a58b1 101 * This is a weak function that can be overwritten if you want to provide your own mechanism to
bogdanm 65:5798e58a58b1 102 * provide a MAC address.
bogdanm 65:5798e58a58b1 103 *
bogdanm 65:5798e58a58b1 104 * @param mac A 6-byte array to write the MAC address
bogdanm 65:5798e58a58b1 105 */
bogdanm 65:5798e58a58b1 106 void mbed_mac_address(char *mac);
bogdanm 65:5798e58a58b1 107
bogdanm 65:5798e58a58b1 108 /** Cause the mbed to flash the BLOD (Blue LEDs Of Death) sequence
bogdanm 65:5798e58a58b1 109 */
bogdanm 65:5798e58a58b1 110 void mbed_die(void);
bogdanm 65:5798e58a58b1 111
Kojto 122:f9eeca106725 112 /** Print out an error message. This is typically called when
Kojto 122:f9eeca106725 113 * hanlding a crash.
Kojto 122:f9eeca106725 114 *
Kojto 122:f9eeca106725 115 * @Note Synchronization level: Interrupt safe
Kojto 122:f9eeca106725 116 */
Kojto 122:f9eeca106725 117 void mbed_error_printf(const char* format, ...);
Kojto 122:f9eeca106725 118
Kojto 122:f9eeca106725 119 /** Print out an error message. Similar to mbed_error_printf
Kojto 122:f9eeca106725 120 * but uses a va_list.
Kojto 122:f9eeca106725 121 *
Kojto 122:f9eeca106725 122 * @Note Synchronization level: Interrupt safe
Kojto 122:f9eeca106725 123 */
Kojto 122:f9eeca106725 124 void mbed_error_vfprintf(const char * format, va_list arg);
Kojto 122:f9eeca106725 125
bogdanm 65:5798e58a58b1 126 #ifdef __cplusplus
bogdanm 65:5798e58a58b1 127 }
bogdanm 65:5798e58a58b1 128 #endif
bogdanm 65:5798e58a58b1 129
bogdanm 65:5798e58a58b1 130 #endif