Merge branch 'akpm' (Andrew's incoming - part two)
[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 receiver 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->dst_ops & RIO_DST_OPS_DOORBELL)
509                 rio_init_dbell_res(&rdev->riores[RIO_DOORBELL_RESOURCE],
510                                    0, 0xffff);
511
512         ret = rio_add_device(rdev);
513         if (ret)
514                 goto cleanup;
515
516         return rdev;
517
518 cleanup:
519         if (rswitch)
520                 kfree(rswitch->route_table);
521
522         kfree(rdev);
523         return NULL;
524 }
525
526 /**
527  * rio_sport_is_active- Tests if a switch port has an active connection.
528  * @port: Master port to send transaction
529  * @destid: Associated destination ID for switch
530  * @hopcount: Hopcount to reach switch
531  * @sport: Switch port number
532  *
533  * Reads the port error status CSR for a particular switch port to
534  * determine if the port has an active link.  Returns
535  * %RIO_PORT_N_ERR_STS_PORT_OK if the port is active or %0 if it is
536  * inactive.
537  */
538 static int
539 rio_sport_is_active(struct rio_mport *port, u16 destid, u8 hopcount, int sport)
540 {
541         u32 result = 0;
542         u32 ext_ftr_ptr;
543
544         ext_ftr_ptr = rio_mport_get_efb(port, 0, destid, hopcount, 0);
545
546         while (ext_ftr_ptr) {
547                 rio_mport_read_config_32(port, destid, hopcount,
548                                          ext_ftr_ptr, &result);
549                 result = RIO_GET_BLOCK_ID(result);
550                 if ((result == RIO_EFB_SER_EP_FREE_ID) ||
551                     (result == RIO_EFB_SER_EP_FREE_ID_V13P) ||
552                     (result == RIO_EFB_SER_EP_FREC_ID))
553                         break;
554
555                 ext_ftr_ptr = rio_mport_get_efb(port, 0, destid, hopcount,
556                                                 ext_ftr_ptr);
557         }
558
559         if (ext_ftr_ptr)
560                 rio_mport_read_config_32(port, destid, hopcount,
561                                          ext_ftr_ptr +
562                                          RIO_PORT_N_ERR_STS_CSR(sport),
563                                          &result);
564
565         return result & RIO_PORT_N_ERR_STS_PORT_OK;
566 }
567
568 /**
569  * rio_lock_device - Acquires host device lock for specified device
570  * @port: Master port to send transaction
571  * @destid: Destination ID for device/switch
572  * @hopcount: Hopcount to reach switch
573  * @wait_ms: Max wait time in msec (0 = no timeout)
574  *
575  * Attepts to acquire host device lock for specified device
576  * Returns 0 if device lock acquired or EINVAL if timeout expires.
577  */
578 static int
579 rio_lock_device(struct rio_mport *port, u16 destid, u8 hopcount, int wait_ms)
580 {
581         u32 result;
582         int tcnt = 0;
583
584         /* Attempt to acquire device lock */
585         rio_mport_write_config_32(port, destid, hopcount,
586                                   RIO_HOST_DID_LOCK_CSR, port->host_deviceid);
587         rio_mport_read_config_32(port, destid, hopcount,
588                                  RIO_HOST_DID_LOCK_CSR, &result);
589
590         while (result != port->host_deviceid) {
591                 if (wait_ms != 0 && tcnt == wait_ms) {
592                         pr_debug("RIO: timeout when locking device %x:%x\n",
593                                 destid, hopcount);
594                         return -EINVAL;
595                 }
596
597                 /* Delay a bit */
598                 mdelay(1);
599                 tcnt++;
600                 /* Try to acquire device lock again */
601                 rio_mport_write_config_32(port, destid,
602                         hopcount,
603                         RIO_HOST_DID_LOCK_CSR,
604                         port->host_deviceid);
605                 rio_mport_read_config_32(port, destid,
606                         hopcount,
607                         RIO_HOST_DID_LOCK_CSR, &result);
608         }
609
610         return 0;
611 }
612
613 /**
614  * rio_unlock_device - Releases host device lock for specified device
615  * @port: Master port to send transaction
616  * @destid: Destination ID for device/switch
617  * @hopcount: Hopcount to reach switch
618  *
619  * Returns 0 if device lock released or EINVAL if fails.
620  */
621 static int
622 rio_unlock_device(struct rio_mport *port, u16 destid, u8 hopcount)
623 {
624         u32 result;
625
626         /* Release device lock */
627         rio_mport_write_config_32(port, destid,
628                                   hopcount,
629                                   RIO_HOST_DID_LOCK_CSR,
630                                   port->host_deviceid);
631         rio_mport_read_config_32(port, destid, hopcount,
632                 RIO_HOST_DID_LOCK_CSR, &result);
633         if ((result & 0xffff) != 0xffff) {
634                 pr_debug("RIO: badness when releasing device lock %x:%x\n",
635                          destid, hopcount);
636                 return -EINVAL;
637         }
638
639         return 0;
640 }
641
642 /**
643  * rio_route_add_entry- Add a route entry to a switch routing table
644  * @rdev: RIO device
645  * @table: Routing table ID
646  * @route_destid: Destination ID to be routed
647  * @route_port: Port number to be routed
648  * @lock: lock switch device flag
649  *
650  * Calls the switch specific add_entry() method to add a route entry
651  * on a switch. The route table can be specified using the @table
652  * argument if a switch has per port routing tables or the normal
653  * use is to specific all tables (or the global table) by passing
654  * %RIO_GLOBAL_TABLE in @table. Returns %0 on success or %-EINVAL
655  * on failure.
656  */
657 static int
658 rio_route_add_entry(struct rio_dev *rdev,
659                     u16 table, u16 route_destid, u8 route_port, int lock)
660 {
661         int rc;
662
663         if (lock) {
664                 rc = rio_lock_device(rdev->net->hport, rdev->destid,
665                                      rdev->hopcount, 1000);
666                 if (rc)
667                         return rc;
668         }
669
670         rc = rdev->rswitch->add_entry(rdev->net->hport, rdev->destid,
671                                       rdev->hopcount, table,
672                                       route_destid, route_port);
673         if (lock)
674                 rio_unlock_device(rdev->net->hport, rdev->destid,
675                                   rdev->hopcount);
676
677         return rc;
678 }
679
680 /**
681  * rio_route_get_entry- Read a route entry in a switch routing table
682  * @rdev: RIO device
683  * @table: Routing table ID
684  * @route_destid: Destination ID to be routed
685  * @route_port: Pointer to read port number into
686  * @lock: lock switch device flag
687  *
688  * Calls the switch specific get_entry() method to read a route entry
689  * in a switch. The route table can be specified using the @table
690  * argument if a switch has per port routing tables or the normal
691  * use is to specific all tables (or the global table) by passing
692  * %RIO_GLOBAL_TABLE in @table. Returns %0 on success or %-EINVAL
693  * on failure.
694  */
695 static int
696 rio_route_get_entry(struct rio_dev *rdev, u16 table,
697                     u16 route_destid, u8 *route_port, int lock)
698 {
699         int rc;
700
701         if (lock) {
702                 rc = rio_lock_device(rdev->net->hport, rdev->destid,
703                                      rdev->hopcount, 1000);
704                 if (rc)
705                         return rc;
706         }
707
708         rc = rdev->rswitch->get_entry(rdev->net->hport, rdev->destid,
709                                       rdev->hopcount, table,
710                                       route_destid, route_port);
711         if (lock)
712                 rio_unlock_device(rdev->net->hport, rdev->destid,
713                                   rdev->hopcount);
714
715         return rc;
716 }
717
718 /**
719  * rio_get_host_deviceid_lock- Reads the Host Device ID Lock CSR on a device
720  * @port: Master port to send transaction
721  * @hopcount: Number of hops to the device
722  *
723  * Used during enumeration to read the Host Device ID Lock CSR on a
724  * RIO device. Returns the value of the lock register.
725  */
726 static u16 rio_get_host_deviceid_lock(struct rio_mport *port, u8 hopcount)
727 {
728         u32 result;
729
730         rio_mport_read_config_32(port, RIO_ANY_DESTID(port->sys_size), hopcount,
731                                  RIO_HOST_DID_LOCK_CSR, &result);
732
733         return (u16) (result & 0xffff);
734 }
735
736 /**
737  * rio_enum_peer- Recursively enumerate a RIO network through a master port
738  * @net: RIO network being enumerated
739  * @port: Master port to send transactions
740  * @hopcount: Number of hops into the network
741  * @prev: Previous RIO device connected to the enumerated one
742  * @prev_port: Port on previous RIO device
743  *
744  * Recursively enumerates a RIO network.  Transactions are sent via the
745  * master port passed in @port.
746  */
747 static int __devinit rio_enum_peer(struct rio_net *net, struct rio_mport *port,
748                          u8 hopcount, struct rio_dev *prev, int prev_port)
749 {
750         int port_num;
751         int cur_destid;
752         int sw_destid;
753         int sw_inport;
754         struct rio_dev *rdev;
755         u16 destid;
756         u32 regval;
757         int tmp;
758
759         if (rio_mport_chk_dev_access(port,
760                         RIO_ANY_DESTID(port->sys_size), hopcount)) {
761                 pr_debug("RIO: device access check failed\n");
762                 return -1;
763         }
764
765         if (rio_get_host_deviceid_lock(port, hopcount) == port->host_deviceid) {
766                 pr_debug("RIO: PE already discovered by this host\n");
767                 /*
768                  * Already discovered by this host. Add it as another
769                  * link to the existing device.
770                  */
771                 rio_mport_read_config_32(port, RIO_ANY_DESTID(port->sys_size),
772                                 hopcount, RIO_COMPONENT_TAG_CSR, &regval);
773
774                 if (regval) {
775                         rdev = rio_get_comptag((regval & 0xffff), NULL);
776
777                         if (rdev && prev && rio_is_switch(prev)) {
778                                 pr_debug("RIO: redundant path to %s\n",
779                                          rio_name(rdev));
780                                 prev->rswitch->nextdev[prev_port] = rdev;
781                         }
782                 }
783
784                 return 0;
785         }
786
787         /* Attempt to acquire device lock */
788         rio_mport_write_config_32(port, RIO_ANY_DESTID(port->sys_size),
789                                   hopcount,
790                                   RIO_HOST_DID_LOCK_CSR, port->host_deviceid);
791         while ((tmp = rio_get_host_deviceid_lock(port, hopcount))
792                < port->host_deviceid) {
793                 /* Delay a bit */
794                 mdelay(1);
795                 /* Attempt to acquire device lock again */
796                 rio_mport_write_config_32(port, RIO_ANY_DESTID(port->sys_size),
797                                           hopcount,
798                                           RIO_HOST_DID_LOCK_CSR,
799                                           port->host_deviceid);
800         }
801
802         if (rio_get_host_deviceid_lock(port, hopcount) > port->host_deviceid) {
803                 pr_debug(
804                     "RIO: PE locked by a higher priority host...retreating\n");
805                 return -1;
806         }
807
808         /* Setup new RIO device */
809         rdev = rio_setup_device(net, port, RIO_ANY_DESTID(port->sys_size),
810                                         hopcount, 1);
811         if (rdev) {
812                 /* Add device to the global and bus/net specific list. */
813                 list_add_tail(&rdev->net_list, &net->devices);
814                 rdev->prev = prev;
815                 if (prev && rio_is_switch(prev))
816                         prev->rswitch->nextdev[prev_port] = rdev;
817         } else
818                 return -1;
819
820         if (rio_is_switch(rdev)) {
821                 sw_inport = RIO_GET_PORT_NUM(rdev->swpinfo);
822                 rio_route_add_entry(rdev, RIO_GLOBAL_TABLE,
823                                     port->host_deviceid, sw_inport, 0);
824                 rdev->rswitch->route_table[port->host_deviceid] = sw_inport;
825
826                 for (destid = 0; destid < next_destid; destid++) {
827                         if (destid == port->host_deviceid)
828                                 continue;
829                         rio_route_add_entry(rdev, RIO_GLOBAL_TABLE,
830                                             destid, sw_inport, 0);
831                         rdev->rswitch->route_table[destid] = sw_inport;
832                 }
833
834                 pr_debug(
835                     "RIO: found %s (vid %4.4x did %4.4x) with %d ports\n",
836                     rio_name(rdev), rdev->vid, rdev->did,
837                     RIO_GET_TOTAL_PORTS(rdev->swpinfo));
838                 sw_destid = next_destid;
839                 for (port_num = 0;
840                      port_num < RIO_GET_TOTAL_PORTS(rdev->swpinfo);
841                      port_num++) {
842                         /*Enable Input Output Port (transmitter reviever)*/
843                         rio_enable_rx_tx_port(port, 0,
844                                               RIO_ANY_DESTID(port->sys_size),
845                                               hopcount, port_num);
846
847                         if (sw_inport == port_num) {
848                                 rdev->rswitch->port_ok |= (1 << port_num);
849                                 continue;
850                         }
851
852                         cur_destid = next_destid;
853
854                         if (rio_sport_is_active
855                             (port, RIO_ANY_DESTID(port->sys_size), hopcount,
856                              port_num)) {
857                                 pr_debug(
858                                     "RIO: scanning device on port %d\n",
859                                     port_num);
860                                 rdev->rswitch->port_ok |= (1 << port_num);
861                                 rio_route_add_entry(rdev, RIO_GLOBAL_TABLE,
862                                                 RIO_ANY_DESTID(port->sys_size),
863                                                 port_num, 0);
864
865                                 if (rio_enum_peer(net, port, hopcount + 1,
866                                                   rdev, port_num) < 0)
867                                         return -1;
868
869                                 /* Update routing tables */
870                                 if (next_destid > cur_destid) {
871                                         for (destid = cur_destid;
872                                              destid < next_destid; destid++) {
873                                                 if (destid == port->host_deviceid)
874                                                         continue;
875                                                 rio_route_add_entry(rdev,
876                                                                     RIO_GLOBAL_TABLE,
877                                                                     destid,
878                                                                     port_num,
879                                                                     0);
880                                                 rdev->rswitch->
881                                                     route_table[destid] =
882                                                     port_num;
883                                         }
884                                 }
885                         } else {
886                                 /* If switch supports Error Management,
887                                  * set PORT_LOCKOUT bit for unused port
888                                  */
889                                 if (rdev->em_efptr)
890                                         rio_set_port_lockout(rdev, port_num, 1);
891
892                                 rdev->rswitch->port_ok &= ~(1 << port_num);
893                         }
894                 }
895
896                 /* Direct Port-write messages to the enumeratiing host */
897                 if ((rdev->src_ops & RIO_SRC_OPS_PORT_WRITE) &&
898                     (rdev->em_efptr)) {
899                         rio_write_config_32(rdev,
900                                         rdev->em_efptr + RIO_EM_PW_TGT_DEVID,
901                                         (port->host_deviceid << 16) |
902                                         (port->sys_size << 15));
903                 }
904
905                 rio_init_em(rdev);
906
907                 /* Check for empty switch */
908                 if (next_destid == sw_destid) {
909                         next_destid++;
910                         if (next_destid == port->host_deviceid)
911                                 next_destid++;
912                 }
913
914                 rdev->destid = sw_destid;
915         } else
916                 pr_debug("RIO: found %s (vid %4.4x did %4.4x)\n",
917                     rio_name(rdev), rdev->vid, rdev->did);
918
919         return 0;
920 }
921
922 /**
923  * rio_enum_complete- Tests if enumeration of a network is complete
924  * @port: Master port to send transaction
925  *
926  * Tests the PGCCSR discovered bit for non-zero value (enumeration
927  * complete flag). Return %1 if enumeration is complete or %0 if
928  * enumeration is incomplete.
929  */
930 static int rio_enum_complete(struct rio_mport *port)
931 {
932         u32 regval;
933
934         rio_local_read_config_32(port, port->phys_efptr + RIO_PORT_GEN_CTL_CSR,
935                                  &regval);
936         return (regval & RIO_PORT_GEN_DISCOVERED) ? 1 : 0;
937 }
938
939 /**
940  * rio_disc_peer- Recursively discovers a RIO network through a master port
941  * @net: RIO network being discovered
942  * @port: Master port to send transactions
943  * @destid: Current destination ID in network
944  * @hopcount: Number of hops into the network
945  * @prev: previous rio_dev
946  * @prev_port: previous port number
947  *
948  * Recursively discovers a RIO network.  Transactions are sent via the
949  * master port passed in @port.
950  */
951 static int __devinit
952 rio_disc_peer(struct rio_net *net, struct rio_mport *port, u16 destid,
953               u8 hopcount, struct rio_dev *prev, int prev_port)
954 {
955         u8 port_num, route_port;
956         struct rio_dev *rdev;
957         u16 ndestid;
958
959         /* Setup new RIO device */
960         if ((rdev = rio_setup_device(net, port, destid, hopcount, 0))) {
961                 /* Add device to the global and bus/net specific list. */
962                 list_add_tail(&rdev->net_list, &net->devices);
963                 rdev->prev = prev;
964                 if (prev && rio_is_switch(prev))
965                         prev->rswitch->nextdev[prev_port] = rdev;
966         } else
967                 return -1;
968
969         if (rio_is_switch(rdev)) {
970                 /* Associated destid is how we accessed this switch */
971                 rdev->destid = destid;
972
973                 pr_debug(
974                     "RIO: found %s (vid %4.4x did %4.4x) with %d ports\n",
975                     rio_name(rdev), rdev->vid, rdev->did,
976                     RIO_GET_TOTAL_PORTS(rdev->swpinfo));
977                 for (port_num = 0;
978                      port_num < RIO_GET_TOTAL_PORTS(rdev->swpinfo);
979                      port_num++) {
980                         if (RIO_GET_PORT_NUM(rdev->swpinfo) == port_num)
981                                 continue;
982
983                         if (rio_sport_is_active
984                             (port, destid, hopcount, port_num)) {
985                                 pr_debug(
986                                     "RIO: scanning device on port %d\n",
987                                     port_num);
988
989                                 rio_lock_device(port, destid, hopcount, 1000);
990
991                                 for (ndestid = 0;
992                                      ndestid < RIO_ANY_DESTID(port->sys_size);
993                                      ndestid++) {
994                                         rio_route_get_entry(rdev,
995                                                             RIO_GLOBAL_TABLE,
996                                                             ndestid,
997                                                             &route_port, 0);
998                                         if (route_port == port_num)
999                                                 break;
1000                                 }
1001
1002                                 if (ndestid == RIO_ANY_DESTID(port->sys_size))
1003                                         continue;
1004                                 rio_unlock_device(port, destid, hopcount);
1005                                 if (rio_disc_peer(net, port, ndestid,
1006                                         hopcount + 1, rdev, port_num) < 0)
1007                                         return -1;
1008                         }
1009                 }
1010         } else
1011                 pr_debug("RIO: found %s (vid %4.4x did %4.4x)\n",
1012                     rio_name(rdev), rdev->vid, rdev->did);
1013
1014         return 0;
1015 }
1016
1017 /**
1018  * rio_mport_is_active- Tests if master port link is active
1019  * @port: Master port to test
1020  *
1021  * Reads the port error status CSR for the master port to
1022  * determine if the port has an active link.  Returns
1023  * %RIO_PORT_N_ERR_STS_PORT_OK if the  master port is active
1024  * or %0 if it is inactive.
1025  */
1026 static int rio_mport_is_active(struct rio_mport *port)
1027 {
1028         u32 result = 0;
1029         u32 ext_ftr_ptr;
1030         int *entry = rio_mport_phys_table;
1031
1032         do {
1033                 if ((ext_ftr_ptr =
1034                      rio_mport_get_feature(port, 1, 0, 0, *entry)))
1035                         break;
1036         } while (*++entry >= 0);
1037
1038         if (ext_ftr_ptr)
1039                 rio_local_read_config_32(port,
1040                                          ext_ftr_ptr +
1041                                          RIO_PORT_N_ERR_STS_CSR(port->index),
1042                                          &result);
1043
1044         return result & RIO_PORT_N_ERR_STS_PORT_OK;
1045 }
1046
1047 /**
1048  * rio_alloc_net- Allocate and configure a new RIO network
1049  * @port: Master port associated with the RIO network
1050  *
1051  * Allocates a RIO network structure, initializes per-network
1052  * list heads, and adds the associated master port to the
1053  * network list of associated master ports. Returns a
1054  * RIO network pointer on success or %NULL on failure.
1055  */
1056 static struct rio_net __devinit *rio_alloc_net(struct rio_mport *port)
1057 {
1058         struct rio_net *net;
1059
1060         net = kzalloc(sizeof(struct rio_net), GFP_KERNEL);
1061         if (net) {
1062                 INIT_LIST_HEAD(&net->node);
1063                 INIT_LIST_HEAD(&net->devices);
1064                 INIT_LIST_HEAD(&net->mports);
1065                 list_add_tail(&port->nnode, &net->mports);
1066                 net->hport = port;
1067                 net->id = next_net++;
1068         }
1069         return net;
1070 }
1071
1072 /**
1073  * rio_update_route_tables- Updates route tables in switches
1074  * @port: Master port associated with the RIO network
1075  *
1076  * For each enumerated device, ensure that each switch in a system
1077  * has correct routing entries. Add routes for devices that where
1078  * unknown dirung the first enumeration pass through the switch.
1079  */
1080 static void rio_update_route_tables(struct rio_mport *port)
1081 {
1082         struct rio_dev *rdev, *swrdev;
1083         struct rio_switch *rswitch;
1084         u8 sport;
1085         u16 destid;
1086
1087         list_for_each_entry(rdev, &rio_devices, global_list) {
1088
1089                 destid = rdev->destid;
1090
1091                 list_for_each_entry(rswitch, &rio_switches, node) {
1092
1093                         if (rio_is_switch(rdev) && (rdev->rswitch == rswitch))
1094                                 continue;
1095
1096                         if (RIO_INVALID_ROUTE == rswitch->route_table[destid]) {
1097                                 swrdev = sw_to_rio_dev(rswitch);
1098
1099                                 /* Skip if destid ends in empty switch*/
1100                                 if (swrdev->destid == destid)
1101                                         continue;
1102
1103                                 sport = RIO_GET_PORT_NUM(swrdev->swpinfo);
1104
1105                                 if (rswitch->add_entry) {
1106                                         rio_route_add_entry(swrdev,
1107                                                 RIO_GLOBAL_TABLE, destid,
1108                                                 sport, 0);
1109                                         rswitch->route_table[destid] = sport;
1110                                 }
1111                         }
1112                 }
1113         }
1114 }
1115
1116 /**
1117  * rio_init_em - Initializes RIO Error Management (for switches)
1118  * @rdev: RIO device
1119  *
1120  * For each enumerated switch, call device-specific error management
1121  * initialization routine (if supplied by the switch driver).
1122  */
1123 static void rio_init_em(struct rio_dev *rdev)
1124 {
1125         if (rio_is_switch(rdev) && (rdev->em_efptr) &&
1126             (rdev->rswitch->em_init)) {
1127                 rdev->rswitch->em_init(rdev);
1128         }
1129 }
1130
1131 /**
1132  * rio_pw_enable - Enables/disables port-write handling by a master port
1133  * @port: Master port associated with port-write handling
1134  * @enable:  1=enable,  0=disable
1135  */
1136 static void rio_pw_enable(struct rio_mport *port, int enable)
1137 {
1138         if (port->ops->pwenable)
1139                 port->ops->pwenable(port, enable);
1140 }
1141
1142 /**
1143  * rio_enum_mport- Start enumeration through a master port
1144  * @mport: Master port to send transactions
1145  *
1146  * Starts the enumeration process. If somebody has enumerated our
1147  * master port device, then give up. If not and we have an active
1148  * link, then start recursive peer enumeration. Returns %0 if
1149  * enumeration succeeds or %-EBUSY if enumeration fails.
1150  */
1151 int __devinit rio_enum_mport(struct rio_mport *mport)
1152 {
1153         struct rio_net *net = NULL;
1154         int rc = 0;
1155
1156         printk(KERN_INFO "RIO: enumerate master port %d, %s\n", mport->id,
1157                mport->name);
1158         /* If somebody else enumerated our master port device, bail. */
1159         if (rio_enum_host(mport) < 0) {
1160                 printk(KERN_INFO
1161                        "RIO: master port %d device has been enumerated by a remote host\n",
1162                        mport->id);
1163                 rc = -EBUSY;
1164                 goto out;
1165         }
1166
1167         /* If master port has an active link, allocate net and enum peers */
1168         if (rio_mport_is_active(mport)) {
1169                 if (!(net = rio_alloc_net(mport))) {
1170                         printk(KERN_ERR "RIO: failed to allocate new net\n");
1171                         rc = -ENOMEM;
1172                         goto out;
1173                 }
1174
1175                 /* Enable Input Output Port (transmitter reviever) */
1176                 rio_enable_rx_tx_port(mport, 1, 0, 0, 0);
1177
1178                 /* Set component tag for host */
1179                 rio_local_write_config_32(mport, RIO_COMPONENT_TAG_CSR,
1180                                           next_comptag++);
1181
1182                 if (rio_enum_peer(net, mport, 0, NULL, 0) < 0) {
1183                         /* A higher priority host won enumeration, bail. */
1184                         printk(KERN_INFO
1185                                "RIO: master port %d device has lost enumeration to a remote host\n",
1186                                mport->id);
1187                         rio_clear_locks(mport);
1188                         rc = -EBUSY;
1189                         goto out;
1190                 }
1191                 rio_update_route_tables(mport);
1192                 rio_clear_locks(mport);
1193                 rio_pw_enable(mport, 1);
1194         } else {
1195                 printk(KERN_INFO "RIO: master port %d link inactive\n",
1196                        mport->id);
1197                 rc = -EINVAL;
1198         }
1199
1200       out:
1201         return rc;
1202 }
1203
1204 /**
1205  * rio_build_route_tables- Generate route tables from switch route entries
1206  *
1207  * For each switch device, generate a route table by copying existing
1208  * route entries from the switch.
1209  */
1210 static void rio_build_route_tables(void)
1211 {
1212         struct rio_dev *rdev;
1213         int i;
1214         u8 sport;
1215
1216         list_for_each_entry(rdev, &rio_devices, global_list)
1217                 if (rio_is_switch(rdev)) {
1218                         rio_lock_device(rdev->net->hport, rdev->destid,
1219                                         rdev->hopcount, 1000);
1220                         for (i = 0;
1221                              i < RIO_MAX_ROUTE_ENTRIES(rdev->net->hport->sys_size);
1222                              i++) {
1223                                 if (rio_route_get_entry(rdev,
1224                                         RIO_GLOBAL_TABLE, i, &sport, 0) < 0)
1225                                         continue;
1226                                 rdev->rswitch->route_table[i] = sport;
1227                         }
1228
1229                         rio_unlock_device(rdev->net->hport,
1230                                           rdev->destid,
1231                                           rdev->hopcount);
1232                 }
1233 }
1234
1235 /**
1236  * rio_enum_timeout- Signal that enumeration timed out
1237  * @data: Address of timeout flag.
1238  *
1239  * When the enumeration complete timer expires, set a flag that
1240  * signals to the discovery process that enumeration did not
1241  * complete in a sane amount of time.
1242  */
1243 static void rio_enum_timeout(unsigned long data)
1244 {
1245         /* Enumeration timed out, set flag */
1246         *(int *)data = 1;
1247 }
1248
1249 /**
1250  * rio_disc_mport- Start discovery through a master port
1251  * @mport: Master port to send transactions
1252  *
1253  * Starts the discovery process. If we have an active link,
1254  * then wait for the signal that enumeration is complete.
1255  * When enumeration completion is signaled, start recursive
1256  * peer discovery. Returns %0 if discovery succeeds or %-EBUSY
1257  * on failure.
1258  */
1259 int __devinit rio_disc_mport(struct rio_mport *mport)
1260 {
1261         struct rio_net *net = NULL;
1262         int enum_timeout_flag = 0;
1263
1264         printk(KERN_INFO "RIO: discover master port %d, %s\n", mport->id,
1265                mport->name);
1266
1267         /* If master port has an active link, allocate net and discover peers */
1268         if (rio_mport_is_active(mport)) {
1269                 if (!(net = rio_alloc_net(mport))) {
1270                         printk(KERN_ERR "RIO: Failed to allocate new net\n");
1271                         goto bail;
1272                 }
1273
1274                 pr_debug("RIO: wait for enumeration complete...");
1275
1276                 rio_enum_timer.expires =
1277                     jiffies + CONFIG_RAPIDIO_DISC_TIMEOUT * HZ;
1278                 rio_enum_timer.data = (unsigned long)&enum_timeout_flag;
1279                 add_timer(&rio_enum_timer);
1280                 while (!rio_enum_complete(mport)) {
1281                         mdelay(1);
1282                         if (enum_timeout_flag) {
1283                                 del_timer_sync(&rio_enum_timer);
1284                                 goto timeout;
1285                         }
1286                 }
1287                 del_timer_sync(&rio_enum_timer);
1288
1289                 pr_debug("done\n");
1290
1291                 /* Read DestID assigned by enumerator */
1292                 rio_local_read_config_32(mport, RIO_DID_CSR,
1293                                          &mport->host_deviceid);
1294                 mport->host_deviceid = RIO_GET_DID(mport->sys_size,
1295                                                    mport->host_deviceid);
1296
1297                 if (rio_disc_peer(net, mport, RIO_ANY_DESTID(mport->sys_size),
1298                                         0, NULL, 0) < 0) {
1299                         printk(KERN_INFO
1300                                "RIO: master port %d device has failed discovery\n",
1301                                mport->id);
1302                         goto bail;
1303                 }
1304
1305                 rio_build_route_tables();
1306         }
1307
1308         return 0;
1309
1310       timeout:
1311         pr_debug("timeout\n");
1312       bail:
1313         return -EBUSY;
1314 }