Maxim Integrated / Mbed OS HSP_RPC_GUI

MAX32620HSP (MAXREFDES100) RPC Example for Graphical User Interface

Dependencies:   USBDevice

Fork of HSP_Release by Jerry Bradshaw

This is an example program for the MAX32620HSP (MAXREFDES100 Health Sensor Platform). It demonstrates all the features of the platform and works with a companion graphical user interface (GUI) to help evaluate/configure/monitor the board. Go to the MAXREFDES100 product page and click on "design resources" to download the companion software. The GUI connects to the board through an RPC interface on a virtual serial port over the USB interface.

The RPC interface provides access to all the features of the board and is available to interface with other development environments such Matlab. This firmware provides realtime data streaming through the RPC interface over USB, and also provides the ability to log the data to flash for untethered battery operation. The data logging settings are configured through the GUI, and the GUI also provides the interface to download logged data.

Details on the RPC interface can be found here: HSP RPC Interface Documentation

Windows

With this program loaded, the MAX32620HSP will appear on your computer as a serial port. On Mac and Linux, this will happen by default. For Windows, you need to install a driver: HSP serial port windows driver

For more details about this platform and how to use it, see the MAXREFDES100 product page.

HSP/RpcServer/RpcFifo.cpp@0:e4a10ed6eb92, 2016-10-25 (annotated)

Committer:
jbradshaw
Date:
Tue Oct 25 15:22:11 2016 +0000
Revision:
0:e4a10ed6eb92
tewt

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jbradshaw 0:e4a10ed6eb92 1 /*******************************************************************************
jbradshaw 0:e4a10ed6eb92 2 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
jbradshaw 0:e4a10ed6eb92 3 *
jbradshaw 0:e4a10ed6eb92 4 * Permission is hereby granted, free of charge, to any person obtaining a
jbradshaw 0:e4a10ed6eb92 5 * copy of this software and associated documentation files (the "Software"),
jbradshaw 0:e4a10ed6eb92 6 * to deal in the Software without restriction, including without limitation
jbradshaw 0:e4a10ed6eb92 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
jbradshaw 0:e4a10ed6eb92 8 * and/or sell copies of the Software, and to permit persons to whom the
jbradshaw 0:e4a10ed6eb92 9 * Software is furnished to do so, subject to the following conditions:
jbradshaw 0:e4a10ed6eb92 10 *
jbradshaw 0:e4a10ed6eb92 11 * The above copyright notice and this permission notice shall be included
jbradshaw 0:e4a10ed6eb92 12 * in all copies or substantial portions of the Software.
jbradshaw 0:e4a10ed6eb92 13 *
jbradshaw 0:e4a10ed6eb92 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
jbradshaw 0:e4a10ed6eb92 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
jbradshaw 0:e4a10ed6eb92 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
jbradshaw 0:e4a10ed6eb92 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
jbradshaw 0:e4a10ed6eb92 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
jbradshaw 0:e4a10ed6eb92 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
jbradshaw 0:e4a10ed6eb92 20 * OTHER DEALINGS IN THE SOFTWARE.
jbradshaw 0:e4a10ed6eb92 21 *
jbradshaw 0:e4a10ed6eb92 22 * Except as contained in this notice, the name of Maxim Integrated
jbradshaw 0:e4a10ed6eb92 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
jbradshaw 0:e4a10ed6eb92 24 * Products, Inc. Branding Policy.
jbradshaw 0:e4a10ed6eb92 25 *
jbradshaw 0:e4a10ed6eb92 26 * The mere transfer of this software does not imply any licenses
jbradshaw 0:e4a10ed6eb92 27 * of trade secrets, proprietary technology, copyrights, patents,
jbradshaw 0:e4a10ed6eb92 28 * trademarks, maskwork rights, or any other form of intellectual
jbradshaw 0:e4a10ed6eb92 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
jbradshaw 0:e4a10ed6eb92 30 * ownership rights.
jbradshaw 0:e4a10ed6eb92 31 *******************************************************************************
jbradshaw 0:e4a10ed6eb92 32 */
jbradshaw 0:e4a10ed6eb92 33 #include "mbed.h"
jbradshaw 0:e4a10ed6eb92 34 #include "RpcFifo.h"
jbradshaw 0:e4a10ed6eb92 35
jbradshaw 0:e4a10ed6eb92 36 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 37 void fifo_init(fifo_t *fifo, void *mem, unsigned int length) {
jbradshaw 0:e4a10ed6eb92 38 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 39 __disable_irq();
jbradshaw 0:e4a10ed6eb92 40
jbradshaw 0:e4a10ed6eb92 41 fifo->rindex = 0;
jbradshaw 0:e4a10ed6eb92 42 fifo->windex = 0;
jbradshaw 0:e4a10ed6eb92 43 fifo->data = mem;
jbradshaw 0:e4a10ed6eb92 44 fifo->length = length;
jbradshaw 0:e4a10ed6eb92 45
jbradshaw 0:e4a10ed6eb92 46 __enable_irq();
jbradshaw 0:e4a10ed6eb92 47 }
jbradshaw 0:e4a10ed6eb92 48
jbradshaw 0:e4a10ed6eb92 49 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 50 int fifo_put8(fifo_t *fifo, uint8_t element) {
jbradshaw 0:e4a10ed6eb92 51 // Check if FIFO is full
jbradshaw 0:e4a10ed6eb92 52 if ((fifo->windex == (fifo->rindex - 1)) ||
jbradshaw 0:e4a10ed6eb92 53 ((fifo->rindex == 0) && (fifo->windex == (fifo->length - 1)))) {
jbradshaw 0:e4a10ed6eb92 54 return -1;
jbradshaw 0:e4a10ed6eb92 55 }
jbradshaw 0:e4a10ed6eb92 56
jbradshaw 0:e4a10ed6eb92 57 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 58 __disable_irq();
jbradshaw 0:e4a10ed6eb92 59
jbradshaw 0:e4a10ed6eb92 60 // Put data into FIFO
jbradshaw 0:e4a10ed6eb92 61 ((uint8_t *)(fifo->data))[fifo->windex] = element;
jbradshaw 0:e4a10ed6eb92 62
jbradshaw 0:e4a10ed6eb92 63 // Increment pointer
jbradshaw 0:e4a10ed6eb92 64 fifo->windex++;
jbradshaw 0:e4a10ed6eb92 65 if (fifo->windex == fifo->length) {
jbradshaw 0:e4a10ed6eb92 66 fifo->windex = 0;
jbradshaw 0:e4a10ed6eb92 67 }
jbradshaw 0:e4a10ed6eb92 68
jbradshaw 0:e4a10ed6eb92 69 __enable_irq();
jbradshaw 0:e4a10ed6eb92 70
jbradshaw 0:e4a10ed6eb92 71 return 0;
jbradshaw 0:e4a10ed6eb92 72 }
jbradshaw 0:e4a10ed6eb92 73
jbradshaw 0:e4a10ed6eb92 74 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 75 int fifo_get8(fifo_t *fifo, uint8_t *element) {
jbradshaw 0:e4a10ed6eb92 76 // Check if FIFO is empty
jbradshaw 0:e4a10ed6eb92 77 if (fifo->rindex == fifo->windex)
jbradshaw 0:e4a10ed6eb92 78 return -1;
jbradshaw 0:e4a10ed6eb92 79
jbradshaw 0:e4a10ed6eb92 80 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 81 __disable_irq();
jbradshaw 0:e4a10ed6eb92 82
jbradshaw 0:e4a10ed6eb92 83 // Get data from FIFO
jbradshaw 0:e4a10ed6eb92 84 *element = ((uint8_t *)(fifo->data))[fifo->rindex];
jbradshaw 0:e4a10ed6eb92 85
jbradshaw 0:e4a10ed6eb92 86 // Increment pointer
jbradshaw 0:e4a10ed6eb92 87 fifo->rindex++;
jbradshaw 0:e4a10ed6eb92 88 if (fifo->rindex == fifo->length) {
jbradshaw 0:e4a10ed6eb92 89 fifo->rindex = 0;
jbradshaw 0:e4a10ed6eb92 90 }
jbradshaw 0:e4a10ed6eb92 91
jbradshaw 0:e4a10ed6eb92 92 __enable_irq();
jbradshaw 0:e4a10ed6eb92 93
jbradshaw 0:e4a10ed6eb92 94 return 0;
jbradshaw 0:e4a10ed6eb92 95 }
jbradshaw 0:e4a10ed6eb92 96
jbradshaw 0:e4a10ed6eb92 97 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 98 int fifo_put16(fifo_t *fifo, uint16_t element) {
jbradshaw 0:e4a10ed6eb92 99 // Check if FIFO is full
jbradshaw 0:e4a10ed6eb92 100 if ((fifo->windex == (fifo->rindex - 1)) ||
jbradshaw 0:e4a10ed6eb92 101 ((fifo->rindex == 0) && (fifo->windex == (fifo->length - 1)))) {
jbradshaw 0:e4a10ed6eb92 102 return -1;
jbradshaw 0:e4a10ed6eb92 103 }
jbradshaw 0:e4a10ed6eb92 104
jbradshaw 0:e4a10ed6eb92 105 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 106 __disable_irq();
jbradshaw 0:e4a10ed6eb92 107
jbradshaw 0:e4a10ed6eb92 108 // Put data into FIFO
jbradshaw 0:e4a10ed6eb92 109 ((uint16_t *)(fifo->data))[fifo->windex] = element;
jbradshaw 0:e4a10ed6eb92 110
jbradshaw 0:e4a10ed6eb92 111 // Increment pointer
jbradshaw 0:e4a10ed6eb92 112 fifo->windex++;
jbradshaw 0:e4a10ed6eb92 113 if (fifo->windex == fifo->length) {
jbradshaw 0:e4a10ed6eb92 114 fifo->windex = 0;
jbradshaw 0:e4a10ed6eb92 115 }
jbradshaw 0:e4a10ed6eb92 116
jbradshaw 0:e4a10ed6eb92 117 __enable_irq();
jbradshaw 0:e4a10ed6eb92 118
jbradshaw 0:e4a10ed6eb92 119 return 0;
jbradshaw 0:e4a10ed6eb92 120 }
jbradshaw 0:e4a10ed6eb92 121
jbradshaw 0:e4a10ed6eb92 122 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 123 int fifo_get16(fifo_t *fifo, uint16_t *element) {
jbradshaw 0:e4a10ed6eb92 124 // Check if FIFO is empty
jbradshaw 0:e4a10ed6eb92 125 if (fifo->rindex == fifo->windex)
jbradshaw 0:e4a10ed6eb92 126 return -1;
jbradshaw 0:e4a10ed6eb92 127
jbradshaw 0:e4a10ed6eb92 128 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 129 __disable_irq();
jbradshaw 0:e4a10ed6eb92 130
jbradshaw 0:e4a10ed6eb92 131 // Get data from FIFO
jbradshaw 0:e4a10ed6eb92 132 *element = ((uint16_t *)(fifo->data))[fifo->rindex];
jbradshaw 0:e4a10ed6eb92 133
jbradshaw 0:e4a10ed6eb92 134 // Increment pointer
jbradshaw 0:e4a10ed6eb92 135 fifo->rindex++;
jbradshaw 0:e4a10ed6eb92 136 if (fifo->rindex == fifo->length) {
jbradshaw 0:e4a10ed6eb92 137 fifo->rindex = 0;
jbradshaw 0:e4a10ed6eb92 138 }
jbradshaw 0:e4a10ed6eb92 139
jbradshaw 0:e4a10ed6eb92 140 __enable_irq();
jbradshaw 0:e4a10ed6eb92 141
jbradshaw 0:e4a10ed6eb92 142 return 0;
jbradshaw 0:e4a10ed6eb92 143 }
jbradshaw 0:e4a10ed6eb92 144
jbradshaw 0:e4a10ed6eb92 145 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 146 int fifo_put32(fifo_t *fifo, uint32_t element) {
jbradshaw 0:e4a10ed6eb92 147 // Check if FIFO is full
jbradshaw 0:e4a10ed6eb92 148 if ((fifo->windex == (fifo->rindex - 1)) ||
jbradshaw 0:e4a10ed6eb92 149 ((fifo->rindex == 0) && (fifo->windex == (fifo->length - 1)))) {
jbradshaw 0:e4a10ed6eb92 150 return -1;
jbradshaw 0:e4a10ed6eb92 151 }
jbradshaw 0:e4a10ed6eb92 152
jbradshaw 0:e4a10ed6eb92 153 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 154 __disable_irq();
jbradshaw 0:e4a10ed6eb92 155
jbradshaw 0:e4a10ed6eb92 156 // Put data into FIFO
jbradshaw 0:e4a10ed6eb92 157 ((uint32_t *)(fifo->data))[fifo->windex] = element;
jbradshaw 0:e4a10ed6eb92 158
jbradshaw 0:e4a10ed6eb92 159 // Increment pointer
jbradshaw 0:e4a10ed6eb92 160 fifo->windex++;
jbradshaw 0:e4a10ed6eb92 161 if (fifo->windex == fifo->length) {
jbradshaw 0:e4a10ed6eb92 162 fifo->windex = 0;
jbradshaw 0:e4a10ed6eb92 163 }
jbradshaw 0:e4a10ed6eb92 164
jbradshaw 0:e4a10ed6eb92 165 __enable_irq();
jbradshaw 0:e4a10ed6eb92 166
jbradshaw 0:e4a10ed6eb92 167 return 0;
jbradshaw 0:e4a10ed6eb92 168 }
jbradshaw 0:e4a10ed6eb92 169
jbradshaw 0:e4a10ed6eb92 170 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 171 int fifo_get32(fifo_t *fifo, uint32_t *element) {
jbradshaw 0:e4a10ed6eb92 172 // Check if FIFO is empty
jbradshaw 0:e4a10ed6eb92 173 if (fifo->rindex == fifo->windex)
jbradshaw 0:e4a10ed6eb92 174 return -1;
jbradshaw 0:e4a10ed6eb92 175
jbradshaw 0:e4a10ed6eb92 176 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 177 __disable_irq();
jbradshaw 0:e4a10ed6eb92 178
jbradshaw 0:e4a10ed6eb92 179 // Get data from FIFO
jbradshaw 0:e4a10ed6eb92 180 *element = ((uint32_t *)(fifo->data))[fifo->rindex];
jbradshaw 0:e4a10ed6eb92 181
jbradshaw 0:e4a10ed6eb92 182 // Increment pointer
jbradshaw 0:e4a10ed6eb92 183 fifo->rindex++;
jbradshaw 0:e4a10ed6eb92 184 if (fifo->rindex == fifo->length) {
jbradshaw 0:e4a10ed6eb92 185 fifo->rindex = 0;
jbradshaw 0:e4a10ed6eb92 186 }
jbradshaw 0:e4a10ed6eb92 187
jbradshaw 0:e4a10ed6eb92 188 __enable_irq();
jbradshaw 0:e4a10ed6eb92 189
jbradshaw 0:e4a10ed6eb92 190 return 0;
jbradshaw 0:e4a10ed6eb92 191 }
jbradshaw 0:e4a10ed6eb92 192 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 193 void fifo_clear(fifo_t *fifo) {
jbradshaw 0:e4a10ed6eb92 194 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 195 __disable_irq();
jbradshaw 0:e4a10ed6eb92 196
jbradshaw 0:e4a10ed6eb92 197 fifo->rindex = 0;
jbradshaw 0:e4a10ed6eb92 198 fifo->windex = 0;
jbradshaw 0:e4a10ed6eb92 199
jbradshaw 0:e4a10ed6eb92 200 __enable_irq();
jbradshaw 0:e4a10ed6eb92 201 }
jbradshaw 0:e4a10ed6eb92 202
jbradshaw 0:e4a10ed6eb92 203 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 204 int fifo_empty(fifo_t *fifo) { return (fifo->rindex == fifo->windex); }
jbradshaw 0:e4a10ed6eb92 205
jbradshaw 0:e4a10ed6eb92 206 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 207 int fifo_full(fifo_t *fifo) {
jbradshaw 0:e4a10ed6eb92 208 int retval;
jbradshaw 0:e4a10ed6eb92 209
jbradshaw 0:e4a10ed6eb92 210 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 211 __disable_irq();
jbradshaw 0:e4a10ed6eb92 212 retval = ((fifo->windex == (fifo->rindex - 1)) ||
jbradshaw 0:e4a10ed6eb92 213 ((fifo->rindex == 0) && (fifo->windex == (fifo->length - 1))));
jbradshaw 0:e4a10ed6eb92 214 __enable_irq();
jbradshaw 0:e4a10ed6eb92 215
jbradshaw 0:e4a10ed6eb92 216 return retval;
jbradshaw 0:e4a10ed6eb92 217 }
jbradshaw 0:e4a10ed6eb92 218
jbradshaw 0:e4a10ed6eb92 219 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 220 unsigned int fifo_level(fifo_t *fifo) {
jbradshaw 0:e4a10ed6eb92 221 uint16_t value;
jbradshaw 0:e4a10ed6eb92 222
jbradshaw 0:e4a10ed6eb92 223 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 224 __disable_irq();
jbradshaw 0:e4a10ed6eb92 225
jbradshaw 0:e4a10ed6eb92 226 if (fifo->windex >= fifo->rindex) {
jbradshaw 0:e4a10ed6eb92 227 value = fifo->windex - fifo->rindex;
jbradshaw 0:e4a10ed6eb92 228 } else {
jbradshaw 0:e4a10ed6eb92 229 value = fifo->length - fifo->rindex + fifo->windex;
jbradshaw 0:e4a10ed6eb92 230 }
jbradshaw 0:e4a10ed6eb92 231
jbradshaw 0:e4a10ed6eb92 232 __enable_irq();
jbradshaw 0:e4a10ed6eb92 233
jbradshaw 0:e4a10ed6eb92 234 return value;
jbradshaw 0:e4a10ed6eb92 235 }
jbradshaw 0:e4a10ed6eb92 236
jbradshaw 0:e4a10ed6eb92 237 /****************************************************************************/
jbradshaw 0:e4a10ed6eb92 238 unsigned int fifo_remaining(fifo_t *fifo) {
jbradshaw 0:e4a10ed6eb92 239 uint16_t value;
jbradshaw 0:e4a10ed6eb92 240
jbradshaw 0:e4a10ed6eb92 241 // atomic FIFO access
jbradshaw 0:e4a10ed6eb92 242 __disable_irq();
jbradshaw 0:e4a10ed6eb92 243
jbradshaw 0:e4a10ed6eb92 244 if (fifo->rindex > fifo->windex) {
jbradshaw 0:e4a10ed6eb92 245 value = fifo->rindex - fifo->windex - 1;
jbradshaw 0:e4a10ed6eb92 246 } else {
jbradshaw 0:e4a10ed6eb92 247 value = fifo->length - fifo->windex + fifo->rindex - 1;
jbradshaw 0:e4a10ed6eb92 248 }
jbradshaw 0:e4a10ed6eb92 249
jbradshaw 0:e4a10ed6eb92 250 __enable_irq();
jbradshaw 0:e4a10ed6eb92 251
jbradshaw 0:e4a10ed6eb92 252 return value;
jbradshaw 0:e4a10ed6eb92 253 }