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/*$FreeBSD: stable/11/sys/dev/liquidio/base/lio_image.h 325618 2017-11-09 19:52:56Z sbruno $*/
34
35#ifndef _LIO_IMAGE_H_
36#define _LIO_IMAGE_H_
37
38#define LIO_MAX_FW_FILENAME_LEN		256
39#define LIO_FW_BASE_NAME		"lio_"
40#define LIO_FW_NAME_SUFFIX		".bin"
41#define LIO_FW_NAME_TYPE_NIC		"nic"
42#define LIO_FW_NAME_TYPE_NONE		"none"
43#define LIO_MAX_FIRMWARE_VERSION_LEN	16
44
45#define LIO_MAX_BOOTCMD_LEN		1024
46#define LIO_MAX_IMAGES			16
47#define LIO_NIC_MAGIC			0x434E4943	/* "CNIC" */
48struct lio_firmware_desc {
49	__be64	addr;
50	__be32	len;
51	__be32	crc32;	/* crc32 of image */
52};
53
54/*
55 * Following the header is a list of 64-bit aligned binary images,
56 * as described by the desc field.
57 * Numeric fields are in network byte order.
58 */
59struct lio_firmware_file_header {
60	__be32				magic;
61	char				version[LIO_MAX_FIRMWARE_VERSION_LEN];
62	char				bootcmd[LIO_MAX_BOOTCMD_LEN];
63	__be32				num_images;
64	struct lio_firmware_desc	desc[LIO_MAX_IMAGES];
65	__be32				pad;
66	__be32				crc32;	/* header checksum */
67};
68
69#endif	/* _LIO_IMAGE_H_ */
70