Skip to content
Permalink
Browse files

cleanup: include/: move aio_comparator.h to drivers/aio_comparator.h

move aio_comparator.h to drivers/aio_comparator.h and
create a shim for backward-compatibility.

No functional changes to the headers.
A warning in the shim can be controlled with CONFIG_COMPAT_INCLUDES.

Related to #16539

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
  • Loading branch information...
nashif committed Jun 25, 2019
1 parent f4709f2 commit 8007266e6a84537ea4f110b8f592c8e931f4a4d8
@@ -5,7 +5,7 @@
*/

#include <syscall_handler.h>
#include <aio_comparator.h>
#include <drivers/aio_comparator.h>

Z_SYSCALL_HANDLER(aio_cmp_disable, dev, index)
{
@@ -11,7 +11,7 @@
#include <soc.h>
#include <device.h>
#include <init.h>
#include <aio_comparator.h>
#include <drivers/aio_comparator.h>

#include "qm_comparator.h"

@@ -1,112 +1,15 @@
/*
* Copyright (c) 2015 Intel Corporation.
* Copyright (c) 2019 Intel Corporation
*
* SPDX-License-Identifier: Apache-2.0
*/

#ifndef ZEPHYR_INCLUDE_AIO_COMPARATOR_H_
#define ZEPHYR_INCLUDE_AIO_COMPARATOR_H_

#ifdef __cplusplus
extern "C" {
#endif

enum aio_cmp_ref {
AIO_CMP_REF_A, /**< Use reference A. */
AIO_CMP_REF_B, /**< Use reference B. */
};

enum aio_cmp_polarity {
AIO_CMP_POL_RISE, /**< Match on rising edge. */
AIO_CMP_POL_FALL, /**< Match on falling edge. */
};

typedef void (*aio_cmp_cb)(void *);

typedef int (*aio_cmp_api_disable)(struct device *dev, u8_t index);

typedef int (*aio_cmp_api_configure)(struct device *dev, u8_t index,
enum aio_cmp_polarity polarity, enum aio_cmp_ref refsel,
aio_cmp_cb cb, void *param);
typedef u32_t (*aio_cmp_api_get_pending_int)(struct device *dev);

struct aio_cmp_driver_api {
aio_cmp_api_disable disable;
aio_cmp_api_configure configure;
aio_cmp_api_get_pending_int get_pending_int;
};

/**
* @brief Disable a particular comparator.
*
* This disables a comparator so that it no longer triggers interrupts.
*
* @param dev Device struct
* @param index The index of the comparator to disable
*
* @return 0 if successful, otherwise failed.
*/
__syscall int aio_cmp_disable(struct device *dev, u8_t index);

static inline int z_impl_aio_cmp_disable(struct device *dev, u8_t index)
{
const struct aio_cmp_driver_api *api = dev->driver_api;

return api->disable(dev, index);
}

/**
* @brief Configure and enable a particular comparator.
*
* This performs configuration and enable a comparator, so that it will
* generate interrupts when conditions are met.
*
* @param dev Device struct
* @param index The index of the comparator to disable
* @param polarity Match polarity (e.g. rising or falling)
* @param refsel Reference for trigger
* @param cb Function callback (aio_cmp_cb)
* @param param Parameters to be passed to callback
*
* @return 0 if successful, otherwise failed.
*/
static inline int aio_cmp_configure(struct device *dev, u8_t index,
enum aio_cmp_polarity polarity,
enum aio_cmp_ref refsel,
aio_cmp_cb cb, void *param)
{
const struct aio_cmp_driver_api *api = dev->driver_api;

return api->configure(dev, index, polarity, refsel, cb, param);
}

/**
* @brief Function to get pending interrupts
*
* The purpose of this function is to return the interrupt
* status register for the device.
* This is especially useful when waking up from
* low power states to check the wake up source.
*
* @param dev Pointer to the device structure for the driver instance.
*
* @retval status != 0 if at least one aio_cmp interrupt is pending.
* @retval 0 if no aio_cmp interrupt is pending.
*/
__syscall int aio_cmp_get_pending_int(struct device *dev);

static inline int z_impl_aio_cmp_get_pending_int(struct device *dev)
{
struct aio_cmp_driver_api *api;

api = (struct aio_cmp_driver_api *)dev->driver_api;
return api->get_pending_int(dev);
}

#ifdef __cplusplus
}
#ifndef CONFIG_COMPAT_INCLUDES
#warning "This header file has moved, include <drivers/aio_comparator.h> instead."
#endif

#include <syscalls/aio_comparator.h>
#include <drivers/aio_comparator.h>

#endif /* ZEPHYR_INCLUDE_AIO_COMPARATOR_H_ */
@@ -0,0 +1,112 @@
/*
* Copyright (c) 2015 Intel Corporation.
*
* SPDX-License-Identifier: Apache-2.0
*/

#ifndef ZEPHYR_INCLUDE_DRIVERS_AIO_COMPARATOR_H_
#define ZEPHYR_INCLUDE_DRIVERS_AIO_COMPARATOR_H_

#ifdef __cplusplus
extern "C" {
#endif

enum aio_cmp_ref {
AIO_CMP_REF_A, /**< Use reference A. */
AIO_CMP_REF_B, /**< Use reference B. */
};

enum aio_cmp_polarity {
AIO_CMP_POL_RISE, /**< Match on rising edge. */
AIO_CMP_POL_FALL, /**< Match on falling edge. */
};

typedef void (*aio_cmp_cb)(void *);

typedef int (*aio_cmp_api_disable)(struct device *dev, u8_t index);

typedef int (*aio_cmp_api_configure)(struct device *dev, u8_t index,
enum aio_cmp_polarity polarity, enum aio_cmp_ref refsel,
aio_cmp_cb cb, void *param);
typedef u32_t (*aio_cmp_api_get_pending_int)(struct device *dev);

struct aio_cmp_driver_api {
aio_cmp_api_disable disable;
aio_cmp_api_configure configure;
aio_cmp_api_get_pending_int get_pending_int;
};

/**
* @brief Disable a particular comparator.
*
* This disables a comparator so that it no longer triggers interrupts.
*
* @param dev Device struct
* @param index The index of the comparator to disable
*
* @return 0 if successful, otherwise failed.
*/
__syscall int aio_cmp_disable(struct device *dev, u8_t index);

static inline int z_impl_aio_cmp_disable(struct device *dev, u8_t index)
{
const struct aio_cmp_driver_api *api = dev->driver_api;

return api->disable(dev, index);
}

/**
* @brief Configure and enable a particular comparator.
*
* This performs configuration and enable a comparator, so that it will
* generate interrupts when conditions are met.
*
* @param dev Device struct
* @param index The index of the comparator to disable
* @param polarity Match polarity (e.g. rising or falling)
* @param refsel Reference for trigger
* @param cb Function callback (aio_cmp_cb)
* @param param Parameters to be passed to callback
*
* @return 0 if successful, otherwise failed.
*/
static inline int aio_cmp_configure(struct device *dev, u8_t index,
enum aio_cmp_polarity polarity,
enum aio_cmp_ref refsel,
aio_cmp_cb cb, void *param)
{
const struct aio_cmp_driver_api *api = dev->driver_api;

return api->configure(dev, index, polarity, refsel, cb, param);
}

/**
* @brief Function to get pending interrupts
*
* The purpose of this function is to return the interrupt
* status register for the device.
* This is especially useful when waking up from
* low power states to check the wake up source.
*
* @param dev Pointer to the device structure for the driver instance.
*
* @retval status != 0 if at least one aio_cmp interrupt is pending.
* @retval 0 if no aio_cmp interrupt is pending.
*/
__syscall int aio_cmp_get_pending_int(struct device *dev);

static inline int z_impl_aio_cmp_get_pending_int(struct device *dev)
{
struct aio_cmp_driver_api *api;

api = (struct aio_cmp_driver_api *)dev->driver_api;
return api->get_pending_int(dev);
}

#ifdef __cplusplus
}
#endif

#include <syscalls/aio_comparator.h>

#endif /* ZEPHYR_INCLUDE_DRIVERS_AIO_COMPARATOR_H_ */
@@ -7,7 +7,7 @@
#include <ztest.h>
#include <gpio.h>
#include <pinmux.h>
#include <aio_comparator.h>
#include <drivers/aio_comparator.h>

#define AIO_CMP_DEV_NAME CONFIG_AIO_COMPARATOR_0_NAME
#define PINMUX_NAME CONFIG_PINMUX_NAME
@@ -30,7 +30,7 @@
#include <zephyr/types.h>
#include <stdio.h>
#include <device.h>
#include <aio_comparator.h>
#include <drivers/aio_comparator.h>

/* specify delay between greetings (in ms) */
#define SLEEPTIME 5000

0 comments on commit 8007266

Please sign in to comment.
You can’t perform that action at this time.