xref: /freebsd/sys/dev/wtap/wtap_hal/hal.h (revision 7ef62cebc2f965b0f640263e179276928885e33d)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2010-2011 Monthadar Al Jaberi, TerraNet AB
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer,
12  *    without modification.
13  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
14  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
15  *    redistribution must be conditioned upon including a substantially
16  *    similar Disclaimer requirement for further binary redistribution.
17  *
18  * NO WARRANTY
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
22  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
23  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
24  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
27  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29  * THE POSSIBILITY OF SUCH DAMAGES.
30  *
31  * $FreeBSD$
32  */
33 
34 #ifndef _WTAP_HAL_H_
35 #define _WTAP_HAL_H_
36 
37 #include "../if_wtapvar.h"
38 #include "../plugins/wtap_plugin.h"
39 #include "handler.h"
40 
41 #define	HAL_TIMER_INTVAL	50 /* in msecs */
42 
43 struct wtap_hal {
44 	struct wtap_medium	*hal_md;
45 	struct mtx		hal_mtx;
46 	struct wtap_plugin	*plugin;
47 	struct wtap_softc 	*hal_devs[MAX_NBR_WTAP];
48 	/* hardware information */
49 	struct hw {
50 		struct callout timer_intr;
51 		uint32_t timer_intr_intval;
52 		uint64_t tsf;
53 	} hw;
54 };
55 
56 void init_hal(struct wtap_hal *);
57 void deinit_hal(struct wtap_hal *);
58 void register_plugin(struct wtap_hal *, struct wtap_plugin *);
59 void deregister_plugin(struct wtap_hal *);
60 int32_t new_wtap(struct wtap_hal *, int32_t id);
61 int32_t free_wtap(struct wtap_hal *, int32_t id);
62 void wtap_hal_timer_intr(void *);
63 void wtap_hal_reset_tsf(struct wtap_hal *);
64 uint64_t wtap_hal_get_tsf(struct wtap_hal *);
65 
66 #endif
67