dcl_fdlog.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2024 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef _DCL_FDLOG_H_
#define _DCL_FDLOG_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "../dcl_common.h"
 
typedef _DCL_VOLATILE struct dcl_fdlog 
{
    float32_t *fptr;    
    float32_t *lptr;    
    float32_t *dptr;    
    uint32_t size;      
} DCL_FDLOG, FDLOG;
 
/******************** macro definitions ********************/
#define FDLOG_DEFAULTS     {0x0,0x0,0x0,0}
 
#define DCL_getLogSize(buf)         ((buf)->size)
 
#define DCL_getLogIndex(buf)        ((uint32_t)((buf)->dptr - (buf)->fptr))
 
#define DCL_getLogRemain(buf)       ((int32_t)((buf)->lptr - (buf)->dptr))
 
/******************** inline functions ********************/
 
_DCL_CODE_ACCESS
void DCL_setLogIndex(DCL_FDLOG *buf, uint32_t idx)
{
    if(idx < buf->size)
    {
        buf->dptr = buf->fptr + idx;
    } 
}    
 
_DCL_CODE_ACCESS
void DCL_deleteLog(DCL_FDLOG *buf)  { buf->dptr = buf->fptr = buf->lptr = NULL; buf->size = 0; }
 
_DCL_CODE_ACCESS
void DCL_resetLog(DCL_FDLOG *buf)   { buf->dptr = buf->fptr; }
 
_DCL_CODE_ACCESS
void DCL_fillLog(DCL_FDLOG *buf, float32_t data)
{
    uint32_t size = DCL_getLogSize(buf);
    float32_t* mem = buf->fptr;
    DCL_resetLog(buf);
    while (size--) *mem++ = data;
}
 
#define DCL_clearLog(buf)       DCL_fillLog(buf,0.0f)
 
_DCL_CODE_ACCESS
void DCL_initLog(DCL_FDLOG *buf, float32_t *addr, uint32_t size)
{
    buf->size = size;
    buf->fptr = addr;
    buf->lptr = addr + size - 1;
    DCL_resetLog(buf);
}
 
_DCL_CODE_ACCESS
float32_t DCL_writeLog(DCL_FDLOG *buf, float32_t data)
{
    // save existing data
    float32_t rv = *(buf->dptr);      
 
    // write new data to log
    *(buf->dptr++) = data;
 
    // check for end of buffer & wrap if necessary
    if (buf->dptr > buf->lptr) DCL_resetLog(buf);
 
    return(rv);
}
 
_DCL_CODE_ACCESS
float32_t DCL_readLog(DCL_FDLOG *buf)
{
    float32_t rv = *(buf->dptr++);
 
    // check for end of buffer & wrap if necessary
    if (buf->dptr > buf->lptr) DCL_resetLog(buf);
 
    return(rv);
}
 
_DCL_CODE_ACCESS
void DCL_copyLog(DCL_FDLOG *src, DCL_FDLOG *dst)
{
    uint32_t size = DCL_getLogSize(src);
    if (size != DCL_getLogSize(dst))
    {
        return;
    }
 
    float32_t* src_ptr = src->fptr;
    float32_t* dst_ptr = dst->fptr;
    while (size--)  *(dst_ptr++) = *(src_ptr++);
    DCL_setLogIndex(dst, DCL_getLogIndex(src));
}
 
#ifdef __cplusplus
}
#endif // extern "C"
 
#endif // _DCL_FDLOG_H_