TLE94x1.h

Go to the documentation of this file.

/*********************************************************************************************************************
 * Copyright (c) 2019, Infineon Technologies AG
 *
 * 
 * Distributed under the Boost Software License, Version 1.0.
 * 
 * 
 * Boost Software License - Version 1.0 - August 17th, 2003
 * 
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 * 
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 * 
 *********************************************************************************************************************/


/****************************************************************************************************/
#ifndef TLE94x1_H
#define TLE94x1_H
 





/* ================================================================================ */
/* ============================   HEADER FILES     ================================ */
/* ================================================================================ */ 


 
#include "TLE94x1_DEFINES.h"
#include "TLE94x1_ISR.h"
#include "TLE94x1_SPI.h"
#include <stdint.h>




/* ================================================================================ */
/* ================================   MACROS     ================================== */
/* ================================================================================ */ 


#define SBC_Write_Bit   (0x80U)

#define SBC_Read_Mask   (0x7FU)




/* ================================================================================ */
/* ===========================   Library Functions     ============================ */
/* ================================================================================ */ 

struct __SBC_ErrorCode;

typedef struct __SBC_ErrorCode {
    uint8_t SBC_Register;       
    uint8_t flippedBitsMask;    
    uint8_t expectedValue;      
} SBC_ErrorCode;

typedef void (*SBC_Func_Callback)(uint8_t callbackHandler);






/* --------------------------------  Main Functions ------------------------------- */


SBC_ErrorCode SBC_WD_Trigger(void);


uint16_t SBC_Read_Command(uint8_t SBC_Reg);


uint8_t SBC_Read_RegField(uint8_t SBC_Reg, uint8_t SBC_FieldMsk, uint8_t SBC_FieldPos);



SBC_ErrorCode SBC_Write_Reg(uint8_t SBC_Reg, uint8_t SBC_Val, uint16_t * returnval);


SBC_ErrorCode SBC_Write_RegField(uint8_t SBC_Reg, uint8_t SBC_FieldMsk, uint8_t SBC_FieldPos, uint8_t SBC_FieldVal, uint16_t * returnval);


SBC_ErrorCode SBC_Init(void);

/* --------------------------------  ISR Functions -------------------------------- */


void SBC_Register_Callback(uint32_t ISR_Vector, void (*Callback_Handler)(uint8_t callbackHandler));


SBC_ErrorCode SBC_ISR(void);



/* --------------------------------  API Calls  ----------------------------------- */

SBC_ErrorCode SBC_Mode_Normal(void);


SBC_ErrorCode SBC_Mode_Stop(void);


SBC_ErrorCode SBC_Mode_Sleep(void);


SBC_ErrorCode SBC_Set_DutyCycle_PWM(uint8_t PWM_DC);


SBC_ErrorCode SBC_Set_Timer_On(uint8_t OnTime);

SBC_ErrorCode SBC_Set_Timer_Period(uint8_t Period);


SBC_ErrorCode SBC_FO_Test_On(void);


SBC_ErrorCode SBC_FO_Test_Off(void);


SBC_ErrorCode SBC_CP_On(void);


SBC_ErrorCode SBC_CP_Off(void);


SBC_ErrorCode SBC_WK_MEAS_On(void);


SBC_ErrorCode SBC_WK_MEAS_Off(void);


SBC_ErrorCode SBC_TIMER_WK_EN_On(void);


SBC_ErrorCode SBC_TIMER_WK_EN_Off(void);


uint16_t SBC_SYS_STAT_Read(void);


SBC_ErrorCode SBC_SYS_STAT_Write(uint16_t SystemStatus);


SBC_ErrorCode SBC_Lock_Configuration(void);


SBC_ErrorCode SBC_Unlock_Configuration(void);


SBC_ErrorCode SBC_Clear_Wake_Status(void);

#endif  /*TLE94x1_H*/