drivers/gpu/drm/amd/amdgpu/amdgpu_ras_eeprom.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  */
  23
  24 #ifndef _AMDGPU_RAS_EEPROM_H
  25 #define _AMDGPU_RAS_EEPROM_H
  26
  27 #include <linux/i2c.h>
  28
  29 struct amdgpu_device;
  30
  31 enum amdgpu_ras_eeprom_err_type {
  32         AMDGPU_RAS_EEPROM_ERR_PLACE_HOLDER,
  33         AMDGPU_RAS_EEPROM_ERR_RECOVERABLE,
  34         AMDGPU_RAS_EEPROM_ERR_NON_RECOVERABLE
  35 };
  36
  37 struct amdgpu_ras_eeprom_table_header {
  38         uint32_t header;
  39         uint32_t version;
  40         uint32_t first_rec_offset;
  41         uint32_t tbl_size;
  42         uint32_t checksum;
  43 } __packed;
  44
  45 struct amdgpu_ras_eeprom_control {
  46         struct amdgpu_ras_eeprom_table_header tbl_hdr;
  47
  48         /* Base I2C EEPPROM 19-bit memory address,
  49          * where the table is located. For more information,
  50          * see top of amdgpu_eeprom.c.
  51          */
  52         u32 i2c_address;
  53
  54         /* The byte offset off of @i2c_address
  55          * where the table header is found,
  56          * and where the records start--always
  57          * right after the header.
  58          */
  59         u32 ras_header_offset;
  60         u32 ras_record_offset;
  61
  62         /* Number of records in the table.
  63          */
  64         u32 ras_num_recs;
  65
  66         /* First record index to read, 0-based.
  67          * Range is [0, num_recs-1]. This is
  68          * an absolute index, starting right after
  69          * the table header.
  70          */
  71         u32 ras_fri;
  72
  73         /* Maximum possible number of records
  74          * we could store, i.e. the maximum capacity
  75          * of the table.
  76          */
  77         u32 ras_max_record_count;
  78
  79         /* Protect table access via this mutex.
  80          */
  81         struct mutex ras_tbl_mutex;
  82 };
  83
  84 /*
  85  * Represents single table record. Packed to be easily serialized into byte
  86  * stream.
  87  */
  88 struct eeprom_table_record {
  89
  90         union {
  91                 uint64_t address;
  92                 uint64_t offset;
  93         };
  94
  95         uint64_t retired_page;
  96         uint64_t ts;
  97
  98         enum amdgpu_ras_eeprom_err_type err_type;
  99
 100         union {
 101                 unsigned char bank;
 102                 unsigned char cu;
 103         };
 104
 105         unsigned char mem_channel;
 106         unsigned char mcumc_id;
 107 } __packed;
 108
 109 int amdgpu_ras_eeprom_init(struct amdgpu_ras_eeprom_control *control,
 110                            bool *exceed_err_limit);
 111
 112 int amdgpu_ras_eeprom_reset_table(struct amdgpu_ras_eeprom_control *control);
 113
 114 bool amdgpu_ras_eeprom_check_err_threshold(struct amdgpu_device *adev);
 115
 116 int amdgpu_ras_eeprom_read(struct amdgpu_ras_eeprom_control *control,
 117                            struct eeprom_table_record *records, const u32 num);
 118
 119 int amdgpu_ras_eeprom_append(struct amdgpu_ras_eeprom_control *control,
 120                              struct eeprom_table_record *records, const u32 num);
 121
 122 inline uint32_t amdgpu_ras_eeprom_max_record_count(void);
 123
 124 #endif // _AMDGPU_RAS_EEPROM_H