Swi.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020, 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.
 *
 */
/*
 * ======== Swi.h ========
 */

#ifndef ti_sysbios_knl_Swi__include
#define ti_sysbios_knl_Swi__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/knl/Queue.h>
#include <ti/sysbios/runtime/Error.h>

/* @cond NODOC */
#define ti_sysbios_knl_Swi_long_names
#include "Swi_defs.h"
#ifdef __cplusplus
extern "C" {
#endif

#define Swi_A_swiDisabled "cannot create a SWI when Swi is disabled"

#define Swi_A_badPriority "invalid priority"

typedef struct Swi_Struct Swi_Struct;
typedef struct Swi_Struct Swi_Object;
typedef Swi_Struct* Swi_Handle;
typedef Swi_Struct* Swi_Instance;

typedef struct Swi_HookSet Swi_HookSet;

typedef struct Swi_Params Swi_Params;

typedef struct Swi_Module_State Swi_Module_State;
typedef Queue_Object Swi_Module_State__readyQ;
typedef void (*Swi_FuncPtr)(uintptr_t arg1, uintptr_t arg2);

struct Swi_HookSet {
    void (*registerFxn)(int arg1);
    void (*createFxn)(Swi_Handle arg1, Error_Block* arg2);
    void (*readyFxn)(Swi_Handle arg1);
    void (*beginFxn)(Swi_Handle arg1);
    void (*endFxn)(Swi_Handle arg1);
    void (*deleteFxn)(Swi_Handle arg1);
};

typedef struct { int length; const Swi_HookSet *elem; } Swi_Hook;

typedef Swi_Struct Swi_Struct2;

struct Swi_Module_State {
    Queue_Struct objQ;
    volatile bool locked;
    unsigned int curSet;
    unsigned int curTrigger;
    Swi_Handle curSwi;
    Queue_Handle curQ;
    Queue_Handle readyQ;
    Queue_Handle constructedSwis;
    bool initDone;
};

struct Swi_Struct {
    Queue_Elem qElem;
    Queue_Elem objElem;
    char * name;
    Swi_FuncPtr fxn;
    uintptr_t arg0;
    uintptr_t arg1;
    unsigned int priority;
    unsigned int mask;
    bool posted;
    unsigned int initTrigger;
    unsigned int trigger;
    Queue_Handle readyQ;
    void * *hookEnv;
};
extern const unsigned int Swi_numPriorities;

typedef unsigned int (*CT__Swi_taskDisable)(void);
extern const CT__Swi_taskDisable Swi_taskDisable;

typedef void (*CT__Swi_taskRestore)(unsigned int arg1);
extern const CT__Swi_taskRestore Swi_taskRestore;
extern const Swi_Hook Swi_hooks;

struct Swi_Params {
    char * name;
    uintptr_t arg0;
    uintptr_t arg1;
    unsigned int priority;
    unsigned int trigger;
};

extern void Swi_init(void);

extern int Swi_Instance_init(Swi_Object *obj, Swi_FuncPtr swiFxn, const Swi_Params *prms, Error_Block *eb);

extern void Swi_Instance_finalize(Swi_Object *obj, int ec);
extern Swi_Handle Swi_create(Swi_FuncPtr swiFxn, const Swi_Params *prms, Error_Block *eb);

extern Swi_Handle Swi_construct(Swi_Struct *obj, Swi_FuncPtr swiFxn, const Swi_Params *prms, Error_Block *eb);

extern void Swi_delete(Swi_Handle *swi);

extern void Swi_destruct(Swi_Struct *obj);

extern void Swi_Params_init(Swi_Params *prms);

extern Swi_Handle Swi_Object_first(void);

extern Swi_Handle Swi_Object_next(Swi_Handle swi);

extern Swi_Handle Swi_construct2(Swi_Struct2 *swi, Swi_FuncPtr swiFxn, const Swi_Params *prms);
extern void Swi_startup(void);

extern bool Swi_enabled(void);

extern void Swi_unlockSched(void);
extern unsigned int Swi_disable(void);

extern void Swi_enable(void);
extern void Swi_restore(unsigned int key);

extern void Swi_restoreHwi(unsigned int key);
extern Swi_Handle Swi_self(void);

extern unsigned int Swi_getTrigger(void);

extern unsigned int Swi_raisePri(unsigned int priority);
extern void Swi_restorePri(unsigned int key);
extern void Swi_andn(Swi_Handle swi, unsigned int mask);

extern void Swi_dec(Swi_Handle swi);

extern void * Swi_getHookContext(Swi_Handle swi, int id);

extern void Swi_setHookContext(Swi_Handle swi, int id, void * hookContext);

extern char * Swi_getName(Swi_Handle swi);

extern unsigned int Swi_getPri(Swi_Handle swi);

extern Swi_FuncPtr Swi_getFunc(Swi_Handle swi, uintptr_t *arg0, uintptr_t *arg1);

extern void Swi_getAttrs(Swi_Handle swi, Swi_FuncPtr *swiFxn, Swi_Params *params);

extern void Swi_setAttrs(Swi_Handle swi, Swi_FuncPtr swiFxn, Swi_Params *params);

extern void Swi_setPri(Swi_Handle swi, unsigned int priority);

extern void Swi_inc(Swi_Handle swi);

extern void Swi_or(Swi_Handle swi, unsigned int mask);

extern void Swi_post(Swi_Handle swi);

extern void Swi_schedule(void);

extern void Swi_runLoop(void);

extern void Swi_run(Swi_Object *swi);

extern int Swi_postInit(Swi_Object *swi, Error_Block *eb);

extern void Swi_restoreSMP(void);

extern Swi_Module_State Swi_Module_state;

#define Swi_module ((Swi_Module_State *) &(Swi_Module_state))

#define Swi_Object_heap() NULL

static inline char * Swi_Handle_name(Swi_Handle obj)
{
    return (obj->name);
}

static inline Swi_Handle Swi_handle(Swi_Struct *str)
{  
    return ((Swi_Handle)str);
}

static inline Swi_Struct * Swi_struct(Swi_Handle h)
{
    return ((Swi_Struct *)h);
}
#ifdef __cplusplus
}
#endif
#endif /* ti_sysbios_knl_Swi__include */

/* @cond NODOC */
#undef ti_sysbios_knl_Swi_long_names
#include "Swi_defs.h"