hal.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
/*
 * Author: Andreas Werner <kernel@andy89.org>
 * Date: 2021
 */
#ifndef HAL_H_
#define HAL_H_
#include <FreeRTOS.h>
#include <semphr.h>
#include <system.h>
#include <stdbool.h>
#include <os.h>
#ifdef __FRAMAC__
/* include FRAMAC FreeROTS specification */
# include <framaC/freeRTOS.h>
#endif
 
struct hal {
        bool init;
#ifdef CONFIG_INSTANCE_NAME
 
        const char *name;
#endif
#ifdef CONFIG_USE_RECURSIVE_MUTEXES
 
        OS_DEFINE_MUTEX_RECURSIVE(lock);
#endif
};
inline int32_t hal_init(void *data) {
#ifdef CONFIG_USE_RECURSIVE_MUTEXES
        struct hal *hal = data;
        hal->lock = OS_CREATE_MUTEX_RECURSIVE(hal->lock);
        if (hal->lock == NULL) {
                return -1;
        }
#endif
        return 0;
}
inline int32_t hal_deinit(void *data) {
#ifdef CONFIG_USE_RECURSIVE_MUTEXES
        struct hal *hal = data;
        vSemaphoreDelete(hal->lock);
#endif
        return 0;
}
inline bool hal_isInit(void *data) {
        struct hal *hal = data;
        return hal->init;
}
inline int32_t hal_lock(void *data, TickType_t waittime) {
#ifdef CONFIG_USE_RECURSIVE_MUTEXES
        struct hal *hal = data;
        return xSemaphoreTakeRecursive(hal->lock, waittime);
#else
        return 1;
#endif
}
 
inline int32_t hal_unlock(void *data) {
#ifdef CONFIG_USE_RECURSIVE_MUTEXES
        struct hal *hal = data;
        return xSemaphoreGiveRecursive(hal->lock);
#else
        return 1;
#endif
}
#ifdef CONFIG_INSTANCE_NAME
 
int32_t hal_printNames();
#endif
 
#ifdef __FRAMAC__
#define HAL_DEFINE_GLOBAL_ARRAY(gns) \
                extern uintptr_t _devs[]; \
                extern uintptr_t *_devs_end
extern uint32_t _devs_size;
#else
 
#define HAL_DEFINE_GLOBAL_ARRAY(gns) \
                extern uintptr_t *_devs; \
                extern uintptr_t *_devs_end
#endif
 
inline uintptr_t *hal_getDev(uintptr_t **devs, uintptr_t **end, uint32_t index) {
#ifdef __FRAMAC__
        if (index >= _devs_size) {
                return NULL;
        }
#else
        /* Eva has problems to handle with this protection mechanism */
        if ((devs + index) >= end) {
                return NULL;
        }
#endif
        return devs[index];
}
#define HAL_GET_DEV(gns, index) (void *) hal_getDev((uintptr_t **) &_devs, &_devs_end, index)
 
#define HAL_LOCK(data, waittime, errcode) do { \
        int32_t lock_ret = hal_lock(data, waittime); \
        if (lock_ret != 1) { \
                return errcode; \
        }; \
} while(0) 
 
#define HAL_UNLOCK(data, errcode) do { \
        int32_t unlock_ret = hal_unlock(data); \
        if (unlock_ret != 1) { \
                return errcode; \
        } \
} while(0)
 
#define HAL_DEFINE_DEVICE_ENTRY(gns, ns, p) extern struct gns##_generic const * const ns##_##p
 
#define HAL_ADDDEV(gns, ns, p) struct gns##_generic SECTION(".rodata.devs") USED NO_REORDER const * const ns##_##p = (void const *) &p
 
#define HAL_ADD(ns, p) HAL_ADDDEV(hal, ns, p)
HAL_DEFINE_GLOBAL_ARRAY(hal);
#define HAL_GET_GLOBAL_DEV(index) HAL_GET_DEV(hal, index)
#ifdef CONFIG_INSTANCE_NAME
 
# define HAL_NAME(n) .gen.name = n,
#else
# define HAL_NAME(n)
#endif
 
#define HAL_GET_ID(gns, ns, p) ({ \
                HAL_DEFINE_DEVICE_ENTRY(gns, ns, p); \
                uint32_t ret; \
                ret = (uint32_t) ((((uintptr_t) (&ns##_##p)) - ((uintptr_t) (&_devs))) / sizeof(uintptr_t)); \
                ret; \
        })
 
#ifdef CONFIG_GEN_VERSION
extern const char *versionDriver;
extern const char *versionMach;
extern const char *versionArch;
extern const char *versionKernel;
#endif
 
#endif