xref: /freebsd/sys/dev/mlxfw/mlxfw_mfa2.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2017-2019 Mellanox Technologies.
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  * 3. Neither the name of Mellanox nor the names of contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef _MLXFW_MFA2_H
33 #define _MLXFW_MFA2_H
34 
35 #include "mlxfw.h"
36 
37 struct mlxfw_mfa2_component {
38 	u16 index;
39 	u32 data_size;
40 	u8 *data;
41 };
42 
43 struct mlxfw_mfa2_file;
44 
45 bool mlxfw_mfa2_check(const struct firmware *fw);
46 
47 struct mlxfw_mfa2_file *mlxfw_mfa2_file_init(const struct firmware *fw);
48 
49 int mlxfw_mfa2_file_component_count(const struct mlxfw_mfa2_file *mfa2_file,
50 				    const char *psid, u32 psid_size,
51 				    u32 *p_count);
52 
53 struct mlxfw_mfa2_component *
54 mlxfw_mfa2_file_component_get(const struct mlxfw_mfa2_file *mfa2_file,
55 			      const char *psid, int psid_size,
56 			      int component_index);
57 
58 void mlxfw_mfa2_file_component_put(struct mlxfw_mfa2_component *component);
59 
60 void mlxfw_mfa2_file_fini(struct mlxfw_mfa2_file *mfa2_file);
61 
62 #endif
63