nxp_afe.h

Go to the documentation of this file.

/**
 *
 * @copyright © 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Neither the name of the copyright holder 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 HOLDER 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.
 *
 * We kindly request you to use one or more of the following phrases to refer to
 * foxBMS in your hardware, software, documentation or advertising materials:
 *
 * - ″This product uses parts of foxBMS®″
 * - ″This product includes parts of foxBMS®″
 * - ″This product is derived from foxBMS®″
 *
 */
 
/**
 * @file    nxp_afe.h
 * @author  foxBMS Team
 * @date    2021-06-04 (date of creation)
 * @updated 2023-10-12 (date of last update)
 * @version v1.6.0
 * @ingroup DRIVER
 * @prefix  NXP
 *
 * @brief   AFE driver wrapper layer for NXP ICs
 */
 
#ifndef FOXBMS__NXP_AFE_H_
#define FOXBMS__NXP_AFE_H_
 
/*========== Includes =======================================================*/
 
#include "fstd_types.h"
 
/* clang-format off */
#include "afe.h"
/* clang-format on */
 
#include <stdbool.h>
#include <stdint.h>
 
/*========== Macros and Definitions =========================================*/
 
/*========== Extern Constant and Variable Declarations ======================*/
 
/*========== Extern Function Prototypes =====================================*/
 
/** Function called to run the AFE driver */
extern STD_RETURN_TYPE_e NXP_Measure(void);
/** Function setting the pins of the port expander */
extern STD_RETURN_TYPE_e NXP_Initialize(void);
/** Function to request a read of the I2C EEPROM on the slaves */
extern STD_RETURN_TYPE_e NXP_RequestEepromRead(uint8_t string);
/** Function to request a write to the I2C EEPROM on the slaves */
extern STD_RETURN_TYPE_e NXP_RequestEepromWrite(uint8_t string);
/** Function to request a read of the I2C temperature sensor on the slaves */
extern STD_RETURN_TYPE_e NXP_RequestTemperatureRead(uint8_t string);
/** Function to request a read of the balancing feedback on the slaves */
extern STD_RETURN_TYPE_e NXP_RequestBalancingFeedbackRead(uint8_t string);
/** Function to request an openWire check on the slaves */
extern STD_RETURN_TYPE_e NXP_RequestOpenWireCheck(uint8_t string);
/** Function to request a start of the AFE driver, deprecated with the continuously running task */
extern STD_RETURN_TYPE_e NXP_StartMeasurement(void);
/** Function to check if at least one measurement cycle has been made */
extern bool NXP_IsFirstMeasurementCycleFinished(void);
/** Function to request a read of the I2C port expnader on the slaves */
extern STD_RETURN_TYPE_e NXP_RequestIoRead(uint8_t string);
/** Function to request a write to the I2C port expnader on the slaves */
STD_RETURN_TYPE_e NXP_RequestIoWrite(uint8_t string);
 
/*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
#ifdef UNITY_UNIT_TEST
#endif
 
#endif /* FOXBMS__NXP_AFE_H_ */