apei-internal.h 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * apei-internal.h - ACPI Platform Error Interface internal
  4. * definitions.
  5. */
  6. #ifndef APEI_INTERNAL_H
  7. #define APEI_INTERNAL_H
  8. #include <linux/cper.h>
  9. #include <linux/acpi.h>
  10. struct apei_exec_context;
  11. typedef int (*apei_exec_ins_func_t)(struct apei_exec_context *ctx,
  12. struct acpi_whea_header *entry);
  13. #define APEI_EXEC_INS_ACCESS_REGISTER 0x0001
  14. struct apei_exec_ins_type {
  15. u32 flags;
  16. apei_exec_ins_func_t run;
  17. };
  18. struct apei_exec_context {
  19. u32 ip;
  20. u64 value;
  21. u64 var1;
  22. u64 var2;
  23. u64 src_base;
  24. u64 dst_base;
  25. struct apei_exec_ins_type *ins_table;
  26. u32 instructions;
  27. struct acpi_whea_header *action_table;
  28. u32 entries;
  29. };
  30. void apei_exec_ctx_init(struct apei_exec_context *ctx,
  31. struct apei_exec_ins_type *ins_table,
  32. u32 instructions,
  33. struct acpi_whea_header *action_table,
  34. u32 entries);
  35. static inline void apei_exec_ctx_set_input(struct apei_exec_context *ctx,
  36. u64 input)
  37. {
  38. ctx->value = input;
  39. }
  40. static inline u64 apei_exec_ctx_get_output(struct apei_exec_context *ctx)
  41. {
  42. return ctx->value;
  43. }
  44. int __apei_exec_run(struct apei_exec_context *ctx, u8 action, bool optional);
  45. static inline int apei_exec_run(struct apei_exec_context *ctx, u8 action)
  46. {
  47. return __apei_exec_run(ctx, action, 0);
  48. }
  49. /* It is optional whether the firmware provides the action */
  50. static inline int apei_exec_run_optional(struct apei_exec_context *ctx, u8 action)
  51. {
  52. return __apei_exec_run(ctx, action, 1);
  53. }
  54. /* Common instruction implementation */
  55. /* IP has been set in instruction function */
  56. #define APEI_EXEC_SET_IP 1
  57. int apei_map_generic_address(struct acpi_generic_address *reg);
  58. static inline void apei_unmap_generic_address(struct acpi_generic_address *reg)
  59. {
  60. acpi_os_unmap_generic_address(reg);
  61. }
  62. int apei_read(u64 *val, struct acpi_generic_address *reg);
  63. int apei_write(u64 val, struct acpi_generic_address *reg);
  64. int __apei_exec_read_register(struct acpi_whea_header *entry, u64 *val);
  65. int __apei_exec_write_register(struct acpi_whea_header *entry, u64 val);
  66. int apei_exec_read_register(struct apei_exec_context *ctx,
  67. struct acpi_whea_header *entry);
  68. int apei_exec_read_register_value(struct apei_exec_context *ctx,
  69. struct acpi_whea_header *entry);
  70. int apei_exec_write_register(struct apei_exec_context *ctx,
  71. struct acpi_whea_header *entry);
  72. int apei_exec_write_register_value(struct apei_exec_context *ctx,
  73. struct acpi_whea_header *entry);
  74. int apei_exec_noop(struct apei_exec_context *ctx,
  75. struct acpi_whea_header *entry);
  76. int apei_exec_pre_map_gars(struct apei_exec_context *ctx);
  77. int apei_exec_post_unmap_gars(struct apei_exec_context *ctx);
  78. struct apei_resources {
  79. struct list_head iomem;
  80. struct list_head ioport;
  81. };
  82. static inline void apei_resources_init(struct apei_resources *resources)
  83. {
  84. INIT_LIST_HEAD(&resources->iomem);
  85. INIT_LIST_HEAD(&resources->ioport);
  86. }
  87. void apei_resources_fini(struct apei_resources *resources);
  88. int apei_resources_add(struct apei_resources *resources,
  89. unsigned long start, unsigned long size,
  90. bool iomem);
  91. int apei_resources_sub(struct apei_resources *resources1,
  92. struct apei_resources *resources2);
  93. int apei_resources_request(struct apei_resources *resources,
  94. const char *desc);
  95. void apei_resources_release(struct apei_resources *resources);
  96. int apei_exec_collect_resources(struct apei_exec_context *ctx,
  97. struct apei_resources *resources);
  98. struct dentry;
  99. struct dentry *apei_get_debugfs_dir(void);
  100. static inline u32 cper_estatus_len(struct acpi_hest_generic_status *estatus)
  101. {
  102. if (estatus->raw_data_length)
  103. return estatus->raw_data_offset + \
  104. estatus->raw_data_length;
  105. else
  106. return sizeof(*estatus) + estatus->data_length;
  107. }
  108. void cper_estatus_print(const char *pfx,
  109. const struct acpi_hest_generic_status *estatus);
  110. int cper_estatus_check_header(const struct acpi_hest_generic_status *estatus);
  111. int cper_estatus_check(const struct acpi_hest_generic_status *estatus);
  112. int apei_osc_setup(void);
  113. #endif