1/*
2 * Copyright (c) 2004-2006 Voltaire, Inc. All rights reserved.
3 * Copyright (c) 2002-2005 Mellanox Technologies LTD. All rights reserved.
4 * Copyright (c) 1996-2003 Intel Corporation. All rights reserved.
5 *
6 * This software is available to you under a choice of one of two
7 * licenses.  You may choose to be licensed under the terms of the GNU
8 * General Public License (GPL) Version 2, available from the file
9 * COPYING in the main directory of this source tree, or the
10 * OpenIB.org BSD license below:
11 *
12 *     Redistribution and use in source and binary forms, with or
13 *     without modification, are permitted provided that the following
14 *     conditions are met:
15 *
16 *      - Redistributions of source code must retain the above
17 *        copyright notice, this list of conditions and the following
18 *        disclaimer.
19 *
20 *      - Redistributions in binary form must reproduce the above
21 *        copyright notice, this list of conditions and the following
22 *        disclaimer in the documentation and/or other materials
23 *        provided with the distribution.
24 *
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 * SOFTWARE.
33 *
34 */
35
36/*
37 * Abstract:
38 *	Declaration of timer object.
39 */
40
41#ifndef _CL_TIMER_OSD_H_
42#define _CL_TIMER_OSD_H_
43
44#include <complib/cl_types.h>
45#include <complib/cl_spinlock.h>
46
47#ifdef __cplusplus
48#  define BEGIN_C_DECLS extern "C" {
49#  define END_C_DECLS   }
50#else				/* !__cplusplus */
51#  define BEGIN_C_DECLS
52#  define END_C_DECLS
53#endif				/* __cplusplus */
54
55BEGIN_C_DECLS
56#include <complib/cl_qlist.h>
57#include <pthread.h>
58typedef enum _cl_timer_state {
59	CL_TIMER_IDLE,
60	CL_TIMER_QUEUED,
61	CL_TIMER_RUNNING
62} cl_timer_state_t;
63
64typedef struct _cl_timer_t {
65	cl_list_item_t list_item;
66	cl_timer_state_t timer_state;
67	cl_state_t state;
68	cl_pfn_timer_callback_t pfn_callback;
69	const void *context;
70	pthread_cond_t cond;
71	struct timespec timeout;
72} cl_timer_t;
73
74/* Internal functions to create the timer provider. */
75cl_status_t __cl_timer_prov_create(void);
76
77/* Internal function to destroy the timer provider. */
78void __cl_timer_prov_destroy(void);
79
80END_C_DECLS
81#endif				/* _CL_TIMER_OSD_H_ */
82