Kristian Høgsberg | c781c06 | 2007-05-07 20:33:32 -0400 | [diff] [blame] | 1 | /* |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 2 | * Copyright (C) 2005-2006 Kristian Hoegsberg <krh@bitplanet.net> |
| 3 | * |
| 4 | * This program is free software; you can redistribute it and/or modify |
| 5 | * it under the terms of the GNU General Public License as published by |
| 6 | * the Free Software Foundation; either version 2 of the License, or |
| 7 | * (at your option) any later version. |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software Foundation, |
| 16 | * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 17 | */ |
| 18 | |
| 19 | #ifndef __fw_device_h |
| 20 | #define __fw_device_h |
| 21 | |
| 22 | #include <linux/fs.h> |
| 23 | #include <linux/cdev.h> |
Stefan Richter | d6053e0 | 2008-11-24 20:40:00 +0100 | [diff] [blame] | 24 | #include <linux/idr.h> |
Stefan Richter | c9755e1 | 2008-03-24 20:54:28 +0100 | [diff] [blame] | 25 | #include <linux/rwsem.h> |
Stefan Richter | d67cfb9 | 2008-10-05 10:37:11 +0200 | [diff] [blame] | 26 | #include <linux/mutex.h> |
Stefan Richter | 641f879 | 2007-01-27 10:34:55 +0100 | [diff] [blame] | 27 | #include <asm/atomic.h> |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 28 | |
| 29 | enum fw_device_state { |
| 30 | FW_DEVICE_INITIALIZING, |
| 31 | FW_DEVICE_RUNNING, |
Stefan Richter | 3d36a0d | 2009-01-17 22:45:54 +0100 | [diff] [blame] | 32 | FW_DEVICE_GONE, |
Stefan Richter | 5af4e5e | 2007-01-21 20:45:32 +0100 | [diff] [blame] | 33 | FW_DEVICE_SHUTDOWN, |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 34 | }; |
| 35 | |
Kristian Høgsberg | 6f2e53d | 2007-03-27 19:35:13 -0400 | [diff] [blame] | 36 | struct fw_attribute_group { |
| 37 | struct attribute_group *groups[2]; |
| 38 | struct attribute_group group; |
| 39 | struct attribute *attrs[11]; |
| 40 | }; |
| 41 | |
Stefan Richter | b5d2a5e | 2008-01-25 18:57:41 +0100 | [diff] [blame] | 42 | /* |
| 43 | * Note, fw_device.generation always has to be read before fw_device.node_id. |
| 44 | * Use SMP memory barriers to ensure this. Otherwise requests will be sent |
| 45 | * to an outdated node_id if the generation was updated in the meantime due |
| 46 | * to a bus reset. |
| 47 | * |
| 48 | * Likewise, fw-core will take care to update .node_id before .generation so |
| 49 | * that whenever fw_device.generation is current WRT the actual bus generation, |
| 50 | * fw_device.node_id is guaranteed to be current too. |
| 51 | * |
| 52 | * The same applies to fw_device.card->node_id vs. fw_device.generation. |
Stefan Richter | c9755e1 | 2008-03-24 20:54:28 +0100 | [diff] [blame] | 53 | * |
| 54 | * fw_device.config_rom and fw_device.config_rom_length may be accessed during |
| 55 | * the lifetime of any fw_unit belonging to the fw_device, before device_del() |
| 56 | * was called on the last fw_unit. Alternatively, they may be accessed while |
| 57 | * holding fw_device_rwsem. |
Stefan Richter | b5d2a5e | 2008-01-25 18:57:41 +0100 | [diff] [blame] | 58 | */ |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 59 | struct fw_device { |
Stefan Richter | 641f879 | 2007-01-27 10:34:55 +0100 | [diff] [blame] | 60 | atomic_t state; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 61 | struct fw_node *node; |
| 62 | int node_id; |
| 63 | int generation; |
Stefan Richter | f139749 | 2007-06-10 21:31:36 +0200 | [diff] [blame] | 64 | unsigned max_speed; |
Stefan Richter | c9755e1 | 2008-03-24 20:54:28 +0100 | [diff] [blame] | 65 | bool cmc; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 66 | struct fw_card *card; |
| 67 | struct device device; |
Stefan Richter | d67cfb9 | 2008-10-05 10:37:11 +0200 | [diff] [blame] | 68 | |
| 69 | struct mutex client_list_mutex; |
Kristian Høgsberg | 97bd9ef | 2007-03-07 12:12:41 -0500 | [diff] [blame] | 70 | struct list_head client_list; |
Stefan Richter | d67cfb9 | 2008-10-05 10:37:11 +0200 | [diff] [blame] | 71 | |
Stefan Richter | 945ac22 | 2007-03-20 19:44:26 +0100 | [diff] [blame] | 72 | u32 *config_rom; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 73 | size_t config_rom_length; |
| 74 | int config_rom_retries; |
| 75 | struct delayed_work work; |
Kristian Høgsberg | 6f2e53d | 2007-03-27 19:35:13 -0400 | [diff] [blame] | 76 | struct fw_attribute_group attribute_group; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 77 | }; |
| 78 | |
Stefan Richter | 1dc3bea | 2008-02-24 19:01:21 +0100 | [diff] [blame] | 79 | static inline struct fw_device *fw_device(struct device *dev) |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 80 | { |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 81 | return container_of(dev, struct fw_device, device); |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 82 | } |
| 83 | |
Stefan Richter | 1dc3bea | 2008-02-24 19:01:21 +0100 | [diff] [blame] | 84 | static inline int fw_device_is_shutdown(struct fw_device *device) |
Kristian Høgsberg | 2603bf2 | 2007-03-07 12:12:48 -0500 | [diff] [blame] | 85 | { |
| 86 | return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN; |
| 87 | } |
| 88 | |
Stefan Richter | 1dc3bea | 2008-02-24 19:01:21 +0100 | [diff] [blame] | 89 | static inline struct fw_device *fw_device_get(struct fw_device *device) |
Stefan Richter | 855c603 | 2008-02-27 22:14:27 +0100 | [diff] [blame] | 90 | { |
| 91 | get_device(&device->device); |
| 92 | |
| 93 | return device; |
| 94 | } |
| 95 | |
Stefan Richter | 1dc3bea | 2008-02-24 19:01:21 +0100 | [diff] [blame] | 96 | static inline void fw_device_put(struct fw_device *device) |
Stefan Richter | 855c603 | 2008-02-27 22:14:27 +0100 | [diff] [blame] | 97 | { |
| 98 | put_device(&device->device); |
| 99 | } |
| 100 | |
Stefan Richter | 96b1906 | 2008-02-02 15:01:09 +0100 | [diff] [blame] | 101 | struct fw_device *fw_device_get_by_devt(dev_t devt); |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 102 | int fw_device_enable_phys_dma(struct fw_device *device); |
| 103 | |
Kristian Høgsberg | 97bd9ef | 2007-03-07 12:12:41 -0500 | [diff] [blame] | 104 | void fw_device_cdev_update(struct fw_device *device); |
Kristian Høgsberg | 2603bf2 | 2007-03-07 12:12:48 -0500 | [diff] [blame] | 105 | void fw_device_cdev_remove(struct fw_device *device); |
Kristian Høgsberg | 97bd9ef | 2007-03-07 12:12:41 -0500 | [diff] [blame] | 106 | |
Stefan Richter | c9755e1 | 2008-03-24 20:54:28 +0100 | [diff] [blame] | 107 | extern struct rw_semaphore fw_device_rwsem; |
Stefan Richter | d6053e0 | 2008-11-24 20:40:00 +0100 | [diff] [blame] | 108 | extern struct idr fw_device_idr; |
Kristian Høgsberg | a3aca3d | 2007-03-07 12:12:44 -0500 | [diff] [blame] | 109 | extern int fw_cdev_major; |
| 110 | |
Stefan Richter | c9755e1 | 2008-03-24 20:54:28 +0100 | [diff] [blame] | 111 | /* |
| 112 | * fw_unit.directory must not be accessed after device_del(&fw_unit.device). |
| 113 | */ |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 114 | struct fw_unit { |
| 115 | struct device device; |
| 116 | u32 *directory; |
Kristian Høgsberg | 6f2e53d | 2007-03-27 19:35:13 -0400 | [diff] [blame] | 117 | struct fw_attribute_group attribute_group; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 118 | }; |
| 119 | |
Stefan Richter | 1dc3bea | 2008-02-24 19:01:21 +0100 | [diff] [blame] | 120 | static inline struct fw_unit *fw_unit(struct device *dev) |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 121 | { |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 122 | return container_of(dev, struct fw_unit, device); |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 123 | } |
| 124 | |
Stefan Richter | 1dc3bea | 2008-02-24 19:01:21 +0100 | [diff] [blame] | 125 | static inline struct fw_unit *fw_unit_get(struct fw_unit *unit) |
| 126 | { |
| 127 | get_device(&unit->device); |
| 128 | |
| 129 | return unit; |
| 130 | } |
| 131 | |
| 132 | static inline void fw_unit_put(struct fw_unit *unit) |
| 133 | { |
| 134 | put_device(&unit->device); |
| 135 | } |
| 136 | |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 137 | #define CSR_OFFSET 0x40 |
| 138 | #define CSR_LEAF 0x80 |
| 139 | #define CSR_DIRECTORY 0xc0 |
| 140 | |
| 141 | #define CSR_DESCRIPTOR 0x01 |
| 142 | #define CSR_VENDOR 0x03 |
| 143 | #define CSR_HARDWARE_VERSION 0x04 |
| 144 | #define CSR_NODE_CAPABILITIES 0x0c |
| 145 | #define CSR_UNIT 0x11 |
| 146 | #define CSR_SPECIFIER_ID 0x12 |
| 147 | #define CSR_VERSION 0x13 |
| 148 | #define CSR_DEPENDENT_INFO 0x14 |
| 149 | #define CSR_MODEL 0x17 |
| 150 | #define CSR_INSTANCE 0x18 |
Stefan Richter | 14e2198 | 2007-05-27 13:18:27 +0200 | [diff] [blame] | 151 | #define CSR_DIRECTORY_ID 0x20 |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 152 | |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 153 | struct fw_csr_iterator { |
| 154 | u32 *p; |
| 155 | u32 *end; |
| 156 | }; |
| 157 | |
| 158 | void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p); |
| 159 | int fw_csr_iterator_next(struct fw_csr_iterator *ci, |
| 160 | int *key, int *value); |
| 161 | |
| 162 | #define FW_MATCH_VENDOR 0x0001 |
| 163 | #define FW_MATCH_MODEL 0x0002 |
| 164 | #define FW_MATCH_SPECIFIER_ID 0x0004 |
| 165 | #define FW_MATCH_VERSION 0x0008 |
| 166 | |
| 167 | struct fw_device_id { |
| 168 | u32 match_flags; |
| 169 | u32 vendor; |
| 170 | u32 model; |
| 171 | u32 specifier_id; |
| 172 | u32 version; |
| 173 | void *driver_data; |
| 174 | }; |
| 175 | |
| 176 | struct fw_driver { |
| 177 | struct device_driver driver; |
| 178 | /* Called when the parent device sits through a bus reset. */ |
| 179 | void (*update) (struct fw_unit *unit); |
Stefan Richter | 21ebcd1 | 2007-01-14 15:29:07 +0100 | [diff] [blame] | 180 | const struct fw_device_id *id_table; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 181 | }; |
| 182 | |
Stefan Richter | 53dca51 | 2008-12-14 21:47:04 +0100 | [diff] [blame^] | 183 | static inline struct fw_driver *fw_driver(struct device_driver *drv) |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 184 | { |
Stefan Richter | 5e20c28 | 2007-01-21 20:44:09 +0100 | [diff] [blame] | 185 | return container_of(drv, struct fw_driver, driver); |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 186 | } |
| 187 | |
Stefan Richter | 21ebcd1 | 2007-01-14 15:29:07 +0100 | [diff] [blame] | 188 | extern const struct file_operations fw_device_ops; |
Kristian Høgsberg | 19a15b9 | 2006-12-19 19:58:31 -0500 | [diff] [blame] | 189 | |
Stefan Richter | 687198b | 2006-12-28 16:20:00 +0100 | [diff] [blame] | 190 | #endif /* __fw_device_h */ |