Merge branch 'merge' of git://git.kernel.org/pub/scm/linux/kernel/git/benh/powerpc
[linux-2.6] / arch / powerpc / platforms / ps3 / platform.h
1 /*
2  *  PS3 platform declarations.
3  *
4  *  Copyright (C) 2006 Sony Computer Entertainment Inc.
5  *  Copyright 2006 Sony Corp.
6  *
7  *  This program is free software; you can redistribute it and/or modify
8  *  it under the terms of the GNU General Public License as published by
9  *  the Free Software Foundation; version 2 of the License.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  */
20
21 #if !defined(_PS3_PLATFORM_H)
22 #define _PS3_PLATFORM_H
23
24 #include <linux/rtc.h>
25 #include <scsi/scsi.h>
26
27 #include <asm/ps3.h>
28
29 /* htab */
30
31 void __init ps3_hpte_init(unsigned long htab_size);
32 void __init ps3_map_htab(void);
33
34 /* mm */
35
36 void __init ps3_mm_init(void);
37 void __init ps3_mm_vas_create(unsigned long* htab_size);
38 void ps3_mm_vas_destroy(void);
39 void ps3_mm_shutdown(void);
40
41 /* irq */
42
43 void ps3_init_IRQ(void);
44 void ps3_shutdown_IRQ(int cpu);
45 void __init ps3_register_ipi_debug_brk(unsigned int cpu, unsigned int virq);
46
47 /* smp */
48
49 void smp_init_ps3(void);
50 #ifdef CONFIG_SMP
51 void ps3_smp_cleanup_cpu(int cpu);
52 #else
53 static inline void ps3_smp_cleanup_cpu(int cpu) { }
54 #endif
55
56 /* time */
57
58 void __init ps3_calibrate_decr(void);
59 unsigned long __init ps3_get_boot_time(void);
60 void ps3_get_rtc_time(struct rtc_time *time);
61 int ps3_set_rtc_time(struct rtc_time *time);
62
63 /* os area */
64
65 void __init ps3_os_area_save_params(void);
66 void __init ps3_os_area_init(void);
67 u64 ps3_os_area_get_rtc_diff(void);
68 void ps3_os_area_set_rtc_diff(u64 rtc_diff);
69
70 /* spu */
71
72 #if defined(CONFIG_SPU_BASE)
73 void ps3_spu_set_platform (void);
74 #else
75 static inline void ps3_spu_set_platform (void) {}
76 #endif
77
78 /* repository bus info */
79
80 enum ps3_bus_type {
81         PS3_BUS_TYPE_SB = 4,
82         PS3_BUS_TYPE_STORAGE = 5,
83 };
84
85 enum ps3_dev_type {
86         PS3_DEV_TYPE_STOR_DISK = TYPE_DISK,     /* 0 */
87         PS3_DEV_TYPE_SB_GELIC = 3,
88         PS3_DEV_TYPE_SB_USB = 4,
89         PS3_DEV_TYPE_STOR_ROM = TYPE_ROM,       /* 5 */
90         PS3_DEV_TYPE_SB_GPIO = 6,
91         PS3_DEV_TYPE_STOR_FLASH = TYPE_RBC,     /* 14 */
92 };
93
94 int ps3_repository_read_bus_str(unsigned int bus_index, const char *bus_str,
95         u64 *value);
96 int ps3_repository_read_bus_id(unsigned int bus_index, u64 *bus_id);
97 int ps3_repository_read_bus_type(unsigned int bus_index,
98         enum ps3_bus_type *bus_type);
99 int ps3_repository_read_bus_num_dev(unsigned int bus_index,
100         unsigned int *num_dev);
101
102 /* repository bus device info */
103
104 enum ps3_interrupt_type {
105         PS3_INTERRUPT_TYPE_EVENT_PORT = 2,
106         PS3_INTERRUPT_TYPE_SB_OHCI = 3,
107         PS3_INTERRUPT_TYPE_SB_EHCI = 4,
108         PS3_INTERRUPT_TYPE_OTHER = 5,
109 };
110
111 enum ps3_reg_type {
112         PS3_REG_TYPE_SB_OHCI = 3,
113         PS3_REG_TYPE_SB_EHCI = 4,
114         PS3_REG_TYPE_SB_GPIO = 5,
115 };
116
117 int ps3_repository_read_dev_str(unsigned int bus_index,
118         unsigned int dev_index, const char *dev_str, u64 *value);
119 int ps3_repository_read_dev_id(unsigned int bus_index, unsigned int dev_index,
120         u64 *dev_id);
121 int ps3_repository_read_dev_type(unsigned int bus_index,
122         unsigned int dev_index, enum ps3_dev_type *dev_type);
123 int ps3_repository_read_dev_intr(unsigned int bus_index,
124         unsigned int dev_index, unsigned int intr_index,
125         enum ps3_interrupt_type *intr_type, unsigned int *interrupt_id);
126 int ps3_repository_read_dev_reg_type(unsigned int bus_index,
127         unsigned int dev_index, unsigned int reg_index,
128         enum ps3_reg_type *reg_type);
129 int ps3_repository_read_dev_reg_addr(unsigned int bus_index,
130         unsigned int dev_index, unsigned int reg_index, u64 *bus_addr,
131         u64 *len);
132 int ps3_repository_read_dev_reg(unsigned int bus_index,
133         unsigned int dev_index, unsigned int reg_index,
134         enum ps3_reg_type *reg_type, u64 *bus_addr, u64 *len);
135
136 /* repository bus enumerators */
137
138 struct ps3_repository_device {
139         unsigned int bus_index;
140         unsigned int dev_index;
141         enum ps3_bus_type bus_type;
142         enum ps3_dev_type dev_type;
143         u64 bus_id;
144         u64 dev_id;
145 };
146
147 int ps3_repository_find_device(struct ps3_repository_device *repo);
148 int ps3_repository_find_device_by_id(struct ps3_repository_device *repo,
149                                      u64 bus_id, u64 dev_id);
150 int ps3_repository_find_devices(enum ps3_bus_type bus_type,
151         int (*callback)(const struct ps3_repository_device *repo));
152 int ps3_repository_find_bus(enum ps3_bus_type bus_type, unsigned int from,
153         unsigned int *bus_index);
154 int ps3_repository_find_interrupt(const struct ps3_repository_device *repo,
155         enum ps3_interrupt_type intr_type, unsigned int *interrupt_id);
156 int ps3_repository_find_reg(const struct ps3_repository_device *repo,
157         enum ps3_reg_type reg_type, u64 *bus_addr, u64 *len);
158
159 /* repository block device info */
160
161 int ps3_repository_read_stor_dev_port(unsigned int bus_index,
162         unsigned int dev_index, u64 *port);
163 int ps3_repository_read_stor_dev_blk_size(unsigned int bus_index,
164         unsigned int dev_index, u64 *blk_size);
165 int ps3_repository_read_stor_dev_num_blocks(unsigned int bus_index,
166         unsigned int dev_index, u64 *num_blocks);
167 int ps3_repository_read_stor_dev_num_regions(unsigned int bus_index,
168         unsigned int dev_index, unsigned int *num_regions);
169 int ps3_repository_read_stor_dev_region_id(unsigned int bus_index,
170         unsigned int dev_index, unsigned int region_index,
171         unsigned int *region_id);
172 int ps3_repository_read_stor_dev_region_size(unsigned int bus_index,
173         unsigned int dev_index, unsigned int region_index, u64 *region_size);
174 int ps3_repository_read_stor_dev_region_start(unsigned int bus_index,
175         unsigned int dev_index, unsigned int region_index, u64 *region_start);
176 int ps3_repository_read_stor_dev_info(unsigned int bus_index,
177         unsigned int dev_index, u64 *port, u64 *blk_size,
178         u64 *num_blocks, unsigned int *num_regions);
179 int ps3_repository_read_stor_dev_region(unsigned int bus_index,
180         unsigned int dev_index, unsigned int region_index,
181         unsigned int *region_id, u64 *region_start, u64 *region_size);
182
183 /* repository logical pu and memory info */
184
185 int ps3_repository_read_num_pu(u64 *num_pu);
186 int ps3_repository_read_pu_id(unsigned int pu_index, u64 *pu_id);
187 int ps3_repository_read_rm_base(unsigned int ppe_id, u64 *rm_base);
188 int ps3_repository_read_rm_size(unsigned int ppe_id, u64 *rm_size);
189 int ps3_repository_read_region_total(u64 *region_total);
190 int ps3_repository_read_mm_info(u64 *rm_base, u64 *rm_size,
191         u64 *region_total);
192
193 /* repository pme info */
194
195 int ps3_repository_read_num_be(unsigned int *num_be);
196 int ps3_repository_read_be_node_id(unsigned int be_index, u64 *node_id);
197 int ps3_repository_read_be_id(u64 node_id, u64 *be_id);
198 int ps3_repository_read_tb_freq(u64 node_id, u64 *tb_freq);
199 int ps3_repository_read_be_tb_freq(unsigned int be_index, u64 *tb_freq);
200
201 /* repository performance monitor info */
202
203 int ps3_repository_read_lpm_privileges(unsigned int be_index, u64 *lpar,
204         u64 *rights);
205
206 /* repository 'Other OS' area */
207
208 int ps3_repository_read_boot_dat_addr(u64 *lpar_addr);
209 int ps3_repository_read_boot_dat_size(unsigned int *size);
210 int ps3_repository_read_boot_dat_info(u64 *lpar_addr, unsigned int *size);
211
212 /* repository spu info */
213
214 /**
215  * enum spu_resource_type - Type of spu resource.
216  * @spu_resource_type_shared: Logical spu is shared with other partions.
217  * @spu_resource_type_exclusive: Logical spu is not shared with other partions.
218  *
219  * Returned by ps3_repository_read_spu_resource_id().
220  */
221
222 enum ps3_spu_resource_type {
223         PS3_SPU_RESOURCE_TYPE_SHARED = 0,
224         PS3_SPU_RESOURCE_TYPE_EXCLUSIVE = 0x8000000000000000UL,
225 };
226
227 int ps3_repository_read_num_spu_reserved(unsigned int *num_spu_reserved);
228 int ps3_repository_read_num_spu_resource_id(unsigned int *num_resource_id);
229 int ps3_repository_read_spu_resource_id(unsigned int res_index,
230         enum ps3_spu_resource_type* resource_type, unsigned int *resource_id);
231
232 /* repository vuart info */
233
234 int ps3_repository_read_vuart_av_port(unsigned int *port);
235 int ps3_repository_read_vuart_sysmgr_port(unsigned int *port);
236
237 /* Page table entries */
238 #define IOPTE_PP_W              0x8000000000000000ul /* protection: write */
239 #define IOPTE_PP_R              0x4000000000000000ul /* protection: read */
240 #define IOPTE_M                 0x2000000000000000ul /* coherency required */
241 #define IOPTE_SO_R              0x1000000000000000ul /* ordering: writes */
242 #define IOPTE_SO_RW             0x1800000000000000ul /* ordering: r & w */
243 #define IOPTE_RPN_Mask          0x07fffffffffff000ul /* RPN */
244 #define IOPTE_H                 0x0000000000000800ul /* cache hint */
245 #define IOPTE_IOID_Mask         0x00000000000007fful /* ioid */
246
247 #endif