1*dd11376bSBart Van Assche // SPDX-License-Identifier: GPL-2.0
2*dd11376bSBart Van Assche // Copyright (C) 2020 Intel Corporation
3*dd11376bSBart Van Assche
4*dd11376bSBart Van Assche #include <linux/debugfs.h>
5*dd11376bSBart Van Assche
6*dd11376bSBart Van Assche #include "ufs-debugfs.h"
7*dd11376bSBart Van Assche #include <ufs/ufshcd.h>
8*dd11376bSBart Van Assche #include "ufshcd-priv.h"
9*dd11376bSBart Van Assche
10*dd11376bSBart Van Assche static struct dentry *ufs_debugfs_root;
11*dd11376bSBart Van Assche
12*dd11376bSBart Van Assche struct ufs_debugfs_attr {
13*dd11376bSBart Van Assche const char *name;
14*dd11376bSBart Van Assche mode_t mode;
15*dd11376bSBart Van Assche const struct file_operations *fops;
16*dd11376bSBart Van Assche };
17*dd11376bSBart Van Assche
18*dd11376bSBart Van Assche /* @file corresponds to a debugfs attribute in directory hba->debugfs_root. */
hba_from_file(const struct file * file)19*dd11376bSBart Van Assche static inline struct ufs_hba *hba_from_file(const struct file *file)
20*dd11376bSBart Van Assche {
21*dd11376bSBart Van Assche return d_inode(file->f_path.dentry->d_parent)->i_private;
22*dd11376bSBart Van Assche }
23*dd11376bSBart Van Assche
ufs_debugfs_init(void)24*dd11376bSBart Van Assche void __init ufs_debugfs_init(void)
25*dd11376bSBart Van Assche {
26*dd11376bSBart Van Assche ufs_debugfs_root = debugfs_create_dir("ufshcd", NULL);
27*dd11376bSBart Van Assche }
28*dd11376bSBart Van Assche
ufs_debugfs_exit(void)29*dd11376bSBart Van Assche void ufs_debugfs_exit(void)
30*dd11376bSBart Van Assche {
31*dd11376bSBart Van Assche debugfs_remove_recursive(ufs_debugfs_root);
32*dd11376bSBart Van Assche }
33*dd11376bSBart Van Assche
ufs_debugfs_stats_show(struct seq_file * s,void * data)34*dd11376bSBart Van Assche static int ufs_debugfs_stats_show(struct seq_file *s, void *data)
35*dd11376bSBart Van Assche {
36*dd11376bSBart Van Assche struct ufs_hba *hba = hba_from_file(s->file);
37*dd11376bSBart Van Assche struct ufs_event_hist *e = hba->ufs_stats.event;
38*dd11376bSBart Van Assche
39*dd11376bSBart Van Assche #define PRT(fmt, typ) \
40*dd11376bSBart Van Assche seq_printf(s, fmt, e[UFS_EVT_ ## typ].cnt)
41*dd11376bSBart Van Assche
42*dd11376bSBart Van Assche PRT("PHY Adapter Layer errors (except LINERESET): %llu\n", PA_ERR);
43*dd11376bSBart Van Assche PRT("Data Link Layer errors: %llu\n", DL_ERR);
44*dd11376bSBart Van Assche PRT("Network Layer errors: %llu\n", NL_ERR);
45*dd11376bSBart Van Assche PRT("Transport Layer errors: %llu\n", TL_ERR);
46*dd11376bSBart Van Assche PRT("Generic DME errors: %llu\n", DME_ERR);
47*dd11376bSBart Van Assche PRT("Auto-hibernate errors: %llu\n", AUTO_HIBERN8_ERR);
48*dd11376bSBart Van Assche PRT("IS Fatal errors (CEFES, SBFES, HCFES, DFES): %llu\n", FATAL_ERR);
49*dd11376bSBart Van Assche PRT("DME Link Startup errors: %llu\n", LINK_STARTUP_FAIL);
50*dd11376bSBart Van Assche PRT("PM Resume errors: %llu\n", RESUME_ERR);
51*dd11376bSBart Van Assche PRT("PM Suspend errors : %llu\n", SUSPEND_ERR);
52*dd11376bSBart Van Assche PRT("Logical Unit Resets: %llu\n", DEV_RESET);
53*dd11376bSBart Van Assche PRT("Host Resets: %llu\n", HOST_RESET);
54*dd11376bSBart Van Assche PRT("SCSI command aborts: %llu\n", ABORT);
55*dd11376bSBart Van Assche #undef PRT
56*dd11376bSBart Van Assche return 0;
57*dd11376bSBart Van Assche }
58*dd11376bSBart Van Assche DEFINE_SHOW_ATTRIBUTE(ufs_debugfs_stats);
59*dd11376bSBart Van Assche
ee_usr_mask_get(void * data,u64 * val)60*dd11376bSBart Van Assche static int ee_usr_mask_get(void *data, u64 *val)
61*dd11376bSBart Van Assche {
62*dd11376bSBart Van Assche struct ufs_hba *hba = data;
63*dd11376bSBart Van Assche
64*dd11376bSBart Van Assche *val = hba->ee_usr_mask;
65*dd11376bSBart Van Assche return 0;
66*dd11376bSBart Van Assche }
67*dd11376bSBart Van Assche
ufs_debugfs_get_user_access(struct ufs_hba * hba)68*dd11376bSBart Van Assche static int ufs_debugfs_get_user_access(struct ufs_hba *hba)
69*dd11376bSBart Van Assche __acquires(&hba->host_sem)
70*dd11376bSBart Van Assche {
71*dd11376bSBart Van Assche down(&hba->host_sem);
72*dd11376bSBart Van Assche if (!ufshcd_is_user_access_allowed(hba)) {
73*dd11376bSBart Van Assche up(&hba->host_sem);
74*dd11376bSBart Van Assche return -EBUSY;
75*dd11376bSBart Van Assche }
76*dd11376bSBart Van Assche ufshcd_rpm_get_sync(hba);
77*dd11376bSBart Van Assche return 0;
78*dd11376bSBart Van Assche }
79*dd11376bSBart Van Assche
ufs_debugfs_put_user_access(struct ufs_hba * hba)80*dd11376bSBart Van Assche static void ufs_debugfs_put_user_access(struct ufs_hba *hba)
81*dd11376bSBart Van Assche __releases(&hba->host_sem)
82*dd11376bSBart Van Assche {
83*dd11376bSBart Van Assche ufshcd_rpm_put_sync(hba);
84*dd11376bSBart Van Assche up(&hba->host_sem);
85*dd11376bSBart Van Assche }
86*dd11376bSBart Van Assche
ee_usr_mask_set(void * data,u64 val)87*dd11376bSBart Van Assche static int ee_usr_mask_set(void *data, u64 val)
88*dd11376bSBart Van Assche {
89*dd11376bSBart Van Assche struct ufs_hba *hba = data;
90*dd11376bSBart Van Assche int err;
91*dd11376bSBart Van Assche
92*dd11376bSBart Van Assche if (val & ~(u64)MASK_EE_STATUS)
93*dd11376bSBart Van Assche return -EINVAL;
94*dd11376bSBart Van Assche err = ufs_debugfs_get_user_access(hba);
95*dd11376bSBart Van Assche if (err)
96*dd11376bSBart Van Assche return err;
97*dd11376bSBart Van Assche err = ufshcd_update_ee_usr_mask(hba, val, MASK_EE_STATUS);
98*dd11376bSBart Van Assche ufs_debugfs_put_user_access(hba);
99*dd11376bSBart Van Assche return err;
100*dd11376bSBart Van Assche }
101*dd11376bSBart Van Assche
102*dd11376bSBart Van Assche DEFINE_DEBUGFS_ATTRIBUTE(ee_usr_mask_fops, ee_usr_mask_get, ee_usr_mask_set, "%#llx\n");
103*dd11376bSBart Van Assche
ufs_debugfs_exception_event(struct ufs_hba * hba,u16 status)104*dd11376bSBart Van Assche void ufs_debugfs_exception_event(struct ufs_hba *hba, u16 status)
105*dd11376bSBart Van Assche {
106*dd11376bSBart Van Assche bool chgd = false;
107*dd11376bSBart Van Assche u16 ee_ctrl_mask;
108*dd11376bSBart Van Assche int err = 0;
109*dd11376bSBart Van Assche
110*dd11376bSBart Van Assche if (!hba->debugfs_ee_rate_limit_ms || !status)
111*dd11376bSBart Van Assche return;
112*dd11376bSBart Van Assche
113*dd11376bSBart Van Assche mutex_lock(&hba->ee_ctrl_mutex);
114*dd11376bSBart Van Assche ee_ctrl_mask = hba->ee_drv_mask | (hba->ee_usr_mask & ~status);
115*dd11376bSBart Van Assche chgd = ee_ctrl_mask != hba->ee_ctrl_mask;
116*dd11376bSBart Van Assche if (chgd) {
117*dd11376bSBart Van Assche err = __ufshcd_write_ee_control(hba, ee_ctrl_mask);
118*dd11376bSBart Van Assche if (err)
119*dd11376bSBart Van Assche dev_err(hba->dev, "%s: failed to write ee control %d\n",
120*dd11376bSBart Van Assche __func__, err);
121*dd11376bSBart Van Assche }
122*dd11376bSBart Van Assche mutex_unlock(&hba->ee_ctrl_mutex);
123*dd11376bSBart Van Assche
124*dd11376bSBart Van Assche if (chgd && !err) {
125*dd11376bSBart Van Assche unsigned long delay = msecs_to_jiffies(hba->debugfs_ee_rate_limit_ms);
126*dd11376bSBart Van Assche
127*dd11376bSBart Van Assche queue_delayed_work(system_freezable_wq, &hba->debugfs_ee_work, delay);
128*dd11376bSBart Van Assche }
129*dd11376bSBart Van Assche }
130*dd11376bSBart Van Assche
ufs_debugfs_restart_ee(struct work_struct * work)131*dd11376bSBart Van Assche static void ufs_debugfs_restart_ee(struct work_struct *work)
132*dd11376bSBart Van Assche {
133*dd11376bSBart Van Assche struct ufs_hba *hba = container_of(work, struct ufs_hba, debugfs_ee_work.work);
134*dd11376bSBart Van Assche
135*dd11376bSBart Van Assche if (!hba->ee_usr_mask || pm_runtime_suspended(hba->dev) ||
136*dd11376bSBart Van Assche ufs_debugfs_get_user_access(hba))
137*dd11376bSBart Van Assche return;
138*dd11376bSBart Van Assche ufshcd_write_ee_control(hba);
139*dd11376bSBart Van Assche ufs_debugfs_put_user_access(hba);
140*dd11376bSBart Van Assche }
141*dd11376bSBart Van Assche
ufs_saved_err_show(struct seq_file * s,void * data)142*dd11376bSBart Van Assche static int ufs_saved_err_show(struct seq_file *s, void *data)
143*dd11376bSBart Van Assche {
144*dd11376bSBart Van Assche struct ufs_debugfs_attr *attr = s->private;
145*dd11376bSBart Van Assche struct ufs_hba *hba = hba_from_file(s->file);
146*dd11376bSBart Van Assche const int *p;
147*dd11376bSBart Van Assche
148*dd11376bSBart Van Assche if (strcmp(attr->name, "saved_err") == 0) {
149*dd11376bSBart Van Assche p = &hba->saved_err;
150*dd11376bSBart Van Assche } else if (strcmp(attr->name, "saved_uic_err") == 0) {
151*dd11376bSBart Van Assche p = &hba->saved_uic_err;
152*dd11376bSBart Van Assche } else {
153*dd11376bSBart Van Assche return -ENOENT;
154*dd11376bSBart Van Assche }
155*dd11376bSBart Van Assche
156*dd11376bSBart Van Assche seq_printf(s, "%d\n", *p);
157*dd11376bSBart Van Assche return 0;
158*dd11376bSBart Van Assche }
159*dd11376bSBart Van Assche
ufs_saved_err_write(struct file * file,const char __user * buf,size_t count,loff_t * ppos)160*dd11376bSBart Van Assche static ssize_t ufs_saved_err_write(struct file *file, const char __user *buf,
161*dd11376bSBart Van Assche size_t count, loff_t *ppos)
162*dd11376bSBart Van Assche {
163*dd11376bSBart Van Assche struct ufs_debugfs_attr *attr = file->f_inode->i_private;
164*dd11376bSBart Van Assche struct ufs_hba *hba = hba_from_file(file);
165*dd11376bSBart Van Assche char val_str[16] = { };
166*dd11376bSBart Van Assche int val, ret;
167*dd11376bSBart Van Assche
168*dd11376bSBart Van Assche if (count > sizeof(val_str))
169*dd11376bSBart Van Assche return -EINVAL;
170*dd11376bSBart Van Assche if (copy_from_user(val_str, buf, count))
171*dd11376bSBart Van Assche return -EFAULT;
172*dd11376bSBart Van Assche ret = kstrtoint(val_str, 0, &val);
173*dd11376bSBart Van Assche if (ret < 0)
174*dd11376bSBart Van Assche return ret;
175*dd11376bSBart Van Assche
176*dd11376bSBart Van Assche spin_lock_irq(hba->host->host_lock);
177*dd11376bSBart Van Assche if (strcmp(attr->name, "saved_err") == 0) {
178*dd11376bSBart Van Assche hba->saved_err = val;
179*dd11376bSBart Van Assche } else if (strcmp(attr->name, "saved_uic_err") == 0) {
180*dd11376bSBart Van Assche hba->saved_uic_err = val;
181*dd11376bSBart Van Assche } else {
182*dd11376bSBart Van Assche ret = -ENOENT;
183*dd11376bSBart Van Assche }
184*dd11376bSBart Van Assche if (ret == 0)
185*dd11376bSBart Van Assche ufshcd_schedule_eh_work(hba);
186*dd11376bSBart Van Assche spin_unlock_irq(hba->host->host_lock);
187*dd11376bSBart Van Assche
188*dd11376bSBart Van Assche return ret < 0 ? ret : count;
189*dd11376bSBart Van Assche }
190*dd11376bSBart Van Assche
ufs_saved_err_open(struct inode * inode,struct file * file)191*dd11376bSBart Van Assche static int ufs_saved_err_open(struct inode *inode, struct file *file)
192*dd11376bSBart Van Assche {
193*dd11376bSBart Van Assche return single_open(file, ufs_saved_err_show, inode->i_private);
194*dd11376bSBart Van Assche }
195*dd11376bSBart Van Assche
196*dd11376bSBart Van Assche static const struct file_operations ufs_saved_err_fops = {
197*dd11376bSBart Van Assche .owner = THIS_MODULE,
198*dd11376bSBart Van Assche .open = ufs_saved_err_open,
199*dd11376bSBart Van Assche .read = seq_read,
200*dd11376bSBart Van Assche .write = ufs_saved_err_write,
201*dd11376bSBart Van Assche .llseek = seq_lseek,
202*dd11376bSBart Van Assche .release = single_release,
203*dd11376bSBart Van Assche };
204*dd11376bSBart Van Assche
205*dd11376bSBart Van Assche static const struct ufs_debugfs_attr ufs_attrs[] = {
206*dd11376bSBart Van Assche { "stats", 0400, &ufs_debugfs_stats_fops },
207*dd11376bSBart Van Assche { "saved_err", 0600, &ufs_saved_err_fops },
208*dd11376bSBart Van Assche { "saved_uic_err", 0600, &ufs_saved_err_fops },
209*dd11376bSBart Van Assche { }
210*dd11376bSBart Van Assche };
211*dd11376bSBart Van Assche
ufs_debugfs_hba_init(struct ufs_hba * hba)212*dd11376bSBart Van Assche void ufs_debugfs_hba_init(struct ufs_hba *hba)
213*dd11376bSBart Van Assche {
214*dd11376bSBart Van Assche const struct ufs_debugfs_attr *attr;
215*dd11376bSBart Van Assche struct dentry *root;
216*dd11376bSBart Van Assche
217*dd11376bSBart Van Assche /* Set default exception event rate limit period to 20ms */
218*dd11376bSBart Van Assche hba->debugfs_ee_rate_limit_ms = 20;
219*dd11376bSBart Van Assche INIT_DELAYED_WORK(&hba->debugfs_ee_work, ufs_debugfs_restart_ee);
220*dd11376bSBart Van Assche
221*dd11376bSBart Van Assche root = debugfs_create_dir(dev_name(hba->dev), ufs_debugfs_root);
222*dd11376bSBart Van Assche if (IS_ERR_OR_NULL(root))
223*dd11376bSBart Van Assche return;
224*dd11376bSBart Van Assche hba->debugfs_root = root;
225*dd11376bSBart Van Assche d_inode(root)->i_private = hba;
226*dd11376bSBart Van Assche for (attr = ufs_attrs; attr->name; attr++)
227*dd11376bSBart Van Assche debugfs_create_file(attr->name, attr->mode, root, (void *)attr,
228*dd11376bSBart Van Assche attr->fops);
229*dd11376bSBart Van Assche debugfs_create_file("exception_event_mask", 0600, hba->debugfs_root,
230*dd11376bSBart Van Assche hba, &ee_usr_mask_fops);
231*dd11376bSBart Van Assche debugfs_create_u32("exception_event_rate_limit_ms", 0600, hba->debugfs_root,
232*dd11376bSBart Van Assche &hba->debugfs_ee_rate_limit_ms);
233*dd11376bSBart Van Assche }
234*dd11376bSBart Van Assche
ufs_debugfs_hba_exit(struct ufs_hba * hba)235*dd11376bSBart Van Assche void ufs_debugfs_hba_exit(struct ufs_hba *hba)
236*dd11376bSBart Van Assche {
237*dd11376bSBart Van Assche debugfs_remove_recursive(hba->debugfs_root);
238*dd11376bSBart Van Assche cancel_delayed_work_sync(&hba->debugfs_ee_work);
239*dd11376bSBart Van Assche }
240