blob: 0854fe2bc11085943d0b7edcdef5884d8996c60c [file] [log] [blame]
Kristian Høgsbergc781c062007-05-07 20:33:32 -04001/*
Kristian Høgsberg19a15b92006-12-19 19:58:31 -05002 * 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 Richter641f8792007-01-27 10:34:55 +010024#include <asm/atomic.h>
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050025
26enum fw_device_state {
27 FW_DEVICE_INITIALIZING,
28 FW_DEVICE_RUNNING,
Stefan Richter5af4e5e2007-01-21 20:45:32 +010029 FW_DEVICE_SHUTDOWN,
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050030};
31
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -040032struct fw_attribute_group {
33 struct attribute_group *groups[2];
34 struct attribute_group group;
35 struct attribute *attrs[11];
36};
37
Stefan Richterb5d2a5e2008-01-25 18:57:41 +010038/*
39 * Note, fw_device.generation always has to be read before fw_device.node_id.
40 * Use SMP memory barriers to ensure this. Otherwise requests will be sent
41 * to an outdated node_id if the generation was updated in the meantime due
42 * to a bus reset.
43 *
44 * Likewise, fw-core will take care to update .node_id before .generation so
45 * that whenever fw_device.generation is current WRT the actual bus generation,
46 * fw_device.node_id is guaranteed to be current too.
47 *
48 * The same applies to fw_device.card->node_id vs. fw_device.generation.
49 */
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050050struct fw_device {
Stefan Richter641f8792007-01-27 10:34:55 +010051 atomic_t state;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050052 struct fw_node *node;
53 int node_id;
54 int generation;
Stefan Richterf1397492007-06-10 21:31:36 +020055 unsigned max_speed;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050056 struct fw_card *card;
57 struct device device;
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -050058 struct list_head link;
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -050059 struct list_head client_list;
Stefan Richter945ac222007-03-20 19:44:26 +010060 u32 *config_rom;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050061 size_t config_rom_length;
62 int config_rom_retries;
63 struct delayed_work work;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -040064 struct fw_attribute_group attribute_group;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050065};
66
67static inline struct fw_device *
68fw_device(struct device *dev)
69{
Stefan Richter5e20c282007-01-21 20:44:09 +010070 return container_of(dev, struct fw_device, device);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050071}
72
Kristian Høgsberg2603bf22007-03-07 12:12:48 -050073static inline int
74fw_device_is_shutdown(struct fw_device *device)
75{
76 return atomic_read(&device->state) == FW_DEVICE_SHUTDOWN;
77}
78
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050079struct fw_device *fw_device_get(struct fw_device *device);
80void fw_device_put(struct fw_device *device);
81int fw_device_enable_phys_dma(struct fw_device *device);
82
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -050083void fw_device_cdev_update(struct fw_device *device);
Kristian Høgsberg2603bf22007-03-07 12:12:48 -050084void fw_device_cdev_remove(struct fw_device *device);
Kristian Høgsberg97bd9ef2007-03-07 12:12:41 -050085
Kristian Høgsberga3aca3d2007-03-07 12:12:44 -050086struct fw_device *fw_device_from_devt(dev_t devt);
87extern int fw_cdev_major;
88
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050089struct fw_unit {
90 struct device device;
91 u32 *directory;
Kristian Høgsberg6f2e53d2007-03-27 19:35:13 -040092 struct fw_attribute_group attribute_group;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050093};
94
95static inline struct fw_unit *
96fw_unit(struct device *dev)
97{
Stefan Richter5e20c282007-01-21 20:44:09 +010098 return container_of(dev, struct fw_unit, device);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -050099}
100
101#define CSR_OFFSET 0x40
102#define CSR_LEAF 0x80
103#define CSR_DIRECTORY 0xc0
104
105#define CSR_DESCRIPTOR 0x01
106#define CSR_VENDOR 0x03
107#define CSR_HARDWARE_VERSION 0x04
108#define CSR_NODE_CAPABILITIES 0x0c
109#define CSR_UNIT 0x11
110#define CSR_SPECIFIER_ID 0x12
111#define CSR_VERSION 0x13
112#define CSR_DEPENDENT_INFO 0x14
113#define CSR_MODEL 0x17
114#define CSR_INSTANCE 0x18
Stefan Richter14e21982007-05-27 13:18:27 +0200115#define CSR_DIRECTORY_ID 0x20
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500116
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500117struct fw_csr_iterator {
118 u32 *p;
119 u32 *end;
120};
121
122void fw_csr_iterator_init(struct fw_csr_iterator *ci, u32 *p);
123int fw_csr_iterator_next(struct fw_csr_iterator *ci,
124 int *key, int *value);
125
126#define FW_MATCH_VENDOR 0x0001
127#define FW_MATCH_MODEL 0x0002
128#define FW_MATCH_SPECIFIER_ID 0x0004
129#define FW_MATCH_VERSION 0x0008
130
131struct fw_device_id {
132 u32 match_flags;
133 u32 vendor;
134 u32 model;
135 u32 specifier_id;
136 u32 version;
137 void *driver_data;
138};
139
140struct fw_driver {
141 struct device_driver driver;
142 /* Called when the parent device sits through a bus reset. */
143 void (*update) (struct fw_unit *unit);
Stefan Richter21ebcd12007-01-14 15:29:07 +0100144 const struct fw_device_id *id_table;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500145};
146
147static inline struct fw_driver *
148fw_driver(struct device_driver *drv)
149{
Stefan Richter5e20c282007-01-21 20:44:09 +0100150 return container_of(drv, struct fw_driver, driver);
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500151}
152
Stefan Richter21ebcd12007-01-14 15:29:07 +0100153extern const struct file_operations fw_device_ops;
Kristian Høgsberg19a15b92006-12-19 19:58:31 -0500154
Stefan Richter687198b2006-12-28 16:20:00 +0100155#endif /* __fw_device_h */