[S390] cio: Cleanup crw interface.
[safe/jmp/linux-2.6] / drivers / s390 / cio / chp.c
1 /*
2  *  drivers/s390/cio/chp.c
3  *
4  *    Copyright IBM Corp. 1999,2007
5  *    Author(s): Cornelia Huck (cornelia.huck@de.ibm.com)
6  *               Arnd Bergmann (arndb@de.ibm.com)
7  *               Peter Oberparleiter <peter.oberparleiter@de.ibm.com>
8  */
9
10 #include <linux/bug.h>
11 #include <linux/workqueue.h>
12 #include <linux/spinlock.h>
13 #include <linux/init.h>
14 #include <linux/jiffies.h>
15 #include <linux/wait.h>
16 #include <linux/mutex.h>
17 #include <linux/errno.h>
18 #include <asm/chpid.h>
19 #include <asm/sclp.h>
20
21 #include "../s390mach.h"
22 #include "cio.h"
23 #include "css.h"
24 #include "ioasm.h"
25 #include "cio_debug.h"
26 #include "chp.h"
27
28 #define to_channelpath(device) container_of(device, struct channel_path, dev)
29 #define CHP_INFO_UPDATE_INTERVAL        1*HZ
30
31 enum cfg_task_t {
32         cfg_none,
33         cfg_configure,
34         cfg_deconfigure
35 };
36
37 /* Map for pending configure tasks. */
38 static enum cfg_task_t chp_cfg_task[__MAX_CSSID + 1][__MAX_CHPID + 1];
39 static DEFINE_MUTEX(cfg_lock);
40 static int cfg_busy;
41
42 /* Map for channel-path status. */
43 static struct sclp_chp_info chp_info;
44 static DEFINE_MUTEX(info_lock);
45
46 /* Time after which channel-path status may be outdated. */
47 static unsigned long chp_info_expires;
48
49 /* Workqueue to perform pending configure tasks. */
50 static struct workqueue_struct *chp_wq;
51 static struct work_struct cfg_work;
52
53 /* Wait queue for configure completion events. */
54 static wait_queue_head_t cfg_wait_queue;
55
56 /* Return channel_path struct for given chpid. */
57 static inline struct channel_path *chpid_to_chp(struct chp_id chpid)
58 {
59         return channel_subsystems[chpid.cssid]->chps[chpid.id];
60 }
61
62 /* Set vary state for given chpid. */
63 static void set_chp_logically_online(struct chp_id chpid, int onoff)
64 {
65         chpid_to_chp(chpid)->state = onoff;
66 }
67
68 /* On succes return 0 if channel-path is varied offline, 1 if it is varied
69  * online. Return -ENODEV if channel-path is not registered. */
70 int chp_get_status(struct chp_id chpid)
71 {
72         return (chpid_to_chp(chpid) ? chpid_to_chp(chpid)->state : -ENODEV);
73 }
74
75 /**
76  * chp_get_sch_opm - return opm for subchannel
77  * @sch: subchannel
78  *
79  * Calculate and return the operational path mask (opm) based on the chpids
80  * used by the subchannel and the status of the associated channel-paths.
81  */
82 u8 chp_get_sch_opm(struct subchannel *sch)
83 {
84         struct chp_id chpid;
85         int opm;
86         int i;
87
88         opm = 0;
89         chp_id_init(&chpid);
90         for (i = 0; i < 8; i++) {
91                 opm <<= 1;
92                 chpid.id = sch->schib.pmcw.chpid[i];
93                 if (chp_get_status(chpid) != 0)
94                         opm |= 1;
95         }
96         return opm;
97 }
98
99 /**
100  * chp_is_registered - check if a channel-path is registered
101  * @chpid: channel-path ID
102  *
103  * Return non-zero if a channel-path with the given chpid is registered,
104  * zero otherwise.
105  */
106 int chp_is_registered(struct chp_id chpid)
107 {
108         return chpid_to_chp(chpid) != NULL;
109 }
110
111 /*
112  * Function: s390_vary_chpid
113  * Varies the specified chpid online or offline
114  */
115 static int s390_vary_chpid(struct chp_id chpid, int on)
116 {
117         char dbf_text[15];
118         int status;
119
120         sprintf(dbf_text, on?"varyon%x.%02x":"varyoff%x.%02x", chpid.cssid,
121                 chpid.id);
122         CIO_TRACE_EVENT(2, dbf_text);
123
124         status = chp_get_status(chpid);
125         if (!on && !status) {
126                 printk(KERN_ERR "cio: chpid %x.%02x is already offline\n",
127                        chpid.cssid, chpid.id);
128                 return -EINVAL;
129         }
130
131         set_chp_logically_online(chpid, on);
132         chsc_chp_vary(chpid, on);
133         return 0;
134 }
135
136 /*
137  * Channel measurement related functions
138  */
139 static ssize_t chp_measurement_chars_read(struct kobject *kobj,
140                                           struct bin_attribute *bin_attr,
141                                           char *buf, loff_t off, size_t count)
142 {
143         struct channel_path *chp;
144         struct device *device;
145         unsigned int size;
146
147         device = container_of(kobj, struct device, kobj);
148         chp = to_channelpath(device);
149         if (!chp->cmg_chars)
150                 return 0;
151
152         size = sizeof(struct cmg_chars);
153
154         if (off > size)
155                 return 0;
156         if (off + count > size)
157                 count = size - off;
158         memcpy(buf, chp->cmg_chars + off, count);
159         return count;
160 }
161
162 static struct bin_attribute chp_measurement_chars_attr = {
163         .attr = {
164                 .name = "measurement_chars",
165                 .mode = S_IRUSR,
166         },
167         .size = sizeof(struct cmg_chars),
168         .read = chp_measurement_chars_read,
169 };
170
171 static void chp_measurement_copy_block(struct cmg_entry *buf,
172                                        struct channel_subsystem *css,
173                                        struct chp_id chpid)
174 {
175         void *area;
176         struct cmg_entry *entry, reference_buf;
177         int idx;
178
179         if (chpid.id < 128) {
180                 area = css->cub_addr1;
181                 idx = chpid.id;
182         } else {
183                 area = css->cub_addr2;
184                 idx = chpid.id - 128;
185         }
186         entry = area + (idx * sizeof(struct cmg_entry));
187         do {
188                 memcpy(buf, entry, sizeof(*entry));
189                 memcpy(&reference_buf, entry, sizeof(*entry));
190         } while (reference_buf.values[0] != buf->values[0]);
191 }
192
193 static ssize_t chp_measurement_read(struct kobject *kobj,
194                                     struct bin_attribute *bin_attr,
195                                     char *buf, loff_t off, size_t count)
196 {
197         struct channel_path *chp;
198         struct channel_subsystem *css;
199         struct device *device;
200         unsigned int size;
201
202         device = container_of(kobj, struct device, kobj);
203         chp = to_channelpath(device);
204         css = to_css(chp->dev.parent);
205
206         size = sizeof(struct cmg_entry);
207
208         /* Only allow single reads. */
209         if (off || count < size)
210                 return 0;
211         chp_measurement_copy_block((struct cmg_entry *)buf, css, chp->chpid);
212         count = size;
213         return count;
214 }
215
216 static struct bin_attribute chp_measurement_attr = {
217         .attr = {
218                 .name = "measurement",
219                 .mode = S_IRUSR,
220         },
221         .size = sizeof(struct cmg_entry),
222         .read = chp_measurement_read,
223 };
224
225 void chp_remove_cmg_attr(struct channel_path *chp)
226 {
227         device_remove_bin_file(&chp->dev, &chp_measurement_chars_attr);
228         device_remove_bin_file(&chp->dev, &chp_measurement_attr);
229 }
230
231 int chp_add_cmg_attr(struct channel_path *chp)
232 {
233         int ret;
234
235         ret = device_create_bin_file(&chp->dev, &chp_measurement_chars_attr);
236         if (ret)
237                 return ret;
238         ret = device_create_bin_file(&chp->dev, &chp_measurement_attr);
239         if (ret)
240                 device_remove_bin_file(&chp->dev, &chp_measurement_chars_attr);
241         return ret;
242 }
243
244 /*
245  * Files for the channel path entries.
246  */
247 static ssize_t chp_status_show(struct device *dev,
248                                struct device_attribute *attr, char *buf)
249 {
250         struct channel_path *chp = to_channelpath(dev);
251
252         if (!chp)
253                 return 0;
254         return (chp_get_status(chp->chpid) ? sprintf(buf, "online\n") :
255                 sprintf(buf, "offline\n"));
256 }
257
258 static ssize_t chp_status_write(struct device *dev,
259                                 struct device_attribute *attr,
260                                 const char *buf, size_t count)
261 {
262         struct channel_path *cp = to_channelpath(dev);
263         char cmd[10];
264         int num_args;
265         int error;
266
267         num_args = sscanf(buf, "%5s", cmd);
268         if (!num_args)
269                 return count;
270
271         if (!strnicmp(cmd, "on", 2) || !strcmp(cmd, "1"))
272                 error = s390_vary_chpid(cp->chpid, 1);
273         else if (!strnicmp(cmd, "off", 3) || !strcmp(cmd, "0"))
274                 error = s390_vary_chpid(cp->chpid, 0);
275         else
276                 error = -EINVAL;
277
278         return error < 0 ? error : count;
279
280 }
281
282 static DEVICE_ATTR(status, 0644, chp_status_show, chp_status_write);
283
284 static ssize_t chp_configure_show(struct device *dev,
285                                   struct device_attribute *attr, char *buf)
286 {
287         struct channel_path *cp;
288         int status;
289
290         cp = to_channelpath(dev);
291         status = chp_info_get_status(cp->chpid);
292         if (status < 0)
293                 return status;
294
295         return snprintf(buf, PAGE_SIZE, "%d\n", status);
296 }
297
298 static int cfg_wait_idle(void);
299
300 static ssize_t chp_configure_write(struct device *dev,
301                                    struct device_attribute *attr,
302                                    const char *buf, size_t count)
303 {
304         struct channel_path *cp;
305         int val;
306         char delim;
307
308         if (sscanf(buf, "%d %c", &val, &delim) != 1)
309                 return -EINVAL;
310         if (val != 0 && val != 1)
311                 return -EINVAL;
312         cp = to_channelpath(dev);
313         chp_cfg_schedule(cp->chpid, val);
314         cfg_wait_idle();
315
316         return count;
317 }
318
319 static DEVICE_ATTR(configure, 0644, chp_configure_show, chp_configure_write);
320
321 static ssize_t chp_type_show(struct device *dev, struct device_attribute *attr,
322                              char *buf)
323 {
324         struct channel_path *chp = to_channelpath(dev);
325
326         if (!chp)
327                 return 0;
328         return sprintf(buf, "%x\n", chp->desc.desc);
329 }
330
331 static DEVICE_ATTR(type, 0444, chp_type_show, NULL);
332
333 static ssize_t chp_cmg_show(struct device *dev, struct device_attribute *attr,
334                             char *buf)
335 {
336         struct channel_path *chp = to_channelpath(dev);
337
338         if (!chp)
339                 return 0;
340         if (chp->cmg == -1) /* channel measurements not available */
341                 return sprintf(buf, "unknown\n");
342         return sprintf(buf, "%x\n", chp->cmg);
343 }
344
345 static DEVICE_ATTR(cmg, 0444, chp_cmg_show, NULL);
346
347 static ssize_t chp_shared_show(struct device *dev,
348                                struct device_attribute *attr, char *buf)
349 {
350         struct channel_path *chp = to_channelpath(dev);
351
352         if (!chp)
353                 return 0;
354         if (chp->shared == -1) /* channel measurements not available */
355                 return sprintf(buf, "unknown\n");
356         return sprintf(buf, "%x\n", chp->shared);
357 }
358
359 static DEVICE_ATTR(shared, 0444, chp_shared_show, NULL);
360
361 static struct attribute *chp_attrs[] = {
362         &dev_attr_status.attr,
363         &dev_attr_configure.attr,
364         &dev_attr_type.attr,
365         &dev_attr_cmg.attr,
366         &dev_attr_shared.attr,
367         NULL,
368 };
369
370 static struct attribute_group chp_attr_group = {
371         .attrs = chp_attrs,
372 };
373
374 static void chp_release(struct device *dev)
375 {
376         struct channel_path *cp;
377
378         cp = to_channelpath(dev);
379         kfree(cp);
380 }
381
382 /**
383  * chp_new - register a new channel-path
384  * @chpid - channel-path ID
385  *
386  * Create and register data structure representing new channel-path. Return
387  * zero on success, non-zero otherwise.
388  */
389 int chp_new(struct chp_id chpid)
390 {
391         struct channel_path *chp;
392         int ret;
393
394         if (chp_is_registered(chpid))
395                 return 0;
396         chp = kzalloc(sizeof(struct channel_path), GFP_KERNEL);
397         if (!chp)
398                 return -ENOMEM;
399
400         /* fill in status, etc. */
401         chp->chpid = chpid;
402         chp->state = 1;
403         chp->dev.parent = &channel_subsystems[chpid.cssid]->device;
404         chp->dev.release = chp_release;
405         snprintf(chp->dev.bus_id, BUS_ID_SIZE, "chp%x.%02x", chpid.cssid,
406                  chpid.id);
407
408         /* Obtain channel path description and fill it in. */
409         ret = chsc_determine_channel_path_description(chpid, &chp->desc);
410         if (ret)
411                 goto out_free;
412         if ((chp->desc.flags & 0x80) == 0) {
413                 ret = -ENODEV;
414                 goto out_free;
415         }
416         /* Get channel-measurement characteristics. */
417         if (css_characteristics_avail && css_chsc_characteristics.scmc
418             && css_chsc_characteristics.secm) {
419                 ret = chsc_get_channel_measurement_chars(chp);
420                 if (ret)
421                         goto out_free;
422         } else {
423                 chp->cmg = -1;
424         }
425
426         /* make it known to the system */
427         ret = device_register(&chp->dev);
428         if (ret) {
429                 CIO_MSG_EVENT(0, "Could not register chp%x.%02x: %d\n",
430                               chpid.cssid, chpid.id, ret);
431                 goto out_free;
432         }
433         ret = sysfs_create_group(&chp->dev.kobj, &chp_attr_group);
434         if (ret) {
435                 device_unregister(&chp->dev);
436                 goto out_free;
437         }
438         mutex_lock(&channel_subsystems[chpid.cssid]->mutex);
439         if (channel_subsystems[chpid.cssid]->cm_enabled) {
440                 ret = chp_add_cmg_attr(chp);
441                 if (ret) {
442                         sysfs_remove_group(&chp->dev.kobj, &chp_attr_group);
443                         device_unregister(&chp->dev);
444                         mutex_unlock(&channel_subsystems[chpid.cssid]->mutex);
445                         goto out_free;
446                 }
447         }
448         channel_subsystems[chpid.cssid]->chps[chpid.id] = chp;
449         mutex_unlock(&channel_subsystems[chpid.cssid]->mutex);
450         return ret;
451 out_free:
452         kfree(chp);
453         return ret;
454 }
455
456 /**
457  * chp_get_chp_desc - return newly allocated channel-path description
458  * @chpid: channel-path ID
459  *
460  * On success return a newly allocated copy of the channel-path description
461  * data associated with the given channel-path ID. Return %NULL on error.
462  */
463 void *chp_get_chp_desc(struct chp_id chpid)
464 {
465         struct channel_path *chp;
466         struct channel_path_desc *desc;
467
468         chp = chpid_to_chp(chpid);
469         if (!chp)
470                 return NULL;
471         desc = kmalloc(sizeof(struct channel_path_desc), GFP_KERNEL);
472         if (!desc)
473                 return NULL;
474         memcpy(desc, &chp->desc, sizeof(struct channel_path_desc));
475         return desc;
476 }
477
478 /**
479  * chp_process_crw - process channel-path status change
480  * @crw0: channel report-word to handler
481  * @crw1: second channel-report word (always NULL)
482  * @overflow: crw overflow indication
483  *
484  * Handle channel-report-words indicating that the status of a channel-path
485  * has changed.
486  */
487 static void chp_process_crw(struct crw *crw0, struct crw *crw1,
488                             int overflow)
489 {
490         struct chp_id chpid;
491
492         if (overflow) {
493                 css_schedule_eval_all();
494                 return;
495         }
496         CIO_CRW_EVENT(2, "CRW reports slct=%d, oflw=%d, "
497                       "chn=%d, rsc=%X, anc=%d, erc=%X, rsid=%X\n",
498                       crw0->slct, crw0->oflw, crw0->chn, crw0->rsc, crw0->anc,
499                       crw0->erc, crw0->rsid);
500         /*
501          * Check for solicited machine checks. These are
502          * created by reset channel path and need not be
503          * handled here.
504          */
505         if (crw0->slct) {
506                 CIO_CRW_EVENT(2, "solicited machine check for "
507                               "channel path %02X\n", crw0->rsid);
508                 return;
509         }
510         chp_id_init(&chpid);
511         chpid.id = crw0->rsid;
512         switch (crw0->erc) {
513         case CRW_ERC_IPARM: /* Path has come. */
514                 if (!chp_is_registered(chpid))
515                         chp_new(chpid);
516                 chsc_chp_online(chpid);
517                 break;
518         case CRW_ERC_PERRI: /* Path has gone. */
519         case CRW_ERC_PERRN:
520                 chsc_chp_offline(chpid);
521                 break;
522         default:
523                 CIO_CRW_EVENT(2, "Don't know how to handle erc=%x\n",
524                               crw0->erc);
525         }
526 }
527
528 int chp_ssd_get_mask(struct chsc_ssd_info *ssd, struct res_acc_data *data)
529 {
530         int i;
531         int mask;
532
533         for (i = 0; i < 8; i++) {
534                 mask = 0x80 >> i;
535                 if (!(ssd->path_mask & mask))
536                         continue;
537                 if (!chp_id_is_equal(&ssd->chpid[i], &data->chpid))
538                         continue;
539                 if ((ssd->fla_valid_mask & mask) &&
540                     ((ssd->fla[i] & data->fla_mask) != data->fla))
541                         continue;
542                 return mask;
543         }
544         return 0;
545 }
546 EXPORT_SYMBOL_GPL(chp_ssd_get_mask);
547
548 static inline int info_bit_num(struct chp_id id)
549 {
550         return id.id + id.cssid * (__MAX_CHPID + 1);
551 }
552
553 /* Force chp_info refresh on next call to info_validate(). */
554 static void info_expire(void)
555 {
556         mutex_lock(&info_lock);
557         chp_info_expires = jiffies - 1;
558         mutex_unlock(&info_lock);
559 }
560
561 /* Ensure that chp_info is up-to-date. */
562 static int info_update(void)
563 {
564         int rc;
565
566         mutex_lock(&info_lock);
567         rc = 0;
568         if (time_after(jiffies, chp_info_expires)) {
569                 /* Data is too old, update. */
570                 rc = sclp_chp_read_info(&chp_info);
571                 chp_info_expires = jiffies + CHP_INFO_UPDATE_INTERVAL ;
572         }
573         mutex_unlock(&info_lock);
574
575         return rc;
576 }
577
578 /**
579  * chp_info_get_status - retrieve configure status of a channel-path
580  * @chpid: channel-path ID
581  *
582  * On success, return 0 for standby, 1 for configured, 2 for reserved,
583  * 3 for not recognized. Return negative error code on error.
584  */
585 int chp_info_get_status(struct chp_id chpid)
586 {
587         int rc;
588         int bit;
589
590         rc = info_update();
591         if (rc)
592                 return rc;
593
594         bit = info_bit_num(chpid);
595         mutex_lock(&info_lock);
596         if (!chp_test_bit(chp_info.recognized, bit))
597                 rc = CHP_STATUS_NOT_RECOGNIZED;
598         else if (chp_test_bit(chp_info.configured, bit))
599                 rc = CHP_STATUS_CONFIGURED;
600         else if (chp_test_bit(chp_info.standby, bit))
601                 rc = CHP_STATUS_STANDBY;
602         else
603                 rc = CHP_STATUS_RESERVED;
604         mutex_unlock(&info_lock);
605
606         return rc;
607 }
608
609 /* Return configure task for chpid. */
610 static enum cfg_task_t cfg_get_task(struct chp_id chpid)
611 {
612         return chp_cfg_task[chpid.cssid][chpid.id];
613 }
614
615 /* Set configure task for chpid. */
616 static void cfg_set_task(struct chp_id chpid, enum cfg_task_t cfg)
617 {
618         chp_cfg_task[chpid.cssid][chpid.id] = cfg;
619 }
620
621 /* Perform one configure/deconfigure request. Reschedule work function until
622  * last request. */
623 static void cfg_func(struct work_struct *work)
624 {
625         struct chp_id chpid;
626         enum cfg_task_t t;
627
628         mutex_lock(&cfg_lock);
629         t = cfg_none;
630         chp_id_for_each(&chpid) {
631                 t = cfg_get_task(chpid);
632                 if (t != cfg_none) {
633                         cfg_set_task(chpid, cfg_none);
634                         break;
635                 }
636         }
637         mutex_unlock(&cfg_lock);
638
639         switch (t) {
640         case cfg_configure:
641                 sclp_chp_configure(chpid);
642                 info_expire();
643                 chsc_chp_online(chpid);
644                 break;
645         case cfg_deconfigure:
646                 sclp_chp_deconfigure(chpid);
647                 info_expire();
648                 chsc_chp_offline(chpid);
649                 break;
650         case cfg_none:
651                 /* Get updated information after last change. */
652                 info_update();
653                 mutex_lock(&cfg_lock);
654                 cfg_busy = 0;
655                 mutex_unlock(&cfg_lock);
656                 wake_up_interruptible(&cfg_wait_queue);
657                 return;
658         }
659         queue_work(chp_wq, &cfg_work);
660 }
661
662 /**
663  * chp_cfg_schedule - schedule chpid configuration request
664  * @chpid - channel-path ID
665  * @configure - Non-zero for configure, zero for deconfigure
666  *
667  * Schedule a channel-path configuration/deconfiguration request.
668  */
669 void chp_cfg_schedule(struct chp_id chpid, int configure)
670 {
671         CIO_MSG_EVENT(2, "chp_cfg_sched%x.%02x=%d\n", chpid.cssid, chpid.id,
672                       configure);
673         mutex_lock(&cfg_lock);
674         cfg_set_task(chpid, configure ? cfg_configure : cfg_deconfigure);
675         cfg_busy = 1;
676         mutex_unlock(&cfg_lock);
677         queue_work(chp_wq, &cfg_work);
678 }
679
680 /**
681  * chp_cfg_cancel_deconfigure - cancel chpid deconfiguration request
682  * @chpid - channel-path ID
683  *
684  * Cancel an active channel-path deconfiguration request if it has not yet
685  * been performed.
686  */
687 void chp_cfg_cancel_deconfigure(struct chp_id chpid)
688 {
689         CIO_MSG_EVENT(2, "chp_cfg_cancel:%x.%02x\n", chpid.cssid, chpid.id);
690         mutex_lock(&cfg_lock);
691         if (cfg_get_task(chpid) == cfg_deconfigure)
692                 cfg_set_task(chpid, cfg_none);
693         mutex_unlock(&cfg_lock);
694 }
695
696 static int cfg_wait_idle(void)
697 {
698         if (wait_event_interruptible(cfg_wait_queue, !cfg_busy))
699                 return -ERESTARTSYS;
700         return 0;
701 }
702
703 static int __init chp_init(void)
704 {
705         struct chp_id chpid;
706         int ret;
707
708         ret = s390_register_crw_handler(CRW_RSC_CPATH, chp_process_crw);
709         if (ret)
710                 return ret;
711         chp_wq = create_singlethread_workqueue("cio_chp");
712         if (!chp_wq) {
713                 s390_unregister_crw_handler(CRW_RSC_CPATH);
714                 return -ENOMEM;
715         }
716         INIT_WORK(&cfg_work, cfg_func);
717         init_waitqueue_head(&cfg_wait_queue);
718         if (info_update())
719                 return 0;
720         /* Register available channel-paths. */
721         chp_id_for_each(&chpid) {
722                 if (chp_info_get_status(chpid) != CHP_STATUS_NOT_RECOGNIZED)
723                         chp_new(chpid);
724         }
725
726         return 0;
727 }
728
729 subsys_initcall(chp_init);