drivers/gpu/drm/amd/display/dmub/inc/dmub_fw_meta.h

   1 /*
   2  * Copyright 2019 Advanced Micro Devices, Inc.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20  * OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * Authors: AMD
  23  *
  24  */
  25 #ifndef _DMUB_META_H_
  26 #define _DMUB_META_H_
  27
  28 #include "dmub_types.h"
  29
  30 #pragma pack(push, 1)
  31
  32 /* Magic value for identifying dmub_fw_meta_info */
  33 #define DMUB_FW_META_MAGIC 0x444D5542
  34
  35 /* Offset from the end of the file to the dmub_fw_meta_info */
  36 #define DMUB_FW_META_OFFSET 0x24
  37
  38 /**
  39  * struct dmub_fw_meta_info - metadata associated with fw binary
  40  *
  41  * NOTE: This should be considered a stable API. Fields should
  42  *       not be repurposed or reordered. New fields should be
  43  *       added instead to extend the structure.
  44  *
  45  * @magic_value: magic value identifying DMUB firmware meta info
  46  * @fw_region_size: size of the firmware state region
  47  * @trace_buffer_size: size of the tracebuffer region
  48  */
  49 struct dmub_fw_meta_info {
  50         uint32_t magic_value;
  51         uint32_t fw_region_size;
  52         uint32_t trace_buffer_size;
  53 };
  54
  55 /* Ensure that the structure remains 64 bytes. */
  56 union dmub_fw_meta {
  57         struct dmub_fw_meta_info info;
  58         uint8_t reserved[64];
  59 };
  60
  61 #pragma pack(pop)
  62
  63 #endif /* _DMUB_META_H_ */