n2rng.h revision 59ac0c1669407488b67ae9e273667a340dccc611
4496171313bed39e96f21bc2f9faf2868e267ae3girish * CDDL HEADER START
4496171313bed39e96f21bc2f9faf2868e267ae3girish * The contents of this file are subject to the terms of the
4496171313bed39e96f21bc2f9faf2868e267ae3girish * Common Development and Distribution License (the "License").
4496171313bed39e96f21bc2f9faf2868e267ae3girish * You may not use this file except in compliance with the License.
4496171313bed39e96f21bc2f9faf2868e267ae3girish * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
4496171313bed39e96f21bc2f9faf2868e267ae3girish * See the License for the specific language governing permissions
4496171313bed39e96f21bc2f9faf2868e267ae3girish * and limitations under the License.
4496171313bed39e96f21bc2f9faf2868e267ae3girish * When distributing Covered Code, include this CDDL HEADER in each
4496171313bed39e96f21bc2f9faf2868e267ae3girish * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
4496171313bed39e96f21bc2f9faf2868e267ae3girish * If applicable, add the following below this CDDL HEADER, with the
4496171313bed39e96f21bc2f9faf2868e267ae3girish * fields enclosed by brackets "[]" replaced with your own identifying
4496171313bed39e96f21bc2f9faf2868e267ae3girish * information: Portions Copyright [yyyy] [name of copyright owner]
4496171313bed39e96f21bc2f9faf2868e267ae3girish * CDDL HEADER END
59ac0c1669407488b67ae9e273667a340dccc611davemq * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
4496171313bed39e96f21bc2f9faf2868e267ae3girish * Use is subject to license terms.
4496171313bed39e96f21bc2f9faf2868e267ae3girish#pragma ident "%Z%%M% %I% %E% SMI"
4496171313bed39e96f21bc2f9faf2868e267ae3girish/* skip following stuff when included in n2rng_hcall.s */
4496171313bed39e96f21bc2f9faf2868e267ae3girish#endif /* !_ASM */
4496171313bed39e96f21bc2f9faf2868e267ae3girishextern "C" {
4496171313bed39e96f21bc2f9faf2868e267ae3girish * RNG HV API version definitions.
4496171313bed39e96f21bc2f9faf2868e267ae3girishtypedef union n2rngctl {
4496171313bed39e96f21bc2f9faf2868e267ae3girishtypedef struct {
4496171313bed39e96f21bc2f9faf2868e267ae3girish * Our contiguous memory alignment requirement is
4496171313bed39e96f21bc2f9faf2868e267ae3girish * only for 8 bytes, however contig mem allocation
4496171313bed39e96f21bc2f9faf2868e267ae3girish * routines requirement minimum of 64.
4496171313bed39e96f21bc2f9faf2868e267ae3girish * Returns 1 only if the address range of a variable of type type at
4496171313bed39e96f21bc2f9faf2868e267ae3girish * ptr falls entirely on one page. Based on page size of 4K. May
4496171313bed39e96f21bc2f9faf2868e267ae3girish * give some false negatives on larger page sizes.
4496171313bed39e96f21bc2f9faf2868e267ae3girish (((((uint64_t)(ptr)) ^ ((uint64_t)(ptr) + sizeof (type) -1)) \
4496171313bed39e96f21bc2f9faf2868e267ae3girish * The RNG hardware can send certain internal analog signals to an
4496171313bed39e96f21bc2f9faf2868e267ae3girish * external pin on the chip. Setting the rnc_anlg_sel bit to
4496171313bed39e96f21bc2f9faf2868e267ae3girish * N2RNG_NOANALOGOUT deselects all analog signals (perhaps selects
4496171313bed39e96f21bc2f9faf2868e267ae3girish * ground). Choosing any other value would aid an attacker with
4496171313bed39e96f21bc2f9faf2868e267ae3girish * physical access to the chip.
4496171313bed39e96f21bc2f9faf2868e267ae3girish * There can only be N2_RNG_FIPS_INSTANCES concurrent RNG requsts from
4496171313bed39e96f21bc2f9faf2868e267ae3girish * the framework. Making this value large helps benchmarks. It
4496171313bed39e96f21bc2f9faf2868e267ae3girish * should probably come from a conf file, but for now it is hard
4496171313bed39e96f21bc2f9faf2868e267ae3girish * coded. The code computes i % N2RNG_FIPS_INSTANCES, which is more
4496171313bed39e96f21bc2f9faf2868e267ae3girish * efficient when N2RNG_FIPS_INSTANCES is a power of 2.
4496171313bed39e96f21bc2f9faf2868e267ae3girish uint64_t entropyhunger; /* RNGs generated with no entropy */
4496171313bed39e96f21bc2f9faf2868e267ae3girish uint32_t XKEY[6]; /* one extra word for getentropy */
4496171313bed39e96f21bc2f9faf2868e267ae3girishtypedef struct {
4496171313bed39e96f21bc2f9faf2868e267ae3girish * volatile, since it is not protected by a mutex. (That is
4496171313bed39e96f21bc2f9faf2868e267ae3girish * okay since it is operated on and accessed via atomic ops.)
4496171313bed39e96f21bc2f9faf2868e267ae3girish volatile unsigned int fips_round_robin_j;
4496171313bed39e96f21bc2f9faf2868e267ae3girish#define N2RNG_FAILED 0x1 /* for n_flags; used by kstat */
4496171313bed39e96f21bc2f9faf2868e267ae3girishtypedef struct {
4496171313bed39e96f21bc2f9faf2868e267ae3girishtypedef n2rng_osc_perf_t n2rng_osc_perf_table_t[N2RNG_NOSC][N2RNG_NBIASES];
4496171313bed39e96f21bc2f9faf2868e267ae3girishtypedef struct n2rng {
4496171313bed39e96f21bc2f9faf2868e267ae3girish uint64_t n_rng_state; /* as last known in this drvr. */
4496171313bed39e96f21bc2f9faf2868e267ae3girish#define RNG_DIAG_CHUNK_SIZE (N2RNG_MAX_READ / 8) /* as words */
4496171313bed39e96f21bc2f9faf2868e267ae3girish#define RNG_RETRY_HLCHK_USECS 100000 /* retry every .1 seconds */
4496171313bed39e96f21bc2f9faf2868e267ae3girishint n2rng_collect_diag_bits(n2rng_t *n2rng, n2rng_setup_t *collect_setupp,
4496171313bed39e96f21bc2f9faf2868e267ae3girish void *buffer, int numbytes, n2rng_setup_t *exit_setupp,
4496171313bed39e96f21bc2f9faf2868e267ae3girishint n2rng_getentropy(n2rng_t *n2rng, void *buffer, size_t size);
4496171313bed39e96f21bc2f9faf2868e267ae3girishint n2rng_fips_random_init(n2rng_t *n2rng, fipsrandomstruct_t *frsp);
4496171313bed39e96f21bc2f9faf2868e267ae3girishvoid n2rng_fips_random_fini(fipsrandomstruct_t *frsp);
4496171313bed39e96f21bc2f9faf2868e267ae3girishvoid n2rng_renyi_entropy(uint64_t *buffer, int log2samples,
4496171313bed39e96f21bc2f9faf2868e267ae3girish#if defined(DEBUG)
4496171313bed39e96f21bc2f9faf2868e267ae3girish#define DMOD 0x00000040 /* _init/_fini/_info/attach/detach */
4496171313bed39e96f21bc2f9faf2868e267ae3girish#define DENTRY 0x00000080 /* crypto routine entry/exit points */
4496171313bed39e96f21bc2f9faf2868e267ae3girish#define DBGCALL(flag, func) { if (n2rng_dflagset(flag)) (void) func; }
4496171313bed39e96f21bc2f9faf2868e267ae3girishvoid n2rng_dprintf(n2rng_t *, int, const char *, ...);
4496171313bed39e96f21bc2f9faf2868e267ae3girishvoid n2rng_dumphex(void *, int);
4496171313bed39e96f21bc2f9faf2868e267ae3girish#else /* !defined(DEBUG) */
4496171313bed39e96f21bc2f9faf2868e267ae3girish#define DBG5(vca, lvl, fmt, arg1, arg2, arg3, arg4, arg5)
4496171313bed39e96f21bc2f9faf2868e267ae3girish#define DBG6(vca, lvl, fmt, arg1, arg2, arg3, arg4, arg5, arg6)
4496171313bed39e96f21bc2f9faf2868e267ae3girish#endif /* !defined(DEBUG) */
4496171313bed39e96f21bc2f9faf2868e267ae3girishvoid n2rng_dipverror(dev_info_t *, const char *, va_list);
4496171313bed39e96f21bc2f9faf2868e267ae3girishuint64_t hv_rng_read_ctl(uint64_t ctlregs_pa, uint64_t *state,
4496171313bed39e96f21bc2f9faf2868e267ae3girish uint64_t newstate, uint64_t wtimeout, uint64_t *tdelta);
4496171313bed39e96f21bc2f9faf2868e267ae3girishuint64_t hv_rng_data_read(uint64_t data_pa, uint64_t *tdelta);
4496171313bed39e96f21bc2f9faf2868e267ae3girish#endif /* _KERNEL */
4496171313bed39e96f21bc2f9faf2868e267ae3girish#endif /* !_ASM */
4496171313bed39e96f21bc2f9faf2868e267ae3girish#endif /* _SYS_N2RNG_H */