Damian Gabino / picoGW_mcu

MCU driver/HAL for the Picocell Gateway concentrator board. The firmware implements either a USB CDC protocol or a UART protocol to bridge commands coming from host to the SX1308 SPI interface.

src/mbed-dev/api/mbed_interface.h@0:c76361bd82e8, 2018-04-11 (annotated)

Committer:
dgabino
Date:
Wed Apr 11 14:42:47 2018 +0000
Revision:
0:c76361bd82e8
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
dgabino 0:c76361bd82e8 1 /* mbed Microcontroller Library
dgabino 0:c76361bd82e8 2 * Copyright (c) 2006-2013 ARM Limited
dgabino 0:c76361bd82e8 3 *
dgabino 0:c76361bd82e8 4 * Licensed under the Apache License, Version 2.0 (the "License");
dgabino 0:c76361bd82e8 5 * you may not use this file except in compliance with the License.
dgabino 0:c76361bd82e8 6 * You may obtain a copy of the License at
dgabino 0:c76361bd82e8 7 *
dgabino 0:c76361bd82e8 8 * http://www.apache.org/licenses/LICENSE-2.0
dgabino 0:c76361bd82e8 9 *
dgabino 0:c76361bd82e8 10 * Unless required by applicable law or agreed to in writing, software
dgabino 0:c76361bd82e8 11 * distributed under the License is distributed on an "AS IS" BASIS,
dgabino 0:c76361bd82e8 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
dgabino 0:c76361bd82e8 13 * See the License for the specific language governing permissions and
dgabino 0:c76361bd82e8 14 * limitations under the License.
dgabino 0:c76361bd82e8 15 */
dgabino 0:c76361bd82e8 16 #ifndef MBED_INTERFACE_H
dgabino 0:c76361bd82e8 17 #define MBED_INTERFACE_H
dgabino 0:c76361bd82e8 18
dgabino 0:c76361bd82e8 19 #include <stdarg.h>
dgabino 0:c76361bd82e8 20
dgabino 0:c76361bd82e8 21 #include "device.h"
dgabino 0:c76361bd82e8 22
dgabino 0:c76361bd82e8 23 /* Mbed interface mac address
dgabino 0:c76361bd82e8 24 * if MBED_MAC_ADD_x are zero, interface uid sets mac address,
dgabino 0:c76361bd82e8 25 * otherwise MAC_ADD_x are used.
dgabino 0:c76361bd82e8 26 */
dgabino 0:c76361bd82e8 27 #define MBED_MAC_ADDR_INTERFACE 0x00
dgabino 0:c76361bd82e8 28 #define MBED_MAC_ADDR_0 MBED_MAC_ADDR_INTERFACE
dgabino 0:c76361bd82e8 29 #define MBED_MAC_ADDR_1 MBED_MAC_ADDR_INTERFACE
dgabino 0:c76361bd82e8 30 #define MBED_MAC_ADDR_2 MBED_MAC_ADDR_INTERFACE
dgabino 0:c76361bd82e8 31 #define MBED_MAC_ADDR_3 MBED_MAC_ADDR_INTERFACE
dgabino 0:c76361bd82e8 32 #define MBED_MAC_ADDR_4 MBED_MAC_ADDR_INTERFACE
dgabino 0:c76361bd82e8 33 #define MBED_MAC_ADDR_5 MBED_MAC_ADDR_INTERFACE
dgabino 0:c76361bd82e8 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)
dgabino 0:c76361bd82e8 35
dgabino 0:c76361bd82e8 36 #ifdef __cplusplus
dgabino 0:c76361bd82e8 37 extern "C" {
dgabino 0:c76361bd82e8 38 #endif
dgabino 0:c76361bd82e8 39
dgabino 0:c76361bd82e8 40 #if DEVICE_SEMIHOST
dgabino 0:c76361bd82e8 41
dgabino 0:c76361bd82e8 42 /** Functions to control the mbed interface
dgabino 0:c76361bd82e8 43 *
dgabino 0:c76361bd82e8 44 * mbed Microcontrollers have a built-in interface to provide functionality such as
dgabino 0:c76361bd82e8 45 * drag-n-drop download, reset, serial-over-usb, and access to the mbed local file
dgabino 0:c76361bd82e8 46 * system. These functions provide means to control the interface suing semihost
dgabino 0:c76361bd82e8 47 * calls it supports.
dgabino 0:c76361bd82e8 48 */
dgabino 0:c76361bd82e8 49
dgabino 0:c76361bd82e8 50 /** Determine whether the mbed interface is connected, based on whether debug is enabled
dgabino 0:c76361bd82e8 51 *
dgabino 0:c76361bd82e8 52 * @returns
dgabino 0:c76361bd82e8 53 * 1 if interface is connected,
dgabino 0:c76361bd82e8 54 * 0 otherwise
dgabino 0:c76361bd82e8 55 */
dgabino 0:c76361bd82e8 56 int mbed_interface_connected(void);
dgabino 0:c76361bd82e8 57
dgabino 0:c76361bd82e8 58 /** Instruct the mbed interface to reset, as if the reset button had been pressed
dgabino 0:c76361bd82e8 59 *
dgabino 0:c76361bd82e8 60 * @returns
dgabino 0:c76361bd82e8 61 * 1 if successful,
dgabino 0:c76361bd82e8 62 * 0 otherwise (e.g. interface not present)
dgabino 0:c76361bd82e8 63 */
dgabino 0:c76361bd82e8 64 int mbed_interface_reset(void);
dgabino 0:c76361bd82e8 65
dgabino 0:c76361bd82e8 66 /** This will disconnect the debug aspect of the interface, so semihosting will be disabled.
dgabino 0:c76361bd82e8 67 * The interface will still support the USB serial aspect
dgabino 0:c76361bd82e8 68 *
dgabino 0:c76361bd82e8 69 * @returns
dgabino 0:c76361bd82e8 70 * 0 if successful,
dgabino 0:c76361bd82e8 71 * -1 otherwise (e.g. interface not present)
dgabino 0:c76361bd82e8 72 */
dgabino 0:c76361bd82e8 73 int mbed_interface_disconnect(void);
dgabino 0:c76361bd82e8 74
dgabino 0:c76361bd82e8 75 /** This will disconnect the debug aspect of the interface, and if the USB cable is not
dgabino 0:c76361bd82e8 76 * connected, also power down the interface. If the USB cable is connected, the interface
dgabino 0:c76361bd82e8 77 * will remain powered up and visible to the host
dgabino 0:c76361bd82e8 78 *
dgabino 0:c76361bd82e8 79 * @returns
dgabino 0:c76361bd82e8 80 * 0 if successful,
dgabino 0:c76361bd82e8 81 * -1 otherwise (e.g. interface not present)
dgabino 0:c76361bd82e8 82 */
dgabino 0:c76361bd82e8 83 int mbed_interface_powerdown(void);
dgabino 0:c76361bd82e8 84
dgabino 0:c76361bd82e8 85 /** This returns a string containing the 32-character UID of the mbed interface
dgabino 0:c76361bd82e8 86 * This is a weak function that can be overwritten if required
dgabino 0:c76361bd82e8 87 *
dgabino 0:c76361bd82e8 88 * @param uid A 33-byte array to write the null terminated 32-byte string
dgabino 0:c76361bd82e8 89 *
dgabino 0:c76361bd82e8 90 * @returns
dgabino 0:c76361bd82e8 91 * 0 if successful,
dgabino 0:c76361bd82e8 92 * -1 otherwise (e.g. interface not present)
dgabino 0:c76361bd82e8 93 */
dgabino 0:c76361bd82e8 94 int mbed_interface_uid(char *uid);
dgabino 0:c76361bd82e8 95
dgabino 0:c76361bd82e8 96 #endif
dgabino 0:c76361bd82e8 97
dgabino 0:c76361bd82e8 98 /** This returns a unique 6-byte MAC address, based on the interface UID
dgabino 0:c76361bd82e8 99 * If the interface is not present, it returns a default fixed MAC address (00:02:F7:F0:00:00)
dgabino 0:c76361bd82e8 100 *
dgabino 0:c76361bd82e8 101 * This is a weak function that can be overwritten if you want to provide your own mechanism to
dgabino 0:c76361bd82e8 102 * provide a MAC address.
dgabino 0:c76361bd82e8 103 *
dgabino 0:c76361bd82e8 104 * @param mac A 6-byte array to write the MAC address
dgabino 0:c76361bd82e8 105 */
dgabino 0:c76361bd82e8 106 void mbed_mac_address(char *mac);
dgabino 0:c76361bd82e8 107
dgabino 0:c76361bd82e8 108 /** Cause the mbed to flash the BLOD (Blue LEDs Of Death) sequence
dgabino 0:c76361bd82e8 109 */
dgabino 0:c76361bd82e8 110 void mbed_die(void);
dgabino 0:c76361bd82e8 111
dgabino 0:c76361bd82e8 112 /** Print out an error message. This is typically called when
dgabino 0:c76361bd82e8 113 * hanlding a crash.
dgabino 0:c76361bd82e8 114 *
dgabino 0:c76361bd82e8 115 * @Note Synchronization level: Interrupt safe
dgabino 0:c76361bd82e8 116 */
dgabino 0:c76361bd82e8 117 void mbed_error_printf(const char* format, ...);
dgabino 0:c76361bd82e8 118
dgabino 0:c76361bd82e8 119 /** Print out an error message. Similar to mbed_error_printf
dgabino 0:c76361bd82e8 120 * but uses a va_list.
dgabino 0:c76361bd82e8 121 *
dgabino 0:c76361bd82e8 122 * @Note Synchronization level: Interrupt safe
dgabino 0:c76361bd82e8 123 */
dgabino 0:c76361bd82e8 124 void mbed_error_vfprintf(const char * format, va_list arg);
dgabino 0:c76361bd82e8 125
dgabino 0:c76361bd82e8 126 #ifdef __cplusplus
dgabino 0:c76361bd82e8 127 }
dgabino 0:c76361bd82e8 128 #endif
dgabino 0:c76361bd82e8 129
dgabino 0:c76361bd82e8 130 #endif