1 /*
2  * Copyright 2021 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_RESET_H__
25 #define __AMDGPU_RESET_H__
26 
27 #include "amdgpu.h"
28 
29 enum AMDGPU_RESET_FLAGS {
30 
31 	AMDGPU_NEED_FULL_RESET = 0,
32 	AMDGPU_SKIP_HW_RESET = 1,
33 	AMDGPU_SKIP_MODE2_RESET = 2,
34 	AMDGPU_RESET_FOR_DEVICE_REMOVE = 3,
35 };
36 
37 struct amdgpu_reset_context {
38 	enum amd_reset_method method;
39 	struct amdgpu_device *reset_req_dev;
40 	struct amdgpu_job *job;
41 	struct amdgpu_hive_info *hive;
42 	struct list_head *reset_device_list;
43 	unsigned long flags;
44 };
45 
46 struct amdgpu_reset_handler {
47 	enum amd_reset_method reset_method;
48 	struct list_head handler_list;
49 	int (*prepare_env)(struct amdgpu_reset_control *reset_ctl,
50 			   struct amdgpu_reset_context *context);
51 	int (*prepare_hwcontext)(struct amdgpu_reset_control *reset_ctl,
52 				 struct amdgpu_reset_context *context);
53 	int (*perform_reset)(struct amdgpu_reset_control *reset_ctl,
54 			     struct amdgpu_reset_context *context);
55 	int (*restore_hwcontext)(struct amdgpu_reset_control *reset_ctl,
56 				 struct amdgpu_reset_context *context);
57 	int (*restore_env)(struct amdgpu_reset_control *reset_ctl,
58 			   struct amdgpu_reset_context *context);
59 
60 	int (*do_reset)(struct amdgpu_device *adev);
61 };
62 
63 struct amdgpu_reset_control {
64 	void *handle;
65 	struct work_struct reset_work;
66 	struct mutex reset_lock;
67 	struct list_head reset_handlers;
68 	atomic_t in_reset;
69 	enum amd_reset_method active_reset;
70 	struct amdgpu_reset_handler *(*get_reset_handler)(
71 		struct amdgpu_reset_control *reset_ctl,
72 		struct amdgpu_reset_context *context);
73 	void (*async_reset)(struct work_struct *work);
74 };
75 
76 
77 enum amdgpu_reset_domain_type {
78 	SINGLE_DEVICE,
79 	XGMI_HIVE
80 };
81 
82 struct amdgpu_reset_domain {
83 	struct kref refcount;
84 	struct workqueue_struct *wq;
85 	enum amdgpu_reset_domain_type type;
86 	struct rw_semaphore sem;
87 	atomic_t in_gpu_reset;
88 	atomic_t reset_res;
89 };
90 
91 
92 int amdgpu_reset_init(struct amdgpu_device *adev);
93 int amdgpu_reset_fini(struct amdgpu_device *adev);
94 
95 int amdgpu_reset_prepare_hwcontext(struct amdgpu_device *adev,
96 				   struct amdgpu_reset_context *reset_context);
97 
98 int amdgpu_reset_perform_reset(struct amdgpu_device *adev,
99 			       struct amdgpu_reset_context *reset_context);
100 
101 int amdgpu_reset_add_handler(struct amdgpu_reset_control *reset_ctl,
102 			     struct amdgpu_reset_handler *handler);
103 
104 struct amdgpu_reset_domain *amdgpu_reset_create_reset_domain(enum amdgpu_reset_domain_type type,
105 							     char *wq_name);
106 
107 void amdgpu_reset_destroy_reset_domain(struct kref *ref);
108 
109 static inline bool amdgpu_reset_get_reset_domain(struct amdgpu_reset_domain *domain)
110 {
111 	return kref_get_unless_zero(&domain->refcount) != 0;
112 }
113 
114 static inline void amdgpu_reset_put_reset_domain(struct amdgpu_reset_domain *domain)
115 {
116 	if (domain)
117 		kref_put(&domain->refcount, amdgpu_reset_destroy_reset_domain);
118 }
119 
120 static inline bool amdgpu_reset_domain_schedule(struct amdgpu_reset_domain *domain,
121 						struct work_struct *work)
122 {
123 	return queue_work(domain->wq, work);
124 }
125 
126 void amdgpu_device_lock_reset_domain(struct amdgpu_reset_domain *reset_domain);
127 
128 void amdgpu_device_unlock_reset_domain(struct amdgpu_reset_domain *reset_domain);
129 
130 #endif
131