home *** CD-ROM | disk | FTP | other *** search
/ PC Welt 2006 November (DVD) / PCWELT_11_2006.ISO / casper / filesystem.squashfs / usr / src / linux-headers-2.6.17-6 / include / asm-ppc / ocp.h < prev    next >
Encoding:
C/C++ Source or Header  |  2006-08-11  |  6.8 KB  |  207 lines

  1. /*
  2.  * ocp.h
  3.  *
  4.  *      (c) Benjamin Herrenschmidt (benh@kernel.crashing.org)
  5.  *          Mipsys - France
  6.  *
  7.  *          Derived from work (c) Armin Kuster akuster@pacbell.net
  8.  *
  9.  *          Additional support and port to 2.6 LDM/sysfs by
  10.  *          Matt Porter <mporter@kernel.crashing.org>
  11.  *          Copyright 2003-2004 MontaVista Software, Inc.
  12.  *
  13.  * This program is free software; you can redistribute  it and/or modify it
  14.  * under  the terms of  the GNU General  Public License as published by the
  15.  * Free Software Foundation;  either version 2 of the  License, or (at your
  16.  * option) any later version.
  17.  *
  18.  *  TODO: - Add get/put interface & fixup locking to provide same API for
  19.  *          2.4 and 2.5
  20.  *      - Rework PM callbacks
  21.  */
  22.  
  23. #ifdef __KERNEL__
  24. #ifndef __OCP_H__
  25. #define __OCP_H__
  26.  
  27. #include <linux/init.h>
  28. #include <linux/list.h>
  29. #include <linux/devfs_fs_kernel.h>
  30. #include <linux/device.h>
  31.  
  32. #include <asm/mmu.h>
  33. #include <asm/ocp_ids.h>
  34. #include <asm/rwsem.h>
  35. #include <asm/semaphore.h>
  36.  
  37. #ifdef CONFIG_PPC_OCP
  38.  
  39. #define OCP_MAX_IRQS    7
  40. #define MAX_EMACS    4
  41. #define OCP_IRQ_NA    -1    /* used when ocp device does not have an irq */
  42. #define OCP_IRQ_MUL    -2    /* used for ocp devices with multiply irqs */
  43. #define OCP_NULL_TYPE    -1    /* used to mark end of list */
  44. #define OCP_CPM_NA    0    /* No Clock or Power Management avaliable */
  45. #define OCP_PADDR_NA    0    /* No MMIO registers */
  46.  
  47. #define OCP_ANY_ID    (~0)
  48. #define OCP_ANY_INDEX    -1
  49.  
  50. extern struct list_head     ocp_devices;
  51. extern struct rw_semaphore    ocp_devices_sem;
  52.  
  53. struct ocp_device_id {
  54.     unsigned int    vendor, function;    /* Vendor and function ID or OCP_ANY_ID */
  55.     unsigned long    driver_data;        /* Data private to the driver */
  56. };
  57.  
  58.  
  59. /*
  60.  * Static definition of an OCP device.
  61.  *
  62.  * @vendor:    Vendor code. It is _STRONGLY_ discouraged to use
  63.  *             the vendor code as a way to match a unique device,
  64.  *             though I kept that possibility open, you should
  65.  *             really define different function codes for different
  66.  *             device types
  67.  * @function:  This is the function code for this device.
  68.  * @index:     This index is used for mapping the Nth function of a
  69.  *             given core. This is typically used for cross-driver
  70.  *             matching, like looking for a given MAL or ZMII from
  71.  *             an EMAC or for getting to the proper set of DCRs.
  72.  *             Indices are no longer magically calculated based on
  73.  *             structure ordering, they have to be actually coded
  74.  *             into the ocp_def to avoid any possible confusion
  75.  *             I _STRONGLY_ (again ? wow !) encourage anybody relying
  76.  *             on index mapping to encode the "target" index in an
  77.  *             associated structure pointed to by "additions", see
  78.  *             how it's done for the EMAC driver.
  79.  * @paddr:     Device physical address (may not mean anything...)
  80.  * @irq:       Interrupt line for this device (TODO: think about making
  81.  *             an array with this)
  82.  * @pm:        Currently, contains the bitmask in CPMFR DCR for the device
  83.  * @additions: Optionally points to a function specific structure
  84.  *             providing additional informations for a given device
  85.  *             instance. It's currently used by the EMAC driver for MAL
  86.  *             channel & ZMII port mapping among others.
  87.  * @show:      Optionally points to a function specific structure
  88.  *             providing a sysfs show routine for additions fields.
  89.  */
  90. struct ocp_def {
  91.     unsigned int    vendor;
  92.     unsigned int    function;
  93.     int        index;
  94.     phys_addr_t    paddr;
  95.     int          irq;
  96.     unsigned long    pm;
  97.     void        *additions;
  98.     void        (*show)(struct device *);
  99. };
  100.  
  101.  
  102. /* Struct for a given device instance */
  103. struct ocp_device {
  104.     struct list_head    link;
  105.     char            name[80];    /* device name */
  106.     struct ocp_def        *def;        /* device definition */
  107.     void            *drvdata;    /* driver data for this device */
  108.     struct ocp_driver    *driver;
  109.     u32            current_state;    /* Current operating state. In ACPI-speak,
  110.                            this is D0-D3, D0 being fully functional,
  111.                            and D3 being off. */
  112.     struct            device dev;
  113. };
  114.  
  115. struct ocp_driver {
  116.     struct list_head node;
  117.     char *name;
  118.     const struct ocp_device_id *id_table;    /* NULL if wants all devices */
  119.     int  (*probe)  (struct ocp_device *dev);    /* New device inserted */
  120.     void (*remove) (struct ocp_device *dev);    /* Device removed (NULL if not a hot-plug capable driver) */
  121.     int  (*suspend) (struct ocp_device *dev, pm_message_t state);    /* Device suspended */
  122.     int  (*resume) (struct ocp_device *dev);                    /* Device woken up */
  123.     struct device_driver driver;
  124. };
  125.  
  126. #define to_ocp_dev(n) container_of(n, struct ocp_device, dev)
  127. #define to_ocp_drv(n) container_of(n, struct ocp_driver, driver)
  128.  
  129. /* Similar to the helpers above, these manipulate per-ocp_dev
  130.  * driver-specific data.  Currently stored as ocp_dev::ocpdev,
  131.  * a void pointer, but it is not present on older kernels.
  132.  */
  133. static inline void *
  134. ocp_get_drvdata(struct ocp_device *pdev)
  135. {
  136.     return pdev->drvdata;
  137. }
  138.  
  139. static inline void
  140. ocp_set_drvdata(struct ocp_device *pdev, void *data)
  141. {
  142.     pdev->drvdata = data;
  143. }
  144.  
  145. #if defined (CONFIG_PM)
  146. /*
  147.  * This is right for the IBM 405 and 440 but will need to be
  148.  * generalized if the OCP stuff gets used on other processors.
  149.  */
  150. static inline void
  151. ocp_force_power_off(struct ocp_device *odev)
  152. {
  153.     mtdcr(DCRN_CPMFR, mfdcr(DCRN_CPMFR) | odev->def->pm);
  154. }
  155.  
  156. static inline void
  157. ocp_force_power_on(struct ocp_device *odev)
  158. {
  159.     mtdcr(DCRN_CPMFR, mfdcr(DCRN_CPMFR) & ~odev->def->pm);
  160. }
  161. #else
  162. #define ocp_force_power_off(x)    (void)(x)
  163. #define ocp_force_power_on(x)    (void)(x)
  164. #endif
  165.  
  166. /* Register/Unregister an OCP driver */
  167. extern int ocp_register_driver(struct ocp_driver *drv);
  168. extern void ocp_unregister_driver(struct ocp_driver *drv);
  169.  
  170. /* Build list of devices */
  171. extern int ocp_early_init(void) __init;
  172.  
  173. /* Find a device by index */
  174. extern struct ocp_device *ocp_find_device(unsigned int vendor, unsigned int function, int index);
  175.  
  176. /* Get a def by index */
  177. extern struct ocp_def *ocp_get_one_device(unsigned int vendor, unsigned int function, int index);
  178.  
  179. /* Add a device by index */
  180. extern int ocp_add_one_device(struct ocp_def *def);
  181.  
  182. /* Remove a device by index */
  183. extern int ocp_remove_one_device(unsigned int vendor, unsigned int function, int index);
  184.  
  185. /* Iterate over devices and execute a routine */
  186. extern void ocp_for_each_device(void(*callback)(struct ocp_device *, void *arg), void *arg);
  187.  
  188. /* Sysfs support */
  189. #define OCP_SYSFS_ADDTL(type, format, name, field)            \
  190. static ssize_t                                \
  191. show_##name##_##field(struct device *dev, struct device_attribute *attr, char *buf)            \
  192. {                                    \
  193.     struct ocp_device *odev = to_ocp_dev(dev);            \
  194.     type *add = odev->def->additions;                \
  195.                                     \
  196.     return sprintf(buf, format, add->field);            \
  197. }                                    \
  198. static DEVICE_ATTR(name##_##field, S_IRUGO, show_##name##_##field, NULL);
  199.  
  200. #ifdef CONFIG_IBM_OCP
  201. #include <asm/ibm_ocp.h>
  202. #endif
  203.  
  204. #endif                /* CONFIG_PPC_OCP */
  205. #endif                /* __OCP_H__ */
  206. #endif                /* __KERNEL__ */
  207.