1 /*
2  * drivers/net/ethernet/mellanox/mlxfw/mlxfw_mfa2.h
3  * Copyright (c) 2017 Mellanox Technologies. All rights reserved.
4  * Copyright (c) 2017 Yotam Gigi <yotamg@mellanox.com>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. Neither the names of the copyright holders nor the names of its
15  *    contributors may be used to endorse or promote products derived from
16  *    this software without specific prior written permission.
17  *
18  * Alternatively, this software may be distributed under the terms of the
19  * GNU General Public License ("GPL") version 2 as published by the Free
20  * Software Foundation.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
26  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef _MLXFW_MFA2_H
36 #define _MLXFW_MFA2_H
37 
38 #include <linux/firmware.h>
39 #include "mlxfw.h"
40 
41 struct mlxfw_mfa2_component {
42 	u16 index;
43 	u32 data_size;
44 	u8 *data;
45 };
46 
47 struct mlxfw_mfa2_file;
48 
49 bool mlxfw_mfa2_check(const struct firmware *fw);
50 
51 struct mlxfw_mfa2_file *mlxfw_mfa2_file_init(const struct firmware *fw);
52 
53 int mlxfw_mfa2_file_component_count(const struct mlxfw_mfa2_file *mfa2_file,
54 				    const char *psid, u32 psid_size,
55 				    u32 *p_count);
56 
57 struct mlxfw_mfa2_component *
58 mlxfw_mfa2_file_component_get(const struct mlxfw_mfa2_file *mfa2_file,
59 			      const char *psid, int psid_size,
60 			      int component_index);
61 
62 void mlxfw_mfa2_file_component_put(struct mlxfw_mfa2_component *component);
63 
64 void mlxfw_mfa2_file_fini(struct mlxfw_mfa2_file *mfa2_file);
65 
66 #endif
67