syscon.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Carlo Caione <ccaione@baylibre.com>
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_DRIVERS_SYSCON_H_
#define ZEPHYR_INCLUDE_DRIVERS_SYSCON_H_

 
#include <errno.h>
 
#include <zephyr/types.h>
#include <zephyr/device.h>
 
#ifdef __cplusplus
extern "C" {
#endif


typedef int (*syscon_api_get_base)(const struct device *dev, uintptr_t *addr);

typedef int (*syscon_api_read_reg)(const struct device *dev, uint16_t reg, uint32_t *val);

typedef int (*syscon_api_write_reg)(const struct device *dev, uint16_t reg, uint32_t val);

typedef int (*syscon_api_update_bits)(const struct device *dev, uint16_t reg,
                                      uint32_t mask, uint32_t val);

typedef int (*syscon_api_get_size)(const struct device *dev, size_t *size);

__subsystem struct syscon_driver_api {
        syscon_api_read_reg read;
        syscon_api_write_reg write;
        syscon_api_update_bits update_bits;
        syscon_api_get_base get_base;
        syscon_api_get_size get_size;
};


__syscall int syscon_get_base(const struct device *dev, uintptr_t *addr);
 
static inline int z_impl_syscon_get_base(const struct device *dev, uintptr_t *addr)
{
        const struct syscon_driver_api *api = DEVICE_API_GET(syscon, dev);
 
        if ((api == NULL) || (api->get_base == NULL)) {
                return -ENOSYS;
        }
 
        return api->get_base(dev, addr);
}
 

__syscall int syscon_read_reg(const struct device *dev, uint16_t reg, uint32_t *val);
 
static inline int z_impl_syscon_read_reg(const struct device *dev, uint16_t reg, uint32_t *val)
{
        const struct syscon_driver_api *api = DEVICE_API_GET(syscon, dev);
 
        if ((api == NULL) || (api->read == NULL)) {
                return -ENOSYS;
        }
 
        return api->read(dev, reg, val);
}
 

__syscall int syscon_write_reg(const struct device *dev, uint16_t reg, uint32_t val);
 
static inline int z_impl_syscon_write_reg(const struct device *dev, uint16_t reg, uint32_t val)
{
        const struct syscon_driver_api *api = DEVICE_API_GET(syscon, dev);
 
        if ((api == NULL) || (api->write == NULL)) {
                return -ENOSYS;
        }
 
        return api->write(dev, reg, val);
}

__syscall int syscon_update_bits(const struct device *dev, uint16_t reg,
                                 uint32_t mask, uint32_t val);
 
static inline int z_impl_syscon_update_bits(const struct device *dev, uint16_t reg,
                                            uint32_t mask, uint32_t val)
{
        const struct syscon_driver_api *api = (const struct syscon_driver_api *)dev->api;
 
        if ((api == NULL) || (api->update_bits == NULL)) {
                return -ENOSYS;
        }
 
        return api->update_bits(dev, reg, mask, val);
}

__syscall int syscon_get_size(const struct device *dev, size_t *size);
 
static inline int z_impl_syscon_get_size(const struct device *dev, size_t *size)
{
        const struct syscon_driver_api *api = DEVICE_API_GET(syscon, dev);
 
        if ((api == NULL) || (api->get_size == NULL)) {
                return -ENOSYS;
        }
 
        return api->get_size(dev, size);
}

 
#ifdef __cplusplus
}
#endif
 
#include <zephyr/syscalls/syscon.h>
 
#endif /* ZEPHYR_INCLUDE_DRIVERS_SYSCON_H_ */