dcl_css.h

Go to the documentation of this file.

/*
 * Copyright (C) 2024 Texas Instruments Incorporated - https://www.ti.com/
 *
 *
 * 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_CSS_H_
#define _DCL_CSS_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
//--- Controller Common Support Structure ------------------------------------
 
typedef struct dcl_css {
    float32_t tpt;      
    float32_t T;    
    volatile uint32_t sts;      
    uint32_t err_line;          
    uint32_t err;               
    const char* err_func;       
} DCL_CSS;
 
#define DCL_CSS_DEFAULTS { 0.0f, DCL_DEFAULT_PERIOD_S, 0U, 0U, 0U, NULL }
 
typedef struct dcl_css64 {
    float64_t tpt;      
    float64_t T;    
    volatile uint32_t sts;      
    uint32_t err_line;          
    uint32_t err;               
    const char* err_func;       
} DCL_CSSF64;
 
#define DCL_CSSF64_DEFAULTS { 0.0L, DCL_DEFAULT_PERIODF64_S, 0U, 0U, 0U, NULL }
 
#define DCL_setControllerPeriod(p,t_sec)   ((p)->css->T = t_sec)
 
//--- Status word ------------------------------------------------------------
 
typedef enum dcl_status_bits
{
    DCL_STS_NONE = 0U,                     
    DCL_STS_PARAM_UPDATE =   (1U << 0),    
    DCL_STS_CTRL_RUNNING =   (1U << 1),    
} DCL_status_bits;
 
#define DCL_setUpdateStatus(p)           ((p)->css->sts |= DCL_STS_PARAM_UPDATE)
#define DCL_clearUpdateStatus(p)         ((p)->css->sts &= ~DCL_STS_PARAM_UPDATE)
 
#define DCL_getUpdateStatus(p)           (0U != ((p)->css->sts & DCL_STS_PARAM_UPDATE))
 
#define DCL_setControllerStatus(p)       ((p)->css->sts |= DCL_STS_CTRL_RUNNING)
#define DCL_clearControllerStatus(p)     ((p)->css->sts &= ~DCL_STS_CTRL_RUNNING)
 
#define DCL_getControllerStatus(p)       (0U != ((p)->css->sts & DCL_STS_CTRL_RUNNING))
 
#ifdef __cplusplus
}
#endif // extern "C"
 
#endif // _DCL_CSS_H_