xref: /freebsd/sys/dev/liquidio/base/lio_image.h (revision e1c4c8dd8d2d10b6104f06856a77bd5b4813a801)
1 /*
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2017 Cavium, Inc.. All rights reserved.
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  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Cavium, Inc. nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER(S) OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #ifndef _LIO_IMAGE_H_
35 #define _LIO_IMAGE_H_
36 
37 #define LIO_MAX_FW_FILENAME_LEN		256
38 #define LIO_FW_BASE_NAME		"lio_"
39 #define LIO_FW_NAME_SUFFIX		".bin"
40 #define LIO_FW_NAME_TYPE_NIC		"nic"
41 #define LIO_FW_NAME_TYPE_NONE		"none"
42 #define LIO_MAX_FIRMWARE_VERSION_LEN	16
43 
44 #define LIO_MAX_BOOTCMD_LEN		1024
45 #define LIO_MAX_IMAGES			16
46 #define LIO_NIC_MAGIC			0x434E4943	/* "CNIC" */
47 struct lio_firmware_desc {
48 	__be64	addr;
49 	__be32	len;
50 	__be32	crc32;	/* crc32 of image */
51 };
52 
53 /*
54  * Following the header is a list of 64-bit aligned binary images,
55  * as described by the desc field.
56  * Numeric fields are in network byte order.
57  */
58 struct lio_firmware_file_header {
59 	__be32				magic;
60 	char				version[LIO_MAX_FIRMWARE_VERSION_LEN];
61 	char				bootcmd[LIO_MAX_BOOTCMD_LEN];
62 	__be32				num_images;
63 	struct lio_firmware_desc	desc[LIO_MAX_IMAGES];
64 	__be32				pad;
65 	__be32				crc32;	/* header checksum */
66 };
67 
68 #endif	/* _LIO_IMAGE_H_ */
69