timeaware_gpio.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Intel Corporation.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#ifndef ZEPHYR_DRIVERS_MISC_TIMEAWARE_GPIO_TIMEAWARE_GPIO
#define ZEPHYR_DRIVERS_MISC_TIMEAWARE_GPIO_TIMEAWARE_GPIO

 
#include <zephyr/sys/__assert.h>
#include <zephyr/sys/slist.h>
 
#include <zephyr/types.h>
#include <stddef.h>
#include <zephyr/device.h>
#include <zephyr/internal/syscall_handler.h>
 
#ifdef __cplusplus
extern "C" {
#endif

enum tgpio_pin_polarity {
        TGPIO_RISING_EDGE = 0, 
        TGPIO_FALLING_EDGE,    
        TGPIO_TOGGLE_EDGE,     
};


__subsystem struct tgpio_driver_api {
        int (*pin_disable)(const struct device *dev, uint32_t pin);
        int (*get_time)(const struct device *dev, uint64_t *current_time);
        int (*cyc_per_sec)(const struct device *dev, uint32_t *cycles);
        int (*set_perout)(const struct device *dev, uint32_t pin, uint64_t start_time,
                          uint64_t repeat_interval, bool periodic_enable);
        int (*config_ext_ts)(const struct device *dev, uint32_t pin, uint32_t event_polarity);
        int (*read_ts_ec)(const struct device *dev, uint32_t pin, uint64_t *timestamp,
                          uint64_t *event_count);
};


__syscall int tgpio_port_get_time(const struct device *dev, uint64_t *current_time);
 
static inline int z_impl_tgpio_port_get_time(const struct device *dev, uint64_t *current_time)
{
        return DEVICE_API_GET(tgpio, dev)->get_time(dev, current_time);
}

__syscall int tgpio_port_get_cycles_per_second(const struct device *dev, uint32_t *cycles);
 
static inline int z_impl_tgpio_port_get_cycles_per_second(const struct device *dev,
                                                           uint32_t *cycles)
{
        return DEVICE_API_GET(tgpio, dev)->cyc_per_sec(dev, cycles);
}

__syscall int tgpio_pin_disable(const struct device *dev, uint32_t pin);
 
static inline int z_impl_tgpio_pin_disable(const struct device *dev, uint32_t pin)
{
        return DEVICE_API_GET(tgpio, dev)->pin_disable(dev, pin);
}

__syscall int tgpio_pin_config_ext_timestamp(const struct device *dev, uint32_t pin,
                                              uint32_t event_polarity);
 
static inline int z_impl_tgpio_pin_config_ext_timestamp(const struct device *dev, uint32_t pin,
                                                         uint32_t event_polarity)
{
        return DEVICE_API_GET(tgpio, dev)->config_ext_ts(dev, pin, event_polarity);
}

__syscall int tgpio_pin_periodic_output(const struct device *dev, uint32_t pin,
                                         uint64_t start_time, uint64_t repeat_interval,
                                         bool periodic_enable);
 
static inline int z_impl_tgpio_pin_periodic_output(const struct device *dev, uint32_t pin,
                                                    uint64_t start_time, uint64_t repeat_interval,
                                                    bool periodic_enable)
{
        return DEVICE_API_GET(tgpio, dev)->set_perout(dev, pin, start_time, repeat_interval,
                                                      periodic_enable);
}

__syscall int tgpio_pin_read_ts_ec(const struct device *dev, uint32_t pin, uint64_t *timestamp,
                                    uint64_t *event_count);
 
static inline int z_impl_tgpio_pin_read_ts_ec(const struct device *dev, uint32_t pin,
                                               uint64_t *timestamp, uint64_t *event_count)
{
        return DEVICE_API_GET(tgpio, dev)->read_ts_ec(dev, pin, timestamp, event_count);
}

 
#ifdef __cplusplus
}
#endif
 
#include <zephyr/syscalls/timeaware_gpio.h>
 
#endif /* ZEPHYR_DRIVERS_MISC_TIMEAWARE_GPIO_TIMEAWARE_GPIO */