BIOS.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2021, Texas Instruments Incorporated - https://www.ti.com
 * All rights reserved.
 *
 * 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.
 *
 */
/*
 * ======== BIOS.h ========
 */

#ifndef ti_sysbios_BIOS__include
#define ti_sysbios_BIOS__include

/* BIOS 6.x compatibility, use -Dxdc_std__include to disable */
#include <xdc/std.h>

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#include <ti/sysbios/runtime/Types.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Current version number */
#define ti_sysbios_BIOS_version (0x70000)

enum BIOS_ThreadType {
    BIOS_ThreadType_Hwi,
    BIOS_ThreadType_Swi,
    BIOS_ThreadType_Task,
    BIOS_ThreadType_Main
};
typedef enum BIOS_ThreadType BIOS_ThreadType;

enum BIOS_RtsLockType {
    BIOS_NoLocking,
    BIOS_GateHwi,
    BIOS_GateSwi,
    BIOS_GateMutex,
    BIOS_GateMutexPri
};
typedef enum BIOS_RtsLockType BIOS_RtsLockType;

#define BIOS_WAIT_FOREVER (~(0U))

#define BIOS_NO_WAIT (0U)

typedef void (*BIOS_StartupFuncPtr)(void);

typedef void (*BIOS_StartFuncPtr)(void);

typedef void (*BIOS_ExitFuncPtr)(int arg1);

/* @cond NODOC */
typedef struct BIOS_Module_State BIOS_Module_State;

struct BIOS_Module_State {
    Types_FreqHz cpuFreq;
    unsigned int rtsGateCount;
    intptr_t rtsGateKey;
    void * rtsGate;
    BIOS_ThreadType threadType;
    BIOS_ThreadType smpThreadType[4];
    volatile BIOS_StartFuncPtr startFunc;
    volatile BIOS_ExitFuncPtr exitFunc;
    BIOS_RtsLockType rtsGateType;
    uint16_t enables;
    bool initDone;
};
extern const bool BIOS_smpEnabled;

extern const bool BIOS_mpeEnabled;
extern const Types_FreqHz BIOS_cpuFreq;

extern const bool BIOS_taskEnabled;

extern const bool BIOS_swiEnabled;

extern const bool BIOS_clockEnabled;

extern const size_t BIOS_heapSize;

extern const bool BIOS_heapTrackEnabled;

extern const bool BIOS_setupSecureContext;
extern void BIOS_linkedWithIncorrectBootLibrary(void);

/* init */
extern void BIOS_init(void);
/* @endcond */

extern void BIOS_start(void);

extern void BIOS_startFunc(void);

extern void BIOS_exitFunc(int arg1);
extern void BIOS_exit(int stat);

extern BIOS_ThreadType BIOS_getThreadType(void);

extern BIOS_ThreadType BIOS_setThreadType(BIOS_ThreadType ttype);
extern void BIOS_setCpuFreq(Types_FreqHz *freq);

extern void BIOS_getCpuFreq(Types_FreqHz *freq);

extern void BIOS_startFunc(void);
extern void BIOS_atExitFunc(int stat);
extern void BIOS_exitFunc(int stat);
extern void BIOS_registerRTSLock(void);
extern void BIOS_removeRTSLock(void);
extern void BIOS_rtsLock(void);
extern void BIOS_rtsUnlock(void);

extern BIOS_Module_State BIOS_Module_state;
#define BIOS_module (&(BIOS_Module_state))

#ifdef __cplusplus
}
#endif
#endif /* ti_sysbios_BIOS__include */