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