live_entropy_sources.h revision 256381 
1/*-
2 * Copyright (c) 2013 Arthur Mesh <arthurmesh@gmail.com>
3 * Copyright (c) 2013 Mark R V Murray
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer
11 *    in this position and unchanged.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * $FreeBSD: stable/10/sys/dev/random/live_entropy_sources.h 256381 2013-10-12 15:31:36Z markm $
28 */
29
30#ifndef SYS_DEV_RANDOM_LIVE_ENTROPY_SOURCES_H_INCLUDED
31#define SYS_DEV_RANDOM_LIVE_ENTROPY_SOURCES_H_INCLUDED
32
33/*
34 * Live entropy source is a source of entropy that can provide
35 * specified or approximate amount of entropy immediately upon request or within
36 * an acceptable amount of time.
37 */
38struct live_entropy_sources {
39	LIST_ENTRY(live_entropy_sources) entries;	/* list of providers */
40	struct random_hardware_source	*rsource;	/* associated random adaptor */
41};
42
43extern struct mtx live_mtx;
44
45void live_entropy_source_register(struct random_hardware_source *);
46void live_entropy_source_deregister(struct random_hardware_source *);
47void live_entropy_sources_feed(int, event_proc_f);
48
49#define LIVE_ENTROPY_SRC_MODULE(name, modevent, ver)		\
50    static moduledata_t name##_mod = {				\
51	#name,							\
52	modevent,						\
53	0							\
54    };								\
55    DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS,		\
56		   SI_ORDER_SECOND);				\
57    MODULE_VERSION(name, ver);					\
58    MODULE_DEPEND(name, random, 1, 1, 1);
59
60#endif /* SYS_DEV_RANDOM_LIVE_ENTROPY_SOURCES_H_INCLUDED */
61