/**
 * \file
 *
 * \brief Delayed work abstraction
 *
 * Delayed work abstraction using timer to schedule an item on a timeout and
 * add specified work to a workqueue on timeout.
 *
 * - Compiler:           IAR EWAVR32 and GNU GCC for AVR32
 * - Supported devices:  All devices
 * - AppNote:
 *
 * \author               Atmel Corporation: http://www.atmel.com \n
 *                       Support and FAQ: http://support.atmel.no/
 *
 * \page License
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. The name of Atmel may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * 4. This software may only be redistributed and used in connection with an
 * Atmel AVR product.
 *
 * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
#ifndef DELAYED_WORK_H_INCLUDED
#define DELAYED_WORK_H_INCLUDED

#include <timer_tc.h>
#include <workqueue.h>

/** \brief Delayed work structure */
struct delayed_work {
	/** Timer task to use for timeout */
	struct timer_task	timer_task;
	/** Pointer to timer to use */
	struct timer		*timer;
	/** Pointer to workqueue to add work to */
	struct workqueue	*wq;
	/** Pointer to work to be added after timeout */
	struct workqueue_item	*work;
};

/**
 * \brief Run delayed work in specified amount of us
 *
 * \param dw Delayed work structure
 * \param work Workqueue item ro add to workqueue after timeout
 * \param delay_us Delay before work is added to workqueue
 */
static inline void delayed_work_run_us(struct delayed_work *dw,
		struct workqueue_item *work, uint32_t delay_us)
{
	dw->work = work;
	timer_add_task_us(dw->timer, &dw->timer_task, delay_us);
}

/**
 * \brief Initialize delayed work structure
 *
 * \param dw Delayed wortk structure
 * \param timer Timer to use for delay
 * \param wq Workqueue to add work to
 */
extern void delayed_work_init(struct delayed_work *dw,
		struct timer *timer, struct workqueue *wq);

#endif /* DELAYED_WORK_H_INCLUDED */

