/* * CDDL HEADER START * * The contents of this file are subject to the terms of the * Common Development and Distribution License (the "License"). * You may not use this file except in compliance with the License. * * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE * or http://www.opensolaris.org/os/licensing. * See the License for the specific language governing permissions * and limitations under the License. * * When distributing Covered Code, include this CDDL HEADER in each * file and include the License file at usr/src/OPENSOLARIS.LICENSE. * If applicable, add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your own identifying * information: Portions Copyright [yyyy] [name of copyright owner] * * CDDL HEADER END */ /* * Copyright 2007 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. */ #ifndef _SYS_N2RNG_H #define _SYS_N2RNG_H #pragma ident "%Z%%M% %I% %E% SMI" /* skip following stuff when included in n2rng_hcall.s */ #ifndef _ASM #include #include #include #include #include #include #include #endif /* !_ASM */ #ifdef __cplusplus extern "C" { #endif /* * RNG HV API version definitions. */ #define RNG_MAJOR_VER 1 #define RNG_MINOR_VER 0 #define HV_RNG_GET_DIAG_CONTROL 0x130 #define HV_RNG_CTL_READ 0x131 #define HV_RNG_CTL_WRITE 0x132 #define HV_RNG_DATA_READ_DIAG 0x133 #define HV_RNG_DATA_READ 0x134 #define CTL_STATE_UNCONFIGURED 0 #define CTL_STATE_CONFIGURED 1 #define CTL_STATE_HEALTHCHECK 2 #define CTL_STATE_ERROR 3 #define NRNGCTL 4 #define N2RNG_MAX_READ (128 * 1024) /* 128K bytes */ #define DRIVER "n2rng" #define N2RNG_MANUFACTURER_ID "SUNWn2rng" #ifndef _ASM typedef union n2rngctl { uint64_t word; struct { uint64_t rnc_res : 39; uint64_t rnc_cnt : 16; uint64_t rnc_bypass : 1; uint64_t rnc_vcoctl : 2; uint64_t rnc_anlg_sel : 2; uint64_t rnc_mode : 1; uint64_t rnc_selbits : 3; } fields; } n2rng_ctl_t; typedef struct { n2rng_ctl_t ctlwds[NRNGCTL]; } n2rng_setup_t; #if defined(_KERNEL) /* * Our contiguous memory alignment requirement is * only for 8 bytes, however contig mem allocation * routines requirement minimum of 64. */ #define CONTIG_ALIGNMENT 64 /* * Returns 1 only if the address range of a variable of type type at * ptr falls entirely on one page. Based on page size of 4K. May * give some false negatives on larger page sizes. */ #define CONTIGUOUS(ptr, type) \ (((((uint64_t)(ptr)) ^ ((uint64_t)(ptr) + sizeof (type) -1)) \ & PAGEMASK) == 0) /* * The RNG hardware can send certain internal analog signals to an * external pin on the chip. Setting the rnc_anlg_sel bit to * N2RNG_NOANALOGOUT deselects all analog signals (perhaps selects * ground). Choosing any other value would aid an attacker with * physical access to the chip. */ #define N2RNG_NOANALOGOUT 0x2 /* * There can only be N2_RNG_FIPS_INSTANCES concurrent RNG requsts from * the framework. Making this value large helps benchmarks. It * should probably come from a conf file, but for now it is hard * coded. The code computes i % N2RNG_FIPS_INSTANCES, which is more * efficient when N2RNG_FIPS_INSTANCES is a power of 2. */ #define N2RNG_FIPS_INSTANCES 8 typedef struct fipsrandomstruct fipsrandomstruct_t; struct fipsrandomstruct { kmutex_t mtx; uint64_t entropyhunger; /* RNGs generated with no entropy */ uint32_t XKEY[6]; /* one extra word for getentropy */ }; typedef struct { /* * volatile, since it is not protected by a mutex. (That is * okay since it is operated on and accessed via atomic ops.) */ volatile unsigned int fips_round_robin_j; fipsrandomstruct_t fipsarray[N2RNG_FIPS_INSTANCES]; } fips_ensemble_t; #define N2RNG_FAILED 0x1 /* for n_flags; used by kstat */ #define DS_RNGBYTES 0 #define DS_RNGJOBS 1 #define DS_RNGHEALTHCHECKS 2 #define DS_MAX 3 #define N2RNG_NOSC 3 #define N2RNG_BIASBITS 2 #define N2RNG_NBIASES (1 << N2RNG_BIASBITS) #define N2RNG_CTLOPS (N2RNG_OSC + 1) typedef struct { uint64_t numvals; uint64_t H1; /* in bits per bit << LOG_VAL_SCALE */ uint64_t H2; uint64_t Hinf; } n2rng_osc_perf_t; typedef n2rng_osc_perf_t n2rng_osc_perf_table_t[N2RNG_NOSC][N2RNG_NBIASES]; typedef struct n2rng { kmutex_t n_lock; dev_info_t *n_dip; minor_t n_minor; unsigned n_flags; /* dev state flags */ kstat_t *n_ksp; uint64_t n_stats[DS_MAX]; crypto_kcf_provider_handle_t n_prov; fips_ensemble_t n_frs; n2rng_osc_perf_table_t n_perftable; n2rng_setup_t n_preferred_config; kmutex_t n_health_check_mutex; time_t n_last_health_time; uint64_t n_rng_state; /* as last known in this drvr. */ uint64_t n_sticks_per_usec; uint64_t n_anlg_settle_cycles; ddi_taskq_t *n_taskq; } n2rng_t; typedef struct n2rng_stat n2rng_stat_t; struct n2rng_stat { kstat_named_t ns_status; kstat_named_t ns_algs[DS_MAX]; }; #define RNG_MODE_NORMAL 1 #define RNG_MODE_DIAGNOSTIC 0 #define RNG_CTL_SETTLE_NS 2000000 /* nanoseconds */ #define RNG_DIAG_CHUNK_SIZE (N2RNG_MAX_READ / 8) /* as words */ #define RNG_MAX_DATA_READ_ATTEMPTS 100 #define RNG_DEFAULT_ACCUMULATE_CYCLES 4000 #define RNG_RETRY_HLCHK_USECS 100000 /* retry every .1 seconds */ #define LOG_ARG_SCALE 49 #define LOG_VAL_SCALE 32 void n2rng_sort(uint64_t *data, int log2_size); int n2rng_noise_gen_preferred(n2rng_t *n2rng); int n2rng_check_set(n2rng_t *n2rng); int n2rng_collect_diag_bits(n2rng_t *n2rng, n2rng_setup_t *collect_setupp, void *buffer, int numbytes, n2rng_setup_t *exit_setupp, uint64_t exitstate); int n2rng_getentropy(n2rng_t *n2rng, void *buffer, size_t size); int n2rng_fips_random_init(n2rng_t *n2rng, fipsrandomstruct_t *frsp); void n2rng_fips_random_fini(fipsrandomstruct_t *frsp); int n2rng_do_health_check(n2rng_t *n2rng); void n2rng_renyi_entropy(uint64_t *buffer, int log2samples, n2rng_osc_perf_t *metricp); #if defined(DEBUG) #define DWARN 0x00000001 #define DMA_ARGS 0x00000002 #define DMA_LDST 0x00000004 #define DNCS_QTAIL 0x00000008 #define DATTACH 0x00000010 #define DMOD 0x00000040 /* _init/_fini/_info/attach/detach */ #define DENTRY 0x00000080 /* crypto routine entry/exit points */ #define DCHATTY 0x00000100 #define DALL 0xFFFFFFFF #define DBG0 n2rng_dprintf #define DBG1 n2rng_dprintf #define DBG2 n2rng_dprintf #define DBG3 n2rng_dprintf #define DBG4 n2rng_dprintf #define DBG5 n2rng_dprintf #define DBG6 n2rng_dprintf #define DBGCALL(flag, func) { if (n2rng_dflagset(flag)) (void) func; } void n2rng_dprintf(n2rng_t *, int, const char *, ...); void n2rng_dumphex(void *, int); int n2rng_dflagset(int); #else /* !defined(DEBUG) */ #define DBG0(vca, lvl, fmt) #define DBG1(vca, lvl, fmt, arg1) #define DBG2(vca, lvl, fmt, arg1, arg2) #define DBG3(vca, lvl, fmt, arg1, arg2, arg3) #define DBG4(vca, lvl, fmt, arg1, arg2, arg3, arg4) #define DBG5(vca, lvl, fmt, arg1, arg2, arg3, arg4, arg5) #define DBG6(vca, lvl, fmt, arg1, arg2, arg3, arg4, arg5, arg6) #define DBGCALL(flag, func) #endif /* !defined(DEBUG) */ /* * n2rng_debug.c */ void n2rng_error(n2rng_t *, const char *, ...); void n2rng_diperror(dev_info_t *, const char *, ...); void n2rng_dipverror(dev_info_t *, const char *, va_list); uint64_t hv_rng_get_diag_control(void); uint64_t hv_rng_read_ctl(uint64_t ctlregs_pa, uint64_t *state, uint64_t *tdelta); uint64_t hv_rng_ctl_write(uint64_t ctlregs_pa, uint64_t newstate, uint64_t wtimeout, uint64_t *tdelta); uint64_t hv_rng_data_read_diag(uint64_t data_pa, size_t datalen, uint64_t *tdelta); uint64_t hv_rng_data_read(uint64_t data_pa, uint64_t *tdelta); #endif /* _KERNEL */ #endif /* !_ASM */ #ifdef __cplusplus } #endif #endif /* _SYS_N2RNG_H */