1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (C) 2012-2013 Intel Corporation
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 * 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 AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 *
28 * $FreeBSD$
29 */
30
31#ifndef __NVMECONTROL_H__
32#define __NVMECONTROL_H__
33
34#include <dev/nvme/nvme.h>
35#include "comnd.h"
36
37typedef void (*print_fn_t)(const struct nvme_controller_data *cdata, void *buf, uint32_t size);
38
39struct logpage_function {
40        SLIST_ENTRY(logpage_function)   link;
41	uint8_t		log_page;
42	const char     *vendor;
43	const char     *name;
44	print_fn_t	print_fn;
45	size_t		size;
46};
47
48#define NVME_LOGPAGE(unique, lp, vend, nam, fn, sz)			\
49	static struct logpage_function unique ## _lpf = {		\
50		.log_page = lp,						\
51		.vendor = vend,						\
52		.name = nam,						\
53		.print_fn = fn, 					\
54		.size = sz,						\
55	} ;								\
56        static void logpage_reg_##unique(void) __attribute__((constructor)); \
57        static void logpage_reg_##unique(void) { logpage_register(&unique##_lpf); }
58
59#define DEFAULT_SIZE	(4096)
60struct kv_name {
61	uint32_t key;
62	const char *name;
63};
64
65const char *kv_lookup(const struct kv_name *kv, size_t kv_count, uint32_t key);
66
67void logpage_register(struct logpage_function *p);
68#define NVME_CTRLR_PREFIX	"nvme"
69#define NVME_NS_PREFIX		"ns"
70
71int open_dev(const char *str, int *fd, int write, int exit_on_error);
72void get_nsid(int fd, char **ctrlr_str, uint32_t *nsid);
73int read_controller_data(int fd, struct nvme_controller_data *cdata);
74int read_namespace_data(int fd, uint32_t nsid, struct nvme_namespace_data *nsdata);
75void print_hex(void *data, uint32_t length);
76void print_namespace(struct nvme_namespace_data *nsdata);
77void read_logpage(int fd, uint8_t log_page, uint32_t nsid, uint8_t lsp,
78    uint16_t lsi, uint8_t rae, void *payload, uint32_t payload_size);
79void print_temp(uint16_t t);
80void print_intel_add_smart(const struct nvme_controller_data *cdata __unused, void *buf, uint32_t size __unused);
81
82/* Utility Routines */
83/*
84 * 128-bit integer augments to standard values. On i386 this
85 * doesn't exist, so we use 64-bit values. So, on 32-bit i386,
86 * you'll get truncated values until someone implement 128bit
87 * ints in sofware.
88 */
89#define UINT128_DIG	39
90#ifdef __i386__
91typedef uint64_t uint128_t;
92#else
93typedef __uint128_t uint128_t;
94#endif
95
96static __inline uint128_t
97to128(void *p)
98{
99	return *(uint128_t *)p;
100}
101
102uint64_t le48dec(const void *pp);
103char * uint128_to_str(uint128_t u, char *buf, size_t buflen);
104#endif
105