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