Maxim Integrated / MAX8614X

initial commit, reads dev id

MaximSensor/queue.cpp@7:ffa35f46725e, 2022-09-02 (annotated)

Committer:
phonemacro
Date:
Fri Sep 02 22:34:45 2022 +0000
Revision:
7:ffa35f46725e
Parent:
5:1f7b8cb07e26 
remove clock enable/disable in MAX8614X::read_fifo_data (that was only needed for Rev A)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phonemacro 5:1f7b8cb07e26 1 /*******************************************************************************
phonemacro 5:1f7b8cb07e26 2 * Author: Ismail Kose, Ismail.Kose@maximintegrated.com
phonemacro 5:1f7b8cb07e26 3 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
phonemacro 5:1f7b8cb07e26 4 *
phonemacro 5:1f7b8cb07e26 5 * Permission is hereby granted, free of charge, to any person obtaining a
phonemacro 5:1f7b8cb07e26 6 * copy of this software and associated documentation files (the "Software"),
phonemacro 5:1f7b8cb07e26 7 * to deal in the Software without restriction, including without limitation
phonemacro 5:1f7b8cb07e26 8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
phonemacro 5:1f7b8cb07e26 9 * and/or sell copies of the Software, and to permit persons to whom the
phonemacro 5:1f7b8cb07e26 10 * Software is furnished to do so, subject to the following conditions:
phonemacro 5:1f7b8cb07e26 11 *
phonemacro 5:1f7b8cb07e26 12 * The above copyright notice and this permission notice shall be included
phonemacro 5:1f7b8cb07e26 13 * in all copies or substantial portions of the Software.
phonemacro 5:1f7b8cb07e26 14 *
phonemacro 5:1f7b8cb07e26 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
phonemacro 5:1f7b8cb07e26 16 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
phonemacro 5:1f7b8cb07e26 17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
phonemacro 5:1f7b8cb07e26 18 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
phonemacro 5:1f7b8cb07e26 19 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
phonemacro 5:1f7b8cb07e26 20 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
phonemacro 5:1f7b8cb07e26 21 * OTHER DEALINGS IN THE SOFTWARE.
phonemacro 5:1f7b8cb07e26 22 *
phonemacro 5:1f7b8cb07e26 23 * Except as contained in this notice, the name of Maxim Integrated
phonemacro 5:1f7b8cb07e26 24 * Products, Inc. shall not be used except as stated in the Maxim Integrated
phonemacro 5:1f7b8cb07e26 25 * Products, Inc. Branding Policy.
phonemacro 5:1f7b8cb07e26 26 *
phonemacro 5:1f7b8cb07e26 27 * The mere transfer of this software does not imply any licenses
phonemacro 5:1f7b8cb07e26 28 * of trade secrets, proprietary technology, copyrights, patents,
phonemacro 5:1f7b8cb07e26 29 * trademarks, maskwork rights, or any other form of intellectual
phonemacro 5:1f7b8cb07e26 30 * property whatsoever. Maxim Integrated Products, Inc. retains all
phonemacro 5:1f7b8cb07e26 31 * ownership rights.
phonemacro 5:1f7b8cb07e26 32 *******************************************************************************
phonemacro 5:1f7b8cb07e26 33 */
phonemacro 5:1f7b8cb07e26 34
phonemacro 5:1f7b8cb07e26 35 /*
phonemacro 5:1f7b8cb07e26 36 * TODO:
phonemacro 5:1f7b8cb07e26 37 * Add a function to enqueue data block instead of one by one.
phonemacro 5:1f7b8cb07e26 38 * Write function definitions in the header file as doxygen format
phonemacro 5:1f7b8cb07e26 39 * Init function will also allocate memory for queue buffer, providing the buffer will not necessary
phonemacro 5:1f7b8cb07e26 40 *
phonemacro 5:1f7b8cb07e26 41 * */
phonemacro 5:1f7b8cb07e26 42
phonemacro 5:1f7b8cb07e26 43 #define enter_critical_section()
phonemacro 5:1f7b8cb07e26 44 #define exit_critical_section()
phonemacro 5:1f7b8cb07e26 45
phonemacro 5:1f7b8cb07e26 46 #include "queue.h"
phonemacro 5:1f7b8cb07e26 47 int queue_reset(struct queue_t *q)
phonemacro 5:1f7b8cb07e26 48 {
phonemacro 5:1f7b8cb07e26 49 if (!q)
phonemacro 5:1f7b8cb07e26 50 return -1;
phonemacro 5:1f7b8cb07e26 51
phonemacro 5:1f7b8cb07e26 52 q->wr = q->base;
phonemacro 5:1f7b8cb07e26 53 q->rd = q->base;
phonemacro 5:1f7b8cb07e26 54 q->num_item = 0;
phonemacro 5:1f7b8cb07e26 55 q->ovf_item = 0;
phonemacro 5:1f7b8cb07e26 56
phonemacro 5:1f7b8cb07e26 57 return 0;
phonemacro 5:1f7b8cb07e26 58 }
phonemacro 5:1f7b8cb07e26 59
phonemacro 5:1f7b8cb07e26 60 int queue_init(struct queue_t *q, void *buf, int item_size, int buffer_size)
phonemacro 5:1f7b8cb07e26 61 {
phonemacro 5:1f7b8cb07e26 62 if (!q || !buf)
phonemacro 5:1f7b8cb07e26 63 return -1;
phonemacro 5:1f7b8cb07e26 64
phonemacro 5:1f7b8cb07e26 65 if (buffer_size % item_size != 0)
phonemacro 5:1f7b8cb07e26 66 return -1; // Padding problem
phonemacro 5:1f7b8cb07e26 67
phonemacro 5:1f7b8cb07e26 68 q->num_item = 0;
phonemacro 5:1f7b8cb07e26 69 q->base = buf;
phonemacro 5:1f7b8cb07e26 70 q->wr = buf;
phonemacro 5:1f7b8cb07e26 71 q->rd = buf;
phonemacro 5:1f7b8cb07e26 72 q->item_size = item_size;
phonemacro 5:1f7b8cb07e26 73 q->buffer_size = buffer_size;
phonemacro 5:1f7b8cb07e26 74
phonemacro 5:1f7b8cb07e26 75 return 0;
phonemacro 5:1f7b8cb07e26 76 }
phonemacro 5:1f7b8cb07e26 77
phonemacro 5:1f7b8cb07e26 78 void queue_destroy(struct queue_t *q)
phonemacro 5:1f7b8cb07e26 79 {
phonemacro 5:1f7b8cb07e26 80 /* TODO: This is placeholder function, double check the implementation */
phonemacro 5:1f7b8cb07e26 81 free((void *)q->base);
phonemacro 5:1f7b8cb07e26 82 free((void *)q);
phonemacro 5:1f7b8cb07e26 83 }
phonemacro 5:1f7b8cb07e26 84
phonemacro 5:1f7b8cb07e26 85 int enqueue(struct queue_t *q, void *data)
phonemacro 5:1f7b8cb07e26 86 {
phonemacro 5:1f7b8cb07e26 87 int ret = 0;
phonemacro 5:1f7b8cb07e26 88
phonemacro 5:1f7b8cb07e26 89 if (!q || !data)
phonemacro 5:1f7b8cb07e26 90 return -1; // Invalid pointer
phonemacro 5:1f7b8cb07e26 91
phonemacro 5:1f7b8cb07e26 92 enter_critical_section();
phonemacro 5:1f7b8cb07e26 93 if (q->wr == q->rd)
phonemacro 5:1f7b8cb07e26 94 ret = (q->num_item != 0) ? -2 : 0; // Is FIFO Full or Empty?
phonemacro 5:1f7b8cb07e26 95
phonemacro 5:1f7b8cb07e26 96 if (((uint32_t)q->wr) >= ((uint32_t)q->base + q->buffer_size))
phonemacro 5:1f7b8cb07e26 97 q->wr = q->base;
phonemacro 5:1f7b8cb07e26 98
phonemacro 5:1f7b8cb07e26 99 memcpy((void *)q->wr, data, q->item_size);
phonemacro 5:1f7b8cb07e26 100 q->wr = (void *)((uint32_t)q->wr + q->item_size);
phonemacro 5:1f7b8cb07e26 101 q->num_item++;
phonemacro 5:1f7b8cb07e26 102 exit_critical_section();
phonemacro 5:1f7b8cb07e26 103 return ret;
phonemacro 5:1f7b8cb07e26 104 }
phonemacro 5:1f7b8cb07e26 105
phonemacro 5:1f7b8cb07e26 106 int dequeue(struct queue_t *q, void *data)
phonemacro 5:1f7b8cb07e26 107 {
phonemacro 5:1f7b8cb07e26 108 int fifo_size;
phonemacro 5:1f7b8cb07e26 109
phonemacro 5:1f7b8cb07e26 110 if (!q || !data)
phonemacro 5:1f7b8cb07e26 111 return -1;
phonemacro 5:1f7b8cb07e26 112
phonemacro 5:1f7b8cb07e26 113 fifo_size = q->buffer_size / q->item_size;
phonemacro 5:1f7b8cb07e26 114
phonemacro 5:1f7b8cb07e26 115 enter_critical_section();
phonemacro 5:1f7b8cb07e26 116 if (q->num_item <= 0) {
phonemacro 5:1f7b8cb07e26 117 exit_critical_section();
phonemacro 5:1f7b8cb07e26 118 return -2;
phonemacro 5:1f7b8cb07e26 119 }
phonemacro 5:1f7b8cb07e26 120
phonemacro 5:1f7b8cb07e26 121 if (q->num_item > fifo_size) {
phonemacro 5:1f7b8cb07e26 122 uint32_t curr_rd_off = (((uint32_t)q->rd - (uint32_t)q->base) + q->num_item * q->item_size);
phonemacro 5:1f7b8cb07e26 123 q->ovf_item = q->num_item - fifo_size;
phonemacro 5:1f7b8cb07e26 124 q->rd = (void *)((uint32_t)q->base + (curr_rd_off % q->buffer_size));
phonemacro 5:1f7b8cb07e26 125 q->num_item = fifo_size; // OVF number samples are already gone.
phonemacro 5:1f7b8cb07e26 126 printf("%s:%d - %d samples lost\n", __func__, __LINE__, q->ovf_item);
phonemacro 5:1f7b8cb07e26 127 } else
phonemacro 5:1f7b8cb07e26 128 q->ovf_item = 0;
phonemacro 5:1f7b8cb07e26 129
phonemacro 5:1f7b8cb07e26 130 if (((uint32_t)q->rd) >= ((uint32_t)q->base + q->buffer_size))
phonemacro 5:1f7b8cb07e26 131 q->rd = q->base;
phonemacro 5:1f7b8cb07e26 132
phonemacro 5:1f7b8cb07e26 133 memcpy(data, (void *)q->rd, q->item_size);
phonemacro 5:1f7b8cb07e26 134 q->rd = (void *)((uint32_t)q->rd + q->item_size);
phonemacro 5:1f7b8cb07e26 135 q->num_item--;
phonemacro 5:1f7b8cb07e26 136 exit_critical_section();
phonemacro 5:1f7b8cb07e26 137
phonemacro 5:1f7b8cb07e26 138 #if defined(QUEUE_DEBUG)
phonemacro 5:1f7b8cb07e26 139 do {
phonemacro 5:1f7b8cb07e26 140 static int cnt;
phonemacro 5:1f7b8cb07e26 141
phonemacro 5:1f7b8cb07e26 142 if (cnt++ % 100 == 0)
phonemacro 5:1f7b8cb07e26 143 printf("$ Fifo size: %d, usage: %d\n", fifo_size, q->num_item);
phonemacro 5:1f7b8cb07e26 144 } while(0);
phonemacro 5:1f7b8cb07e26 145 #endif
phonemacro 5:1f7b8cb07e26 146
phonemacro 5:1f7b8cb07e26 147 return 0;
phonemacro 5:1f7b8cb07e26 148 }
phonemacro 5:1f7b8cb07e26 149