1/*-
2 * Copyright (c) 2013-2015, 2017 Mark R V Murray
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer
10 *    in this position and unchanged.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD$
27 */
28
29#ifndef SYS_DEV_RANDOM_RANDOM_HARVESTQ_H_INCLUDED
30#define	SYS_DEV_RANDOM_RANDOM_HARVESTQ_H_INCLUDED
31
32#define	HARVESTSIZE	2	/* Max length in words of each harvested entropy unit */
33
34/* These are used to queue harvested packets of entropy. The entropy
35 * buffer size is pretty arbitrary.
36 */
37struct harvest_event {
38	uint32_t	he_somecounter;		/* fast counter for clock jitter */
39	uint32_t	he_entropy[HARVESTSIZE];/* some harvested entropy */
40	uint8_t		he_size;		/* harvested entropy byte count */
41	uint8_t		he_destination;		/* destination pool of this entropy */
42	uint8_t		he_source;		/* origin of the entropy */
43};
44
45void read_rate_increment(u_int);
46
47#define	RANDOM_HARVEST_INIT_LOCK(x)	mtx_init(&harvest_context.hc_mtx, "entropy harvest mutex", NULL, MTX_SPIN)
48#define	RANDOM_HARVEST_LOCK(x)		mtx_lock_spin(&harvest_context.hc_mtx)
49#define	RANDOM_HARVEST_UNLOCK(x)	mtx_unlock_spin(&harvest_context.hc_mtx)
50
51#endif /* SYS_DEV_RANDOM_RANDOM_HARVESTQ_H_INCLUDED */
52