xref: /freebsd/sys/dev/wtap/wtap_hal/hal.h (revision f81cdf24ba5436367377f7c8e8f51f6df2a75ca7)
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 
32 #ifndef _WTAP_HAL_H_
33 #define _WTAP_HAL_H_
34 
35 #include "../if_wtapvar.h"
36 #include "../plugins/wtap_plugin.h"
37 #include "handler.h"
38 
39 #define	HAL_TIMER_INTVAL	50 /* in msecs */
40 
41 struct wtap_hal {
42 	struct wtap_medium	*hal_md;
43 	struct mtx		hal_mtx;
44 	struct wtap_plugin	*plugin;
45 	struct wtap_softc 	*hal_devs[MAX_NBR_WTAP];
46 	/* hardware information */
47 	struct hw {
48 		struct callout timer_intr;
49 		uint32_t timer_intr_intval;
50 		uint64_t tsf;
51 	} hw;
52 };
53 
54 void init_hal(struct wtap_hal *);
55 void deinit_hal(struct wtap_hal *);
56 void register_plugin(struct wtap_hal *, struct wtap_plugin *);
57 void deregister_plugin(struct wtap_hal *);
58 int32_t new_wtap(struct wtap_hal *, int32_t id);
59 int32_t free_wtap(struct wtap_hal *, int32_t id);
60 void wtap_hal_timer_intr(void *);
61 void wtap_hal_reset_tsf(struct wtap_hal *);
62 uint64_t wtap_hal_get_tsf(struct wtap_hal *);
63 
64 #endif
65