hwspinlock.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Sequans Communications
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DRIVERS_HWSPINLOCK_H_
#define ZEPHYR_INCLUDE_DRIVERS_HWSPINLOCK_H_
 
#include <errno.h>
#include <zephyr/types.h>
#include <zephyr/sys/util.h>
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int (*hwspinlock_api_trylock)(const struct device *dev, uint32_t id);
 
typedef void (*hwspinlock_api_lock)(const struct device *dev, uint32_t id);
 
typedef void (*hwspinlock_api_unlock)(const struct device *dev, uint32_t id);
 
typedef uint32_t (*hwspinlock_api_get_max_id)(const struct device *dev);
 
__subsystem struct hwspinlock_driver_api {
        hwspinlock_api_trylock trylock;
        hwspinlock_api_lock lock;
        hwspinlock_api_unlock unlock;
        hwspinlock_api_get_max_id get_max_id;
};
__syscall int hwspinlock_trylock(const struct device *dev, uint32_t id);
 
static inline int z_impl_hwspinlock_trylock(const struct device *dev, uint32_t id)
{
        const struct hwspinlock_driver_api *api =
                (const struct hwspinlock_driver_api *)dev->api;
 
        if (api->trylock == NULL) {
                return -ENOSYS;
        }
 
        return api->trylock(dev, id);
}
 
__syscall void hwspinlock_lock(const struct device *dev, uint32_t id);
 
static inline void z_impl_hwspinlock_lock(const struct device *dev, uint32_t id)
{
        const struct hwspinlock_driver_api *api =
                (const struct hwspinlock_driver_api *)dev->api;
 
        if (api->lock != NULL) {
                api->lock(dev, id);
        }
}
 
__syscall void hwspinlock_unlock(const struct device *dev, uint32_t id);
 
static inline void z_impl_hwspinlock_unlock(const struct device *dev, uint32_t id)
{
        const struct hwspinlock_driver_api *api =
                (const struct hwspinlock_driver_api *)dev->api;
 
        if (api->unlock != NULL) {
                api->unlock(dev, id);
        }
}
 
__syscall uint32_t hwspinlock_get_max_id(const struct device *dev);
 
static inline uint32_t z_impl_hwspinlock_get_max_id(const struct device *dev)
{
        const struct hwspinlock_driver_api *api =
                (const struct hwspinlock_driver_api *)dev->api;
 
        if (api->get_max_id == NULL) {
                return 0;
        }
 
        return api->get_max_id(dev);
}
 
#ifdef __cplusplus
}
#endif
 
#include <zephyr/syscalls/hwspinlock.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_HWSPINLOCK_H_ */