1*fd501800SSascha Wildner /*-
2*fd501800SSascha Wildner * Copyright (c) 2008 Yahoo!, Inc.
3*fd501800SSascha Wildner * All rights reserved.
4*fd501800SSascha Wildner * Written by: John Baldwin <jhb@FreeBSD.org>
5*fd501800SSascha Wildner *
6*fd501800SSascha Wildner * Redistribution and use in source and binary forms, with or without
7*fd501800SSascha Wildner * modification, are permitted provided that the following conditions
8*fd501800SSascha Wildner * are met:
9*fd501800SSascha Wildner * 1. Redistributions of source code must retain the above copyright
10*fd501800SSascha Wildner * notice, this list of conditions and the following disclaimer.
11*fd501800SSascha Wildner * 2. Redistributions in binary form must reproduce the above copyright
12*fd501800SSascha Wildner * notice, this list of conditions and the following disclaimer in the
13*fd501800SSascha Wildner * documentation and/or other materials provided with the distribution.
14*fd501800SSascha Wildner * 3. Neither the name of the author nor the names of any co-contributors
15*fd501800SSascha Wildner * may be used to endorse or promote products derived from this software
16*fd501800SSascha Wildner * without specific prior written permission.
17*fd501800SSascha Wildner *
18*fd501800SSascha Wildner * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19*fd501800SSascha Wildner * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20*fd501800SSascha Wildner * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21*fd501800SSascha Wildner * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22*fd501800SSascha Wildner * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23*fd501800SSascha Wildner * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24*fd501800SSascha Wildner * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25*fd501800SSascha Wildner * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26*fd501800SSascha Wildner * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27*fd501800SSascha Wildner * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28*fd501800SSascha Wildner * SUCH DAMAGE.
29*fd501800SSascha Wildner *
30*fd501800SSascha Wildner * $FreeBSD: head/usr.sbin/mpsutil/mpsutil.h 330790 2018-03-12 05:03:32Z scottl $
31*fd501800SSascha Wildner */
32*fd501800SSascha Wildner
33*fd501800SSascha Wildner #ifndef __MPSUTIL_H__
34*fd501800SSascha Wildner #define __MPSUTIL_H__
35*fd501800SSascha Wildner
36*fd501800SSascha Wildner #include <sys/cdefs.h>
37*fd501800SSascha Wildner #include <sys/linker_set.h>
38*fd501800SSascha Wildner #include <stdbool.h>
39*fd501800SSascha Wildner
40*fd501800SSascha Wildner #include <dev/raid/mps/mpi/mpi2_type.h>
41*fd501800SSascha Wildner #include <dev/raid/mps/mpi/mpi2.h>
42*fd501800SSascha Wildner #include <dev/raid/mps/mpi/mpi2_cnfg.h>
43*fd501800SSascha Wildner #include <dev/raid/mps/mpi/mpi2_raid.h>
44*fd501800SSascha Wildner #include <dev/raid/mps/mpi/mpi2_ioc.h>
45*fd501800SSascha Wildner #include <dev/raid/mps/mpi/mpi2_init.h>
46*fd501800SSascha Wildner #include <dev/raid/mps/mpi/mpi2_tool.h>
47*fd501800SSascha Wildner
48*fd501800SSascha Wildner #define MPSUTIL_VERSION "1.0.0"
49*fd501800SSascha Wildner
50*fd501800SSascha Wildner #define IOC_STATUS_SUCCESS(status) \
51*fd501800SSascha Wildner (((status) & MPI2_IOCSTATUS_MASK) == MPI2_IOCSTATUS_SUCCESS)
52*fd501800SSascha Wildner
53*fd501800SSascha Wildner struct mpsutil_command {
54*fd501800SSascha Wildner const char *name;
55*fd501800SSascha Wildner int (*handler)(int ac, char **av);
56*fd501800SSascha Wildner };
57*fd501800SSascha Wildner struct mpsutil_usage {
58*fd501800SSascha Wildner const char *set;
59*fd501800SSascha Wildner const char *name;
60*fd501800SSascha Wildner void (*handler)(const char **, const char**);
61*fd501800SSascha Wildner };
62*fd501800SSascha Wildner
63*fd501800SSascha Wildner #define MPS_DATASET(name) mpsutil_ ## name ## _table
64*fd501800SSascha Wildner
65*fd501800SSascha Wildner #define MPS_COMMAND(set, name, function, args, desc) \
66*fd501800SSascha Wildner static struct mpsutil_command function ## _mpsutil_command = \
67*fd501800SSascha Wildner { #name, function }; \
68*fd501800SSascha Wildner DATA_SET(MPS_DATASET(set), function ## _mpsutil_command); \
69*fd501800SSascha Wildner static void \
70*fd501800SSascha Wildner function ## _usage(const char **a3, const char **a4) \
71*fd501800SSascha Wildner { \
72*fd501800SSascha Wildner *a3 = args; \
73*fd501800SSascha Wildner *a4 = desc; \
74*fd501800SSascha Wildner return; \
75*fd501800SSascha Wildner }; \
76*fd501800SSascha Wildner static struct mpsutil_usage function ## _mpsutil_usage = \
77*fd501800SSascha Wildner { #set, #name, function ## _usage }; \
78*fd501800SSascha Wildner DATA_SET(MPS_DATASET(usage), function ## _mpsutil_usage);
79*fd501800SSascha Wildner
80*fd501800SSascha Wildner #define _MPS_COMMAND(set, name, function) \
81*fd501800SSascha Wildner static struct mpsutil_command function ## _mpsutil_command = \
82*fd501800SSascha Wildner { #name, function }; \
83*fd501800SSascha Wildner DATA_SET(MPS_DATASET(set), function ## _mpsutil_command);
84*fd501800SSascha Wildner
85*fd501800SSascha Wildner #define MPS_TABLE(set, name) \
86*fd501800SSascha Wildner SET_DECLARE(MPS_DATASET(name), struct mpsutil_command); \
87*fd501800SSascha Wildner \
88*fd501800SSascha Wildner static int \
89*fd501800SSascha Wildner mpsutil_ ## name ## _table_handler(int ac, char **av) \
90*fd501800SSascha Wildner { \
91*fd501800SSascha Wildner return (mps_table_handler(SET_BEGIN(MPS_DATASET(name)), \
92*fd501800SSascha Wildner SET_LIMIT(MPS_DATASET(name)), ac, av)); \
93*fd501800SSascha Wildner } \
94*fd501800SSascha Wildner _MPS_COMMAND(set, name, mpsutil_ ## name ## _table_handler)
95*fd501800SSascha Wildner
96*fd501800SSascha Wildner extern int mps_unit;
97*fd501800SSascha Wildner extern int is_mps;
98*fd501800SSascha Wildner #define MPS_MAX_UNIT 10
99*fd501800SSascha Wildner
100*fd501800SSascha Wildner void hexdump(const void *ptr, int length, const char *hdr, int flags);
101*fd501800SSascha Wildner #define HD_COLUMN_MASK 0xff
102*fd501800SSascha Wildner #define HD_DELIM_MASK 0xff00
103*fd501800SSascha Wildner #define HD_OMIT_COUNT (1 << 16)
104*fd501800SSascha Wildner #define HD_OMIT_HEX (1 << 17)
105*fd501800SSascha Wildner #define HD_OMIT_CHARS (1 << 18)
106*fd501800SSascha Wildner #define HD_REVERSED (1 << 19)
107*fd501800SSascha Wildner int mps_parse_flags(uintmax_t, const char *, char *, int);
108*fd501800SSascha Wildner
109*fd501800SSascha Wildner int mps_open(int unit);
110*fd501800SSascha Wildner int mps_table_handler(struct mpsutil_command **start,
111*fd501800SSascha Wildner struct mpsutil_command **end, int ac, char **av);
112*fd501800SSascha Wildner int mps_user_command(int fd, void *req, uint32_t req_len, void *reply,
113*fd501800SSascha Wildner uint32_t reply_len, void *buffer, int len, uint32_t flags);
114*fd501800SSascha Wildner int mps_pass_command(int fd, void *req, uint32_t req_len, void *reply,
115*fd501800SSascha Wildner uint32_t reply_len, void *data_in, uint32_t datain_len, void *data_out,
116*fd501800SSascha Wildner uint32_t dataout_len, uint32_t timeout);
117*fd501800SSascha Wildner int mps_read_config_page_header(int fd, U8 PageType, U8 PageNumber,
118*fd501800SSascha Wildner U32 PageAddress, MPI2_CONFIG_PAGE_HEADER *header, U16 *IOCStatus);
119*fd501800SSascha Wildner int mps_read_ext_config_page_header(int fd, U8 ExtPageType, U8 PageNumber,
120*fd501800SSascha Wildner U32 PageAddress, MPI2_CONFIG_PAGE_HEADER *header,
121*fd501800SSascha Wildner U16 *ExtPageLen, U16 *IOCStatus);
122*fd501800SSascha Wildner void *mps_read_config_page(int fd, U8 PageType, U8 PageNumber,
123*fd501800SSascha Wildner U32 PageAddress, U16 *IOCStatus);
124*fd501800SSascha Wildner void *mps_read_extended_config_page(int fd, U8 ExtPageType, U8 PageVersion,
125*fd501800SSascha Wildner U8 PageNumber, U32 PageAddress, U16 *IOCStatus);
126*fd501800SSascha Wildner int mps_map_btdh(int fd, uint16_t *devhandle, uint16_t *bus,
127*fd501800SSascha Wildner uint16_t *target);
128*fd501800SSascha Wildner const char *mps_ioc_status(U16 IOCStatus);
129*fd501800SSascha Wildner int mps_firmware_send(int fd, unsigned char *buf, uint32_t len, bool bios);
130*fd501800SSascha Wildner int mps_firmware_get(int fd, unsigned char **buf, bool bios);
131*fd501800SSascha Wildner
132*fd501800SSascha Wildner static __inline void *
mps_read_man_page(int fd,U8 PageNumber,U16 * IOCStatus)133*fd501800SSascha Wildner mps_read_man_page(int fd, U8 PageNumber, U16 *IOCStatus)
134*fd501800SSascha Wildner {
135*fd501800SSascha Wildner
136*fd501800SSascha Wildner return (mps_read_config_page(fd, MPI2_CONFIG_PAGETYPE_MANUFACTURING,
137*fd501800SSascha Wildner PageNumber, 0, IOCStatus));
138*fd501800SSascha Wildner }
139*fd501800SSascha Wildner
140*fd501800SSascha Wildner static __inline void *
mps_read_ioc_page(int fd,U8 PageNumber,U16 * IOCStatus)141*fd501800SSascha Wildner mps_read_ioc_page(int fd, U8 PageNumber, U16 *IOCStatus)
142*fd501800SSascha Wildner {
143*fd501800SSascha Wildner
144*fd501800SSascha Wildner return (mps_read_config_page(fd, MPI2_CONFIG_PAGETYPE_IOC, PageNumber,
145*fd501800SSascha Wildner 0, IOCStatus));
146*fd501800SSascha Wildner }
147*fd501800SSascha Wildner
148*fd501800SSascha Wildner static __inline uint64_t
mps_to_u64(U64 * data)149*fd501800SSascha Wildner mps_to_u64(U64 *data)
150*fd501800SSascha Wildner {
151*fd501800SSascha Wildner
152*fd501800SSascha Wildner return (((uint64_t)(data->High) << 32 ) | data->Low);
153*fd501800SSascha Wildner }
154*fd501800SSascha Wildner
155*fd501800SSascha Wildner MPI2_IOC_FACTS_REPLY * mps_get_iocfacts(int fd);
156*fd501800SSascha Wildner
157*fd501800SSascha Wildner #endif /* !__MPSUTIL_H__ */
158