Merge branch 'devel-stable' of master.kernel.org:/home/rmk/linux-2.6-arm
[pandora-kernel.git] / drivers / rapidio / rio-scan.c
1 /*
2  * RapidIO enumeration and discovery support
3  *
4  * Copyright 2005 MontaVista Software, Inc.
5  * Matt Porter <mporter@kernel.crashing.org>
6  *
7  * Copyright 2009 Integrated Device Technology, Inc.
8  * Alex Bounine <alexandre.bounine@idt.com>
9  * - Added Port-Write/Error Management initialization and handling
10  *
11  * Copyright 2009 Sysgo AG
12  * Thomas Moll <thomas.moll@sysgo.com>
13  * - Added Input- Output- enable functionality, to allow full communication
14  *
15  * This program is free software; you can redistribute  it and/or modify it
16  * under  the terms of  the GNU General  Public License as published by the
17  * Free Software Foundation;  either version 2 of the  License, or (at your
18  * option) any later version.
19  */
20
21 #include <linux/types.h>
22 #include <linux/kernel.h>
23
24 #include <linux/delay.h>
25 #include <linux/dma-mapping.h>
26 #include <linux/init.h>
27 #include <linux/rio.h>
28 #include <linux/rio_drv.h>
29 #include <linux/rio_ids.h>
30 #include <linux/rio_regs.h>
31 #include <linux/module.h>
32 #include <linux/spinlock.h>
33 #include <linux/timer.h>
34 #include <linux/jiffies.h>
35 #include <linux/slab.h>
36
37 #include "rio.h"
38
39 LIST_HEAD(rio_devices);
40 static LIST_HEAD(rio_switches);
41
42 static void rio_enum_timeout(unsigned long);
43
44 static void rio_init_em(struct rio_dev *rdev);
45
46 DEFINE_SPINLOCK(rio_global_list_lock);
47
48 static int next_destid = 0;
49 static int next_net = 0;
50 static int next_comptag = 1;
51
52 static struct timer_list rio_enum_timer =
53 TIMER_INITIALIZER(rio_enum_timeout, 0, 0);
54
55 static int rio_mport_phys_table[] = {
56         RIO_EFB_PAR_EP_ID,
57         RIO_EFB_PAR_EP_REC_ID,
58         RIO_EFB_SER_EP_ID,
59         RIO_EFB_SER_EP_REC_ID,
60         -1,
61 };
62
63 /**
64  * rio_get_device_id - Get the base/extended device id for a device
65  * @port: RIO master port
66  * @destid: Destination ID of device
67  * @hopcount: Hopcount to device
68  *
69  * Reads the base/extended device id from a device. Returns the
70  * 8/16-bit device ID.
71  */
72 static u16 rio_get_device_id(struct rio_mport *port, u16 destid, u8 hopcount)
73 {
74         u32 result;
75
76         rio_mport_read_config_32(port, destid, hopcount, RIO_DID_CSR, &result);
77
78         return RIO_GET_DID(port->sys_size, result);
79 }
80
81 /**
82  * rio_set_device_id - Set the base/extended device id for a device
83  * @port: RIO master port
84  * @destid: Destination ID of device
85  * @hopcount: Hopcount to device
86  * @did: Device ID value to be written
87  *
88  * Writes the base/extended device id from a device.
89  */
90 static void rio_set_device_id(struct rio_mport *port, u16 destid, u8 hopcount, u16 did)
91 {
92         rio_mport_write_config_32(port, destid, hopcount, RIO_DID_CSR,
93                                   RIO_SET_DID(port->sys_size, did));
94 }
95
96 /**
97  * rio_local_set_device_id - Set the base/extended device id for a port
98  * @port: RIO master port
99  * @did: Device ID value to be written
100  *
101  * Writes the base/extended device id from a device.
102  */
103 static void rio_local_set_device_id(struct rio_mport *port, u16 did)
104 {
105         rio_local_write_config_32(port, RIO_DID_CSR, RIO_SET_DID(port->sys_size,
106                                 did));
107 }
108
109 /**
110  * rio_clear_locks- Release all host locks and signal enumeration complete
111  * @port: Master port to issue transaction
112  *
113  * Marks the component tag CSR on each device with the enumeration
114  * complete flag. When complete, it then release the host locks on
115  * each device. Returns 0 on success or %-EINVAL on failure.
116  */
117 static int rio_clear_locks(struct rio_mport *port)
118 {
119         struct rio_dev *rdev;
120         u32 result;
121         int ret = 0;
122
123         /* Release host device id locks */
124         rio_local_write_config_32(port, RIO_HOST_DID_LOCK_CSR,
125                                   port->host_deviceid);
126         rio_local_read_config_32(port, RIO_HOST_DID_LOCK_CSR, &result);
127         if ((result & 0xffff) != 0xffff) {
128                 printk(KERN_INFO
129                        "RIO: badness when releasing host lock on master port, result %8.8x\n",
130                        result);
131                 ret = -EINVAL;
132         }
133         list_for_each_entry(rdev, &rio_devices, global_list) {
134                 rio_write_config_32(rdev, RIO_HOST_DID_LOCK_CSR,
135                                     port->host_deviceid);
136                 rio_read_config_32(rdev, RIO_HOST_DID_LOCK_CSR, &result);
137                 if ((result & 0xffff) != 0xffff) {
138                         printk(KERN_INFO
139                                "RIO: badness when releasing host lock on vid %4.4x did %4.4x\n",
140                                rdev->vid, rdev->did);
141                         ret = -EINVAL;
142                 }
143
144                 /* Mark device as discovered and enable master */
145                 rio_read_config_32(rdev,
146                                    rdev->phys_efptr + RIO_PORT_GEN_CTL_CSR,
147                                    &result);
148                 result |= RIO_PORT_GEN_DISCOVERED | RIO_PORT_GEN_MASTER;
149                 rio_write_config_32(rdev,
150                                     rdev->phys_efptr + RIO_PORT_GEN_CTL_CSR,
151                                     result);
152         }
153
154         return ret;
155 }
156
157 /**
158  * rio_enum_host- Set host lock and initialize host destination ID
159  * @port: Master port to issue transaction
160  *
161  * Sets the local host master port lock and destination ID register
162  * with the host device ID value. The host device ID value is provided
163  * by the platform. Returns %0 on success or %-1 on failure.
164  */
165 static int rio_enum_host(struct rio_mport *port)
166 {
167         u32 result;
168
169         /* Set master port host device id lock */
170         rio_local_write_config_32(port, RIO_HOST_DID_LOCK_CSR,
171                                   port->host_deviceid);
172
173         rio_local_read_config_32(port, RIO_HOST_DID_LOCK_CSR, &result);
174         if ((result & 0xffff) != port->host_deviceid)
175                 return -1;
176
177         /* Set master port destid and init destid ctr */
178         rio_local_set_device_id(port, port->host_deviceid);
179
180         if (next_destid == port->host_deviceid)
181                 next_destid++;
182
183         return 0;
184 }
185
186 /**
187  * rio_device_has_destid- Test if a device contains a destination ID register
188  * @port: Master port to issue transaction
189  * @src_ops: RIO device source operations
190  * @dst_ops: RIO device destination operations
191  *
192  * Checks the provided @src_ops and @dst_ops for the necessary transaction
193  * capabilities that indicate whether or not a device will implement a
194  * destination ID register. Returns 1 if true or 0 if false.
195  */
196 static int rio_device_has_destid(struct rio_mport *port, int src_ops,
197                                  int dst_ops)
198 {
199         u32 mask = RIO_OPS_READ | RIO_OPS_WRITE | RIO_OPS_ATOMIC_TST_SWP | RIO_OPS_ATOMIC_INC | RIO_OPS_ATOMIC_DEC | RIO_OPS_ATOMIC_SET | RIO_OPS_ATOMIC_CLR;
200
201         return !!((src_ops | dst_ops) & mask);
202 }
203
204 /**
205  * rio_release_dev- Frees a RIO device struct
206  * @dev: LDM device associated with a RIO device struct
207  *
208  * Gets the RIO device struct associated a RIO device struct.
209  * The RIO device struct is freed.
210  */
211 static void rio_release_dev(struct device *dev)
212 {
213         struct rio_dev *rdev;
214
215         rdev = to_rio_dev(dev);
216         kfree(rdev);
217 }
218
219 /**
220  * rio_is_switch- Tests if a RIO device has switch capabilities
221  * @rdev: RIO device
222  *
223  * Gets the RIO device Processing Element Features register
224  * contents and tests for switch capabilities. Returns 1 if
225  * the device is a switch or 0 if it is not a switch.
226  * The RIO device struct is freed.
227  */
228 static int rio_is_switch(struct rio_dev *rdev)
229 {
230         if (rdev->pef & RIO_PEF_SWITCH)
231                 return 1;
232         return 0;
233 }
234
235 /**
236  * rio_switch_init - Sets switch operations for a particular vendor switch
237  * @rdev: RIO device
238  * @do_enum: Enumeration/Discovery mode flag
239  *
240  * Searches the RIO switch ops table for known switch types. If the vid
241  * and did match a switch table entry, then call switch initialization
242  * routine to setup switch-specific routines.
243  */
244 static void rio_switch_init(struct rio_dev *rdev, int do_enum)
245 {
246         struct rio_switch_ops *cur = __start_rio_switch_ops;
247         struct rio_switch_ops *end = __end_rio_switch_ops;
248
249         while (cur < end) {
250                 if ((cur->vid == rdev->vid) && (cur->did == rdev->did)) {
251                         pr_debug("RIO: calling init routine for %s\n",
252                                  rio_name(rdev));
253                         cur->init_hook(rdev, do_enum);
254                         break;
255                 }
256                 cur++;
257         }
258
259         if ((cur >= end) && (rdev->pef & RIO_PEF_STD_RT)) {
260                 pr_debug("RIO: adding STD routing ops for %s\n",
261                         rio_name(rdev));
262                 rdev->rswitch->add_entry = rio_std_route_add_entry;
263                 rdev->rswitch->get_entry = rio_std_route_get_entry;
264                 rdev->rswitch->clr_table = rio_std_route_clr_table;
265         }
266
267         if (!rdev->rswitch->add_entry || !rdev->rswitch->get_entry)
268                 printk(KERN_ERR "RIO: missing routing ops for %s\n",
269                        rio_name(rdev));
270 }
271
272 /**
273  * rio_add_device- Adds a RIO device to the device model
274  * @rdev: RIO device
275  *
276  * Adds the RIO device to the global device list and adds the RIO
277  * device to the RIO device list.  Creates the generic sysfs nodes
278  * for an RIO device.
279  */
280 static int __devinit rio_add_device(struct rio_dev *rdev)
281 {
282         int err;
283
284         err = device_add(&rdev->dev);
285         if (err)
286                 return err;
287
288         spin_lock(&rio_global_list_lock);
289         list_add_tail(&rdev->global_list, &rio_devices);
290         spin_unlock(&rio_global_list_lock);
291
292         rio_create_sysfs_dev_files(rdev);
293
294         return 0;
295 }
296
297 /**
298  * rio_enable_rx_tx_port - enable input reciever and output transmitter of
299  * given port
300  * @port: Master port associated with the RIO network
301  * @local: local=1 select local port otherwise a far device is reached
302  * @destid: Destination ID of the device to check host bit
303  * @hopcount: Number of hops to reach the target
304  * @port_num: Port (-number on switch) to enable on a far end device
305  *
306  * Returns 0 or 1 from on General Control Command and Status Register
307  * (EXT_PTR+0x3C)
308  */
309 inline int rio_enable_rx_tx_port(struct rio_mport *port,
310                                  int local, u16 destid,
311                                  u8 hopcount, u8 port_num) {
312 #ifdef CONFIG_RAPIDIO_ENABLE_RX_TX_PORTS
313         u32 regval;
314         u32 ext_ftr_ptr;
315
316         /*
317         * enable rx input tx output port
318         */
319         pr_debug("rio_enable_rx_tx_port(local = %d, destid = %d, hopcount = "
320                  "%d, port_num = %d)\n", local, destid, hopcount, port_num);
321
322         ext_ftr_ptr = rio_mport_get_physefb(port, local, destid, hopcount);
323
324         if (local) {
325                 rio_local_read_config_32(port, ext_ftr_ptr +
326                                 RIO_PORT_N_CTL_CSR(0),
327                                 &regval);
328         } else {
329                 if (rio_mport_read_config_32(port, destid, hopcount,
330                 ext_ftr_ptr + RIO_PORT_N_CTL_CSR(port_num), &regval) < 0)
331                         return -EIO;
332         }
333
334         if (regval & RIO_PORT_N_CTL_P_TYP_SER) {
335                 /* serial */
336                 regval = regval | RIO_PORT_N_CTL_EN_RX_SER
337                                 | RIO_PORT_N_CTL_EN_TX_SER;
338         } else {
339                 /* parallel */
340                 regval = regval | RIO_PORT_N_CTL_EN_RX_PAR
341                                 | RIO_PORT_N_CTL_EN_TX_PAR;
342         }
343
344         if (local) {
345                 rio_local_write_config_32(port, ext_ftr_ptr +
346                                           RIO_PORT_N_CTL_CSR(0), regval);
347         } else {
348                 if (rio_mport_write_config_32(port, destid, hopcount,
349                     ext_ftr_ptr + RIO_PORT_N_CTL_CSR(port_num), regval) < 0)
350                         return -EIO;
351         }
352 #endif
353         return 0;
354 }
355
356 /**
357  * rio_setup_device- Allocates and sets up a RIO device
358  * @net: RIO network
359  * @port: Master port to send transactions
360  * @destid: Current destination ID
361  * @hopcount: Current hopcount
362  * @do_enum: Enumeration/Discovery mode flag
363  *
364  * Allocates a RIO device and configures fields based on configuration
365  * space contents. If device has a destination ID register, a destination
366  * ID is either assigned in enumeration mode or read from configuration
367  * space in discovery mode.  If the device has switch capabilities, then
368  * a switch is allocated and configured appropriately. Returns a pointer
369  * to a RIO device on success or NULL on failure.
370  *
371  */
372 static struct rio_dev __devinit *rio_setup_device(struct rio_net *net,
373                                         struct rio_mport *port, u16 destid,
374                                         u8 hopcount, int do_enum)
375 {
376         int ret = 0;
377         struct rio_dev *rdev;
378         struct rio_switch *rswitch = NULL;
379         int result, rdid;
380         size_t size;
381         u32 swpinfo = 0;
382
383         size = sizeof(struct rio_dev);
384         if (rio_mport_read_config_32(port, destid, hopcount,
385                                      RIO_PEF_CAR, &result))
386                 return NULL;
387
388         if (result & (RIO_PEF_SWITCH | RIO_PEF_MULTIPORT)) {
389                 rio_mport_read_config_32(port, destid, hopcount,
390                                          RIO_SWP_INFO_CAR, &swpinfo);
391                 if (result & RIO_PEF_SWITCH) {
392                         size += (RIO_GET_TOTAL_PORTS(swpinfo) *
393                                 sizeof(rswitch->nextdev[0])) + sizeof(*rswitch);
394                 }
395         }
396
397         rdev = kzalloc(size, GFP_KERNEL);
398         if (!rdev)
399                 return NULL;
400
401         rdev->net = net;
402         rdev->pef = result;
403         rdev->swpinfo = swpinfo;
404         rio_mport_read_config_32(port, destid, hopcount, RIO_DEV_ID_CAR,
405                                  &result);
406         rdev->did = result >> 16;
407         rdev->vid = result & 0xffff;
408         rio_mport_read_config_32(port, destid, hopcount, RIO_DEV_INFO_CAR,
409                                  &rdev->device_rev);
410         rio_mport_read_config_32(port, destid, hopcount, RIO_ASM_ID_CAR,
411                                  &result);
412         rdev->asm_did = result >> 16;
413         rdev->asm_vid = result & 0xffff;
414         rio_mport_read_config_32(port, destid, hopcount, RIO_ASM_INFO_CAR,
415                                  &result);
416         rdev->asm_rev = result >> 16;
417         if (rdev->pef & RIO_PEF_EXT_FEATURES) {
418                 rdev->efptr = result & 0xffff;
419                 rdev->phys_efptr = rio_mport_get_physefb(port, 0, destid,
420                                                          hopcount);
421
422                 rdev->em_efptr = rio_mport_get_feature(port, 0, destid,
423                                                 hopcount, RIO_EFB_ERR_MGMNT);
424         }
425
426         rio_mport_read_config_32(port, destid, hopcount, RIO_SRC_OPS_CAR,
427                                  &rdev->src_ops);
428         rio_mport_read_config_32(port, destid, hopcount, RIO_DST_OPS_CAR,
429                                  &rdev->dst_ops);
430
431         if (do_enum) {
432                 /* Assign component tag to device */
433                 if (next_comptag >= 0x10000) {
434                         pr_err("RIO: Component Tag Counter Overflow\n");
435                         goto cleanup;
436                 }
437                 rio_mport_write_config_32(port, destid, hopcount,
438                                           RIO_COMPONENT_TAG_CSR, next_comptag);
439                 rdev->comp_tag = next_comptag++;
440         }  else {
441                 rio_mport_read_config_32(port, destid, hopcount,
442                                          RIO_COMPONENT_TAG_CSR,
443                                          &rdev->comp_tag);
444         }
445
446         if (rio_device_has_destid(port, rdev->src_ops, rdev->dst_ops)) {
447                 if (do_enum) {
448                         rio_set_device_id(port, destid, hopcount, next_destid);
449                         rdev->destid = next_destid++;
450                         if (next_destid == port->host_deviceid)
451                                 next_destid++;
452                 } else
453                         rdev->destid = rio_get_device_id(port, destid, hopcount);
454
455                 rdev->hopcount = 0xff;
456         } else {
457                 /* Switch device has an associated destID which
458                  * will be adjusted later
459                  */
460                 rdev->destid = destid;
461                 rdev->hopcount = hopcount;
462         }
463
464         /* If a PE has both switch and other functions, show it as a switch */
465         if (rio_is_switch(rdev)) {
466                 rswitch = rdev->rswitch;
467                 rswitch->switchid = rdev->comp_tag & RIO_CTAG_UDEVID;
468                 rswitch->port_ok = 0;
469                 rswitch->route_table = kzalloc(sizeof(u8)*
470                                         RIO_MAX_ROUTE_ENTRIES(port->sys_size),
471                                         GFP_KERNEL);
472                 if (!rswitch->route_table)
473                         goto cleanup;
474                 /* Initialize switch route table */
475                 for (rdid = 0; rdid < RIO_MAX_ROUTE_ENTRIES(port->sys_size);
476                                 rdid++)
477                         rswitch->route_table[rdid] = RIO_INVALID_ROUTE;
478                 dev_set_name(&rdev->dev, "%02x:s:%04x", rdev->net->id,
479                              rswitch->switchid);
480                 rio_switch_init(rdev, do_enum);
481
482                 if (do_enum && rswitch->clr_table)
483                         rswitch->clr_table(port, destid, hopcount,
484                                            RIO_GLOBAL_TABLE);
485
486                 list_add_tail(&rswitch->node, &rio_switches);
487
488         } else {
489                 if (do_enum)
490                         /*Enable Input Output Port (transmitter reviever)*/
491                         rio_enable_rx_tx_port(port, 0, destid, hopcount, 0);
492
493                 dev_set_name(&rdev->dev, "%02x:e:%04x", rdev->net->id,
494                              rdev->destid);
495         }
496
497         rdev->dev.bus = &rio_bus_type;
498         rdev->dev.parent = &rio_bus;
499
500         device_initialize(&rdev->dev);
501         rdev->dev.release = rio_release_dev;
502         rio_dev_get(rdev);
503
504         rdev->dma_mask = DMA_BIT_MASK(32);
505         rdev->dev.dma_mask = &rdev->dma_mask;
506         rdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
507
508         if ((rdev->pef & RIO_PEF_INB_DOORBELL) &&
509             (rdev->dst_ops & RIO_DST_OPS_DOORBELL))
510                 rio_init_dbell_res(&rdev->riores[RIO_DOORBELL_RESOURCE],
511                                    0, 0xffff);
512
513         ret = rio_add_device(rdev);
514         if (ret)
515                 goto cleanup;
516
517         return rdev;
518
519 cleanup:
520         if (rswitch->route_table)
521                 kfree(rswitch->route_table);
522
523         kfree(rdev);
524         return NULL;
525 }
526
527 /**
528  * rio_sport_is_active- Tests if a switch port has an active connection.
529  * @port: Master port to send transaction
530  * @destid: Associated destination ID for switch
531  * @hopcount: Hopcount to reach switch
532  * @sport: Switch port number
533  *
534  * Reads the port error status CSR for a particular switch port to
535  * determine if the port has an active link.  Returns
536  * %RIO_PORT_N_ERR_STS_PORT_OK if the port is active or %0 if it is
537  * inactive.
538  */
539 static int
540 rio_sport_is_active(struct rio_mport *port, u16 destid, u8 hopcount, int sport)
541 {
542         u32 result = 0;
543         u32 ext_ftr_ptr;
544
545         ext_ftr_ptr = rio_mport_get_efb(port, 0, destid, hopcount, 0);
546
547         while (ext_ftr_ptr) {
548                 rio_mport_read_config_32(port, destid, hopcount,
549                                          ext_ftr_ptr, &result);
550                 result = RIO_GET_BLOCK_ID(result);
551                 if ((result == RIO_EFB_SER_EP_FREE_ID) ||
552                     (result == RIO_EFB_SER_EP_FREE_ID_V13P) ||
553                     (result == RIO_EFB_SER_EP_FREC_ID))
554                         break;
555
556                 ext_ftr_ptr = rio_mport_get_efb(port, 0, destid, hopcount,
557                                                 ext_ftr_ptr);
558         }
559
560         if (ext_ftr_ptr)
561                 rio_mport_read_config_32(port, destid, hopcount,
562                                          ext_ftr_ptr +
563                                          RIO_PORT_N_ERR_STS_CSR(sport),
564                                          &result);
565
566         return result & RIO_PORT_N_ERR_STS_PORT_OK;
567 }
568
569 /**
570  * rio_lock_device - Acquires host device lock for specified device
571  * @port: Master port to send transaction
572  * @destid: Destination ID for device/switch
573  * @hopcount: Hopcount to reach switch
574  * @wait_ms: Max wait time in msec (0 = no timeout)
575  *
576  * Attepts to acquire host device lock for specified device
577  * Returns 0 if device lock acquired or EINVAL if timeout expires.
578  */
579 static int
580 rio_lock_device(struct rio_mport *port, u16 destid, u8 hopcount, int wait_ms)
581 {
582         u32 result;
583         int tcnt = 0;
584
585         /* Attempt to acquire device lock */
586         rio_mport_write_config_32(port, destid, hopcount,
587                                   RIO_HOST_DID_LOCK_CSR, port->host_deviceid);
588         rio_mport_read_config_32(port, destid, hopcount,
589                                  RIO_HOST_DID_LOCK_CSR, &result);
590
591         while (result != port->host_deviceid) {
592                 if (wait_ms != 0 && tcnt == wait_ms) {
593                         pr_debug("RIO: timeout when locking device %x:%x\n",
594                                 destid, hopcount);
595                         return -EINVAL;
596                 }
597
598                 /* Delay a bit */
599                 mdelay(1);
600                 tcnt++;
601                 /* Try to acquire device lock again */
602                 rio_mport_write_config_32(port, destid,
603                         hopcount,
604                         RIO_HOST_DID_LOCK_CSR,
605                         port->host_deviceid);
606                 rio_mport_read_config_32(port, destid,
607                         hopcount,
608                         RIO_HOST_DID_LOCK_CSR, &result);
609         }
610
611         return 0;
612 }
613
614 /**
615  * rio_unlock_device - Releases host device lock for specified device
616  * @port: Master port to send transaction
617  * @destid: Destination ID for device/switch
618  * @hopcount: Hopcount to reach switch
619  *
620  * Returns 0 if device lock released or EINVAL if fails.
621  */
622 static int
623 rio_unlock_device(struct rio_mport *port, u16 destid, u8 hopcount)
624 {
625         u32 result;
626
627         /* Release device lock */
628         rio_mport_write_config_32(port, destid,
629                                   hopcount,
630                                   RIO_HOST_DID_LOCK_CSR,
631                                   port->host_deviceid);
632         rio_mport_read_config_32(port, destid, hopcount,
633                 RIO_HOST_DID_LOCK_CSR, &result);
634         if ((result & 0xffff) != 0xffff) {
635                 pr_debug("RIO: badness when releasing device lock %x:%x\n",
636                          destid, hopcount);
637                 return -EINVAL;
638         }
639
640         return 0;
641 }
642
643 /**
644  * rio_route_add_entry- Add a route entry to a switch routing table
645  * @rdev: RIO device
646  * @table: Routing table ID
647  * @route_destid: Destination ID to be routed
648  * @route_port: Port number to be routed
649  * @lock: lock switch device flag
650  *
651  * Calls the switch specific add_entry() method to add a route entry
652  * on a switch. The route table can be specified using the @table
653  * argument if a switch has per port routing tables or the normal
654  * use is to specific all tables (or the global table) by passing
655  * %RIO_GLOBAL_TABLE in @table. Returns %0 on success or %-EINVAL
656  * on failure.
657  */
658 static int
659 rio_route_add_entry(struct rio_dev *rdev,
660                     u16 table, u16 route_destid, u8 route_port, int lock)
661 {
662         int rc;
663
664         if (lock) {
665                 rc = rio_lock_device(rdev->net->hport, rdev->destid,
666                                      rdev->hopcount, 1000);
667                 if (rc)
668                         return rc;
669         }
670
671         rc = rdev->rswitch->add_entry(rdev->net->hport, rdev->destid,
672                                       rdev->hopcount, table,
673                                       route_destid, route_port);
674         if (lock)
675                 rio_unlock_device(rdev->net->hport, rdev->destid,
676                                   rdev->hopcount);
677
678         return rc;
679 }
680
681 /**
682  * rio_route_get_entry- Read a route entry in a switch routing table
683  * @rdev: RIO device
684  * @table: Routing table ID
685  * @route_destid: Destination ID to be routed
686  * @route_port: Pointer to read port number into
687  * @lock: lock switch device flag
688  *
689  * Calls the switch specific get_entry() method to read a route entry
690  * in a switch. The route table can be specified using the @table
691  * argument if a switch has per port routing tables or the normal
692  * use is to specific all tables (or the global table) by passing
693  * %RIO_GLOBAL_TABLE in @table. Returns %0 on success or %-EINVAL
694  * on failure.
695  */
696 static int
697 rio_route_get_entry(struct rio_dev *rdev, u16 table,
698                     u16 route_destid, u8 *route_port, int lock)
699 {
700         int rc;
701
702         if (lock) {
703                 rc = rio_lock_device(rdev->net->hport, rdev->destid,
704                                      rdev->hopcount, 1000);
705                 if (rc)
706                         return rc;
707         }
708
709         rc = rdev->rswitch->get_entry(rdev->net->hport, rdev->destid,
710                                       rdev->hopcount, table,
711                                       route_destid, route_port);
712         if (lock)
713                 rio_unlock_device(rdev->net->hport, rdev->destid,
714                                   rdev->hopcount);
715
716         return rc;
717 }
718
719 /**
720  * rio_get_host_deviceid_lock- Reads the Host Device ID Lock CSR on a device
721  * @port: Master port to send transaction
722  * @hopcount: Number of hops to the device
723  *
724  * Used during enumeration to read the Host Device ID Lock CSR on a
725  * RIO device. Returns the value of the lock register.
726  */
727 static u16 rio_get_host_deviceid_lock(struct rio_mport *port, u8 hopcount)
728 {
729         u32 result;
730
731         rio_mport_read_config_32(port, RIO_ANY_DESTID(port->sys_size), hopcount,
732                                  RIO_HOST_DID_LOCK_CSR, &result);
733
734         return (u16) (result & 0xffff);
735 }
736
737 /**
738  * rio_enum_peer- Recursively enumerate a RIO network through a master port
739  * @net: RIO network being enumerated
740  * @port: Master port to send transactions
741  * @hopcount: Number of hops into the network
742  * @prev: Previous RIO device connected to the enumerated one
743  * @prev_port: Port on previous RIO device
744  *
745  * Recursively enumerates a RIO network.  Transactions are sent via the
746  * master port passed in @port.
747  */
748 static int __devinit rio_enum_peer(struct rio_net *net, struct rio_mport *port,
749                          u8 hopcount, struct rio_dev *prev, int prev_port)
750 {
751         int port_num;
752         int cur_destid;
753         int sw_destid;
754         int sw_inport;
755         struct rio_dev *rdev;
756         u16 destid;
757         u32 regval;
758         int tmp;
759
760         if (rio_mport_chk_dev_access(port,
761                         RIO_ANY_DESTID(port->sys_size), hopcount)) {
762                 pr_debug("RIO: device access check failed\n");
763                 return -1;
764         }
765
766         if (rio_get_host_deviceid_lock(port, hopcount) == port->host_deviceid) {
767                 pr_debug("RIO: PE already discovered by this host\n");
768                 /*
769                  * Already discovered by this host. Add it as another
770                  * link to the existing device.
771                  */
772                 rio_mport_read_config_32(port, RIO_ANY_DESTID(port->sys_size),
773                                 hopcount, RIO_COMPONENT_TAG_CSR, &regval);
774
775                 if (regval) {
776                         rdev = rio_get_comptag((regval & 0xffff), NULL);
777
778                         if (rdev && prev && rio_is_switch(prev)) {
779                                 pr_debug("RIO: redundant path to %s\n",
780                                          rio_name(rdev));
781                                 prev->rswitch->nextdev[prev_port] = rdev;
782                         }
783                 }
784
785                 return 0;
786         }
787
788         /* Attempt to acquire device lock */
789         rio_mport_write_config_32(port, RIO_ANY_DESTID(port->sys_size),
790                                   hopcount,
791                                   RIO_HOST_DID_LOCK_CSR, port->host_deviceid);
792         while ((tmp = rio_get_host_deviceid_lock(port, hopcount))
793                < port->host_deviceid) {
794                 /* Delay a bit */
795                 mdelay(1);
796                 /* Attempt to acquire device lock again */
797                 rio_mport_write_config_32(port, RIO_ANY_DESTID(port->sys_size),
798                                           hopcount,
799                                           RIO_HOST_DID_LOCK_CSR,
800                                           port->host_deviceid);
801         }
802
803         if (rio_get_host_deviceid_lock(port, hopcount) > port->host_deviceid) {
804                 pr_debug(
805                     "RIO: PE locked by a higher priority host...retreating\n");
806                 return -1;
807         }
808
809         /* Setup new RIO device */
810         rdev = rio_setup_device(net, port, RIO_ANY_DESTID(port->sys_size),
811                                         hopcount, 1);
812         if (rdev) {
813                 /* Add device to the global and bus/net specific list. */
814                 list_add_tail(&rdev->net_list, &net->devices);
815                 rdev->prev = prev;
816                 if (prev && rio_is_switch(prev))
817                         prev->rswitch->nextdev[prev_port] = rdev;
818         } else
819                 return -1;
820
821         if (rio_is_switch(rdev)) {
822                 sw_inport = RIO_GET_PORT_NUM(rdev->swpinfo);
823                 rio_route_add_entry(rdev, RIO_GLOBAL_TABLE,
824                                     port->host_deviceid, sw_inport, 0);
825                 rdev->rswitch->route_table[port->host_deviceid] = sw_inport;
826
827                 for (destid = 0; destid < next_destid; destid++) {
828                         if (destid == port->host_deviceid)
829                                 continue;
830                         rio_route_add_entry(rdev, RIO_GLOBAL_TABLE,
831                                             destid, sw_inport, 0);
832                         rdev->rswitch->route_table[destid] = sw_inport;
833                 }
834
835                 pr_debug(
836                     "RIO: found %s (vid %4.4x did %4.4x) with %d ports\n",
837                     rio_name(rdev), rdev->vid, rdev->did,
838                     RIO_GET_TOTAL_PORTS(rdev->swpinfo));
839                 sw_destid = next_destid;
840                 for (port_num = 0;
841                      port_num < RIO_GET_TOTAL_PORTS(rdev->swpinfo);
842                      port_num++) {
843                         /*Enable Input Output Port (transmitter reviever)*/
844                         rio_enable_rx_tx_port(port, 0,
845                                               RIO_ANY_DESTID(port->sys_size),
846                                               hopcount, port_num);
847
848                         if (sw_inport == port_num) {
849                                 rdev->rswitch->port_ok |= (1 << port_num);
850                                 continue;
851                         }
852
853                         cur_destid = next_destid;
854
855                         if (rio_sport_is_active
856                             (port, RIO_ANY_DESTID(port->sys_size), hopcount,
857                              port_num)) {
858                                 pr_debug(
859                                     "RIO: scanning device on port %d\n",
860                                     port_num);
861                                 rdev->rswitch->port_ok |= (1 << port_num);
862                                 rio_route_add_entry(rdev, RIO_GLOBAL_TABLE,
863                                                 RIO_ANY_DESTID(port->sys_size),
864                                                 port_num, 0);
865
866                                 if (rio_enum_peer(net, port, hopcount + 1,
867                                                   rdev, port_num) < 0)
868                                         return -1;
869
870                                 /* Update routing tables */
871                                 if (next_destid > cur_destid) {
872                                         for (destid = cur_destid;
873                                              destid < next_destid; destid++) {
874                                                 if (destid == port->host_deviceid)
875                                                         continue;
876                                                 rio_route_add_entry(rdev,
877                                                                     RIO_GLOBAL_TABLE,
878                                                                     destid,
879                                                                     port_num,
880                                                                     0);
881                                                 rdev->rswitch->
882                                                     route_table[destid] =
883                                                     port_num;
884                                         }
885                                 }
886                         } else {
887                                 /* If switch supports Error Management,
888                                  * set PORT_LOCKOUT bit for unused port
889                                  */
890                                 if (rdev->em_efptr)
891                                         rio_set_port_lockout(rdev, port_num, 1);
892
893                                 rdev->rswitch->port_ok &= ~(1 << port_num);
894                         }
895                 }
896
897                 /* Direct Port-write messages to the enumeratiing host */
898                 if ((rdev->src_ops & RIO_SRC_OPS_PORT_WRITE) &&
899                     (rdev->em_efptr)) {
900                         rio_write_config_32(rdev,
901                                         rdev->em_efptr + RIO_EM_PW_TGT_DEVID,
902                                         (port->host_deviceid << 16) |
903                                         (port->sys_size << 15));
904                 }
905
906                 rio_init_em(rdev);
907
908                 /* Check for empty switch */
909                 if (next_destid == sw_destid) {
910                         next_destid++;
911                         if (next_destid == port->host_deviceid)
912                                 next_destid++;
913                 }
914
915                 rdev->destid = sw_destid;
916         } else
917                 pr_debug("RIO: found %s (vid %4.4x did %4.4x)\n",
918                     rio_name(rdev), rdev->vid, rdev->did);
919
920         return 0;
921 }
922
923 /**
924  * rio_enum_complete- Tests if enumeration of a network is complete
925  * @port: Master port to send transaction
926  *
927  * Tests the Component Tag CSR for non-zero value (enumeration
928  * complete flag). Return %1 if enumeration is complete or %0 if
929  * enumeration is incomplete.
930  */
931 static int rio_enum_complete(struct rio_mport *port)
932 {
933         u32 regval;
934
935         rio_local_read_config_32(port, port->phys_efptr + RIO_PORT_GEN_CTL_CSR,
936                                  &regval);
937         return (regval & RIO_PORT_GEN_MASTER) ? 1 : 0;
938 }
939
940 /**
941  * rio_disc_peer- Recursively discovers a RIO network through a master port
942  * @net: RIO network being discovered
943  * @port: Master port to send transactions
944  * @destid: Current destination ID in network
945  * @hopcount: Number of hops into the network
946  *
947  * Recursively discovers a RIO network.  Transactions are sent via the
948  * master port passed in @port.
949  */
950 static int __devinit
951 rio_disc_peer(struct rio_net *net, struct rio_mport *port, u16 destid,
952               u8 hopcount, struct rio_dev *prev, int prev_port)
953 {
954         u8 port_num, route_port;
955         struct rio_dev *rdev;
956         u16 ndestid;
957
958         /* Setup new RIO device */
959         if ((rdev = rio_setup_device(net, port, destid, hopcount, 0))) {
960                 /* Add device to the global and bus/net specific list. */
961                 list_add_tail(&rdev->net_list, &net->devices);
962                 rdev->prev = prev;
963                 if (prev && rio_is_switch(prev))
964                         prev->rswitch->nextdev[prev_port] = rdev;
965         } else
966                 return -1;
967
968         if (rio_is_switch(rdev)) {
969                 /* Associated destid is how we accessed this switch */
970                 rdev->destid = destid;
971
972                 pr_debug(
973                     "RIO: found %s (vid %4.4x did %4.4x) with %d ports\n",
974                     rio_name(rdev), rdev->vid, rdev->did,
975                     RIO_GET_TOTAL_PORTS(rdev->swpinfo));
976                 for (port_num = 0;
977                      port_num < RIO_GET_TOTAL_PORTS(rdev->swpinfo);
978                      port_num++) {
979                         if (RIO_GET_PORT_NUM(rdev->swpinfo) == port_num)
980                                 continue;
981
982                         if (rio_sport_is_active
983                             (port, destid, hopcount, port_num)) {
984                                 pr_debug(
985                                     "RIO: scanning device on port %d\n",
986                                     port_num);
987
988                                 rio_lock_device(port, destid, hopcount, 1000);
989
990                                 for (ndestid = 0;
991                                      ndestid < RIO_ANY_DESTID(port->sys_size);
992                                      ndestid++) {
993                                         rio_route_get_entry(rdev,
994                                                             RIO_GLOBAL_TABLE,
995                                                             ndestid,
996                                                             &route_port, 0);
997                                         if (route_port == port_num)
998                                                 break;
999                                 }
1000
1001                                 if (ndestid == RIO_ANY_DESTID(port->sys_size))
1002                                         continue;
1003                                 rio_unlock_device(port, destid, hopcount);
1004                                 if (rio_disc_peer(net, port, ndestid,
1005                                         hopcount + 1, rdev, port_num) < 0)
1006                                         return -1;
1007                         }
1008                 }
1009         } else
1010                 pr_debug("RIO: found %s (vid %4.4x did %4.4x)\n",
1011                     rio_name(rdev), rdev->vid, rdev->did);
1012
1013         return 0;
1014 }
1015
1016 /**
1017  * rio_mport_is_active- Tests if master port link is active
1018  * @port: Master port to test
1019  *
1020  * Reads the port error status CSR for the master port to
1021  * determine if the port has an active link.  Returns
1022  * %RIO_PORT_N_ERR_STS_PORT_OK if the  master port is active
1023  * or %0 if it is inactive.
1024  */
1025 static int rio_mport_is_active(struct rio_mport *port)
1026 {
1027         u32 result = 0;
1028         u32 ext_ftr_ptr;
1029         int *entry = rio_mport_phys_table;
1030
1031         do {
1032                 if ((ext_ftr_ptr =
1033                      rio_mport_get_feature(port, 1, 0, 0, *entry)))
1034                         break;
1035         } while (*++entry >= 0);
1036
1037         if (ext_ftr_ptr)
1038                 rio_local_read_config_32(port,
1039                                          ext_ftr_ptr +
1040                                          RIO_PORT_N_ERR_STS_CSR(port->index),
1041                                          &result);
1042
1043         return result & RIO_PORT_N_ERR_STS_PORT_OK;
1044 }
1045
1046 /**
1047  * rio_alloc_net- Allocate and configure a new RIO network
1048  * @port: Master port associated with the RIO network
1049  *
1050  * Allocates a RIO network structure, initializes per-network
1051  * list heads, and adds the associated master port to the
1052  * network list of associated master ports. Returns a
1053  * RIO network pointer on success or %NULL on failure.
1054  */
1055 static struct rio_net __devinit *rio_alloc_net(struct rio_mport *port)
1056 {
1057         struct rio_net *net;
1058
1059         net = kzalloc(sizeof(struct rio_net), GFP_KERNEL);
1060         if (net) {
1061                 INIT_LIST_HEAD(&net->node);
1062                 INIT_LIST_HEAD(&net->devices);
1063                 INIT_LIST_HEAD(&net->mports);
1064                 list_add_tail(&port->nnode, &net->mports);
1065                 net->hport = port;
1066                 net->id = next_net++;
1067         }
1068         return net;
1069 }
1070
1071 /**
1072  * rio_update_route_tables- Updates route tables in switches
1073  * @port: Master port associated with the RIO network
1074  *
1075  * For each enumerated device, ensure that each switch in a system
1076  * has correct routing entries. Add routes for devices that where
1077  * unknown dirung the first enumeration pass through the switch.
1078  */
1079 static void rio_update_route_tables(struct rio_mport *port)
1080 {
1081         struct rio_dev *rdev, *swrdev;
1082         struct rio_switch *rswitch;
1083         u8 sport;
1084         u16 destid;
1085
1086         list_for_each_entry(rdev, &rio_devices, global_list) {
1087
1088                 destid = rdev->destid;
1089
1090                 list_for_each_entry(rswitch, &rio_switches, node) {
1091
1092                         if (rio_is_switch(rdev) && (rdev->rswitch == rswitch))
1093                                 continue;
1094
1095                         if (RIO_INVALID_ROUTE == rswitch->route_table[destid]) {
1096                                 swrdev = sw_to_rio_dev(rswitch);
1097
1098                                 /* Skip if destid ends in empty switch*/
1099                                 if (swrdev->destid == destid)
1100                                         continue;
1101
1102                                 sport = RIO_GET_PORT_NUM(swrdev->swpinfo);
1103
1104                                 if (rswitch->add_entry) {
1105                                         rio_route_add_entry(swrdev,
1106                                                 RIO_GLOBAL_TABLE, destid,
1107                                                 sport, 0);
1108                                         rswitch->route_table[destid] = sport;
1109                                 }
1110                         }
1111                 }
1112         }
1113 }
1114
1115 /**
1116  * rio_init_em - Initializes RIO Error Management (for switches)
1117  * @rdev: RIO device
1118  *
1119  * For each enumerated switch, call device-specific error management
1120  * initialization routine (if supplied by the switch driver).
1121  */
1122 static void rio_init_em(struct rio_dev *rdev)
1123 {
1124         if (rio_is_switch(rdev) && (rdev->em_efptr) &&
1125             (rdev->rswitch->em_init)) {
1126                 rdev->rswitch->em_init(rdev);
1127         }
1128 }
1129
1130 /**
1131  * rio_pw_enable - Enables/disables port-write handling by a master port
1132  * @port: Master port associated with port-write handling
1133  * @enable:  1=enable,  0=disable
1134  */
1135 static void rio_pw_enable(struct rio_mport *port, int enable)
1136 {
1137         if (port->ops->pwenable)
1138                 port->ops->pwenable(port, enable);
1139 }
1140
1141 /**
1142  * rio_enum_mport- Start enumeration through a master port
1143  * @mport: Master port to send transactions
1144  *
1145  * Starts the enumeration process. If somebody has enumerated our
1146  * master port device, then give up. If not and we have an active
1147  * link, then start recursive peer enumeration. Returns %0 if
1148  * enumeration succeeds or %-EBUSY if enumeration fails.
1149  */
1150 int __devinit rio_enum_mport(struct rio_mport *mport)
1151 {
1152         struct rio_net *net = NULL;
1153         int rc = 0;
1154
1155         printk(KERN_INFO "RIO: enumerate master port %d, %s\n", mport->id,
1156                mport->name);
1157         /* If somebody else enumerated our master port device, bail. */
1158         if (rio_enum_host(mport) < 0) {
1159                 printk(KERN_INFO
1160                        "RIO: master port %d device has been enumerated by a remote host\n",
1161                        mport->id);
1162                 rc = -EBUSY;
1163                 goto out;
1164         }
1165
1166         /* If master port has an active link, allocate net and enum peers */
1167         if (rio_mport_is_active(mport)) {
1168                 if (!(net = rio_alloc_net(mport))) {
1169                         printk(KERN_ERR "RIO: failed to allocate new net\n");
1170                         rc = -ENOMEM;
1171                         goto out;
1172                 }
1173
1174                 /* Enable Input Output Port (transmitter reviever) */
1175                 rio_enable_rx_tx_port(mport, 1, 0, 0, 0);
1176
1177                 /* Set component tag for host */
1178                 rio_local_write_config_32(mport, RIO_COMPONENT_TAG_CSR,
1179                                           next_comptag++);
1180
1181                 if (rio_enum_peer(net, mport, 0, NULL, 0) < 0) {
1182                         /* A higher priority host won enumeration, bail. */
1183                         printk(KERN_INFO
1184                                "RIO: master port %d device has lost enumeration to a remote host\n",
1185                                mport->id);
1186                         rio_clear_locks(mport);
1187                         rc = -EBUSY;
1188                         goto out;
1189                 }
1190                 rio_update_route_tables(mport);
1191                 rio_clear_locks(mport);
1192                 rio_pw_enable(mport, 1);
1193         } else {
1194                 printk(KERN_INFO "RIO: master port %d link inactive\n",
1195                        mport->id);
1196                 rc = -EINVAL;
1197         }
1198
1199       out:
1200         return rc;
1201 }
1202
1203 /**
1204  * rio_build_route_tables- Generate route tables from switch route entries
1205  *
1206  * For each switch device, generate a route table by copying existing
1207  * route entries from the switch.
1208  */
1209 static void rio_build_route_tables(void)
1210 {
1211         struct rio_dev *rdev;
1212         int i;
1213         u8 sport;
1214
1215         list_for_each_entry(rdev, &rio_devices, global_list)
1216                 if (rio_is_switch(rdev)) {
1217                         rio_lock_device(rdev->net->hport, rdev->destid,
1218                                         rdev->hopcount, 1000);
1219                         for (i = 0;
1220                              i < RIO_MAX_ROUTE_ENTRIES(rdev->net->hport->sys_size);
1221                              i++) {
1222                                 if (rio_route_get_entry(rdev,
1223                                         RIO_GLOBAL_TABLE, i, &sport, 0) < 0)
1224                                         continue;
1225                                 rdev->rswitch->route_table[i] = sport;
1226                         }
1227
1228                         rio_unlock_device(rdev->net->hport,
1229                                           rdev->destid,
1230                                           rdev->hopcount);
1231                 }
1232 }
1233
1234 /**
1235  * rio_enum_timeout- Signal that enumeration timed out
1236  * @data: Address of timeout flag.
1237  *
1238  * When the enumeration complete timer expires, set a flag that
1239  * signals to the discovery process that enumeration did not
1240  * complete in a sane amount of time.
1241  */
1242 static void rio_enum_timeout(unsigned long data)
1243 {
1244         /* Enumeration timed out, set flag */
1245         *(int *)data = 1;
1246 }
1247
1248 /**
1249  * rio_disc_mport- Start discovery through a master port
1250  * @mport: Master port to send transactions
1251  *
1252  * Starts the discovery process. If we have an active link,
1253  * then wait for the signal that enumeration is complete.
1254  * When enumeration completion is signaled, start recursive
1255  * peer discovery. Returns %0 if discovery succeeds or %-EBUSY
1256  * on failure.
1257  */
1258 int __devinit rio_disc_mport(struct rio_mport *mport)
1259 {
1260         struct rio_net *net = NULL;
1261         int enum_timeout_flag = 0;
1262
1263         printk(KERN_INFO "RIO: discover master port %d, %s\n", mport->id,
1264                mport->name);
1265
1266         /* If master port has an active link, allocate net and discover peers */
1267         if (rio_mport_is_active(mport)) {
1268                 if (!(net = rio_alloc_net(mport))) {
1269                         printk(KERN_ERR "RIO: Failed to allocate new net\n");
1270                         goto bail;
1271                 }
1272
1273                 pr_debug("RIO: wait for enumeration complete...");
1274
1275                 rio_enum_timer.expires =
1276                     jiffies + CONFIG_RAPIDIO_DISC_TIMEOUT * HZ;
1277                 rio_enum_timer.data = (unsigned long)&enum_timeout_flag;
1278                 add_timer(&rio_enum_timer);
1279                 while (!rio_enum_complete(mport)) {
1280                         mdelay(1);
1281                         if (enum_timeout_flag) {
1282                                 del_timer_sync(&rio_enum_timer);
1283                                 goto timeout;
1284                         }
1285                 }
1286                 del_timer_sync(&rio_enum_timer);
1287
1288                 pr_debug("done\n");
1289
1290                 /* Read DestID assigned by enumerator */
1291                 rio_local_read_config_32(mport, RIO_DID_CSR,
1292                                          &mport->host_deviceid);
1293                 mport->host_deviceid = RIO_GET_DID(mport->sys_size,
1294                                                    mport->host_deviceid);
1295
1296                 if (rio_disc_peer(net, mport, RIO_ANY_DESTID(mport->sys_size),
1297                                         0, NULL, 0) < 0) {
1298                         printk(KERN_INFO
1299                                "RIO: master port %d device has failed discovery\n",
1300                                mport->id);
1301                         goto bail;
1302                 }
1303
1304                 rio_build_route_tables();
1305         }
1306
1307         return 0;
1308
1309       timeout:
1310         pr_debug("timeout\n");
1311       bail:
1312         return -EBUSY;
1313 }