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