usr.sbin/bluetooth/iwmbtfw/iwmbt_fw.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2013 Adrian Chadd <adrian@freebsd.org>
   5  * Copyright (c) 2019 Vladimir Kondratyev <wulf@FreeBSD.org>
   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  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #ifndef __IWMBT_FW_H__
  30 #define __IWMBT_FW_H__
  31
  32 struct iwmbt_version {
  33         uint8_t status;
  34         uint8_t hw_platform;
  35         uint8_t hw_variant;
  36         uint8_t hw_revision;
  37         uint8_t fw_variant;
  38         uint8_t fw_revision;
  39         uint8_t fw_build_num;
  40         uint8_t fw_build_ww;
  41         uint8_t fw_build_yy;
  42         uint8_t fw_patch_num;
  43 } __attribute__ ((packed));
  44
  45 struct iwmbt_boot_params {
  46         uint8_t status;
  47         uint8_t otp_format;
  48         uint8_t otp_content;
  49         uint8_t otp_patch;
  50         uint16_t dev_revid;
  51         uint8_t secure_boot;
  52         uint8_t key_from_hdr;
  53         uint8_t key_type;
  54         uint8_t otp_lock;
  55         uint8_t api_lock;
  56         uint8_t debug_lock;
  57         uint8_t otp_bdaddr[6];
  58         uint8_t min_fw_build_nn;
  59         uint8_t min_fw_build_cw;
  60         uint8_t min_fw_build_yy;
  61         uint8_t limited_cce;
  62         uint8_t unlocked_state;
  63 } __attribute__ ((packed));
  64
  65 struct iwmbt_firmware {
  66         char *fwname;
  67         int len;
  68         unsigned char *buf;
  69 };
  70
  71 extern  int iwmbt_fw_read(struct iwmbt_firmware *fw, const char *fwname);
  72 extern  void iwmbt_fw_free(struct iwmbt_firmware *fw);
  73 extern  char *iwmbt_get_fwname(struct iwmbt_version *ver,
  74         struct iwmbt_boot_params *params, const char *prefix,
  75         const char *suffix);
  76
  77 #endif