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
31void __init ps3_hpte_init(unsigned long htab_size);
32void __init ps3_map_htab(void);
33
34/* mm */
35
36void __init ps3_mm_init(void);
37void __init ps3_mm_vas_create(unsigned long* htab_size);
38void ps3_mm_vas_destroy(void);
39void ps3_mm_shutdown(void);
40
41/* irq */
42
43void ps3_init_IRQ(void);
44void ps3_shutdown_IRQ(int cpu);
45void __init ps3_register_ipi_debug_brk(unsigned int cpu, unsigned int virq);
46void __init ps3_register_ipi_irq(unsigned int cpu, unsigned int virq);
47
48/* smp */
49
50void smp_init_ps3(void);
51#ifdef CONFIG_SMP
52void ps3_smp_cleanup_cpu(int cpu);
53#else
54static inline void ps3_smp_cleanup_cpu(int cpu) { }
55#endif
56
57/* time */
58
59void __init ps3_calibrate_decr(void);
60unsigned long __init ps3_get_boot_time(void);
61void ps3_get_rtc_time(struct rtc_time *time);
62int ps3_set_rtc_time(struct rtc_time *time);
63
64/* os area */
65
66void __init ps3_os_area_save_params(void);
67void __init ps3_os_area_init(void);
68
69/* spu */
70
71#if defined(CONFIG_SPU_BASE)
72void ps3_spu_set_platform (void);
73#else
74static inline void ps3_spu_set_platform (void) {}
75#endif
76
77/* repository bus info */
78
79enum ps3_bus_type {
80	PS3_BUS_TYPE_SB = 4,
81	PS3_BUS_TYPE_STORAGE = 5,
82};
83
84enum ps3_dev_type {
85	PS3_DEV_TYPE_STOR_DISK = TYPE_DISK,	/* 0 */
86	PS3_DEV_TYPE_SB_GELIC = 3,
87	PS3_DEV_TYPE_SB_USB = 4,
88	PS3_DEV_TYPE_STOR_ROM = TYPE_ROM,	/* 5 */
89	PS3_DEV_TYPE_SB_GPIO = 6,
90	PS3_DEV_TYPE_STOR_FLASH = TYPE_RBC,	/* 14 */
91};
92
93int ps3_repository_read_bus_str(unsigned int bus_index, const char *bus_str,
94	u64 *value);
95int ps3_repository_read_bus_id(unsigned int bus_index, u64 *bus_id);
96int ps3_repository_read_bus_type(unsigned int bus_index,
97	enum ps3_bus_type *bus_type);
98int ps3_repository_read_bus_num_dev(unsigned int bus_index,
99	unsigned int *num_dev);
100
101/* repository bus device info */
102
103enum ps3_interrupt_type {
104	PS3_INTERRUPT_TYPE_EVENT_PORT = 2,
105	PS3_INTERRUPT_TYPE_SB_OHCI = 3,
106	PS3_INTERRUPT_TYPE_SB_EHCI = 4,
107	PS3_INTERRUPT_TYPE_OTHER = 5,
108};
109
110enum ps3_reg_type {
111	PS3_REG_TYPE_SB_OHCI = 3,
112	PS3_REG_TYPE_SB_EHCI = 4,
113	PS3_REG_TYPE_SB_GPIO = 5,
114};
115
116int ps3_repository_read_dev_str(unsigned int bus_index,
117	unsigned int dev_index, const char *dev_str, u64 *value);
118int ps3_repository_read_dev_id(unsigned int bus_index, unsigned int dev_index,
119	u64 *dev_id);
120int ps3_repository_read_dev_type(unsigned int bus_index,
121	unsigned int dev_index, enum ps3_dev_type *dev_type);
122int ps3_repository_read_dev_intr(unsigned int bus_index,
123	unsigned int dev_index, unsigned int intr_index,
124	enum ps3_interrupt_type *intr_type, unsigned int *interrupt_id);
125int ps3_repository_read_dev_reg_type(unsigned int bus_index,
126	unsigned int dev_index, unsigned int reg_index,
127	enum ps3_reg_type *reg_type);
128int ps3_repository_read_dev_reg_addr(unsigned int bus_index,
129	unsigned int dev_index, unsigned int reg_index, u64 *bus_addr,
130	u64 *len);
131int ps3_repository_read_dev_reg(unsigned int bus_index,
132	unsigned int dev_index, unsigned int reg_index,
133	enum ps3_reg_type *reg_type, u64 *bus_addr, u64 *len);
134
135/* repository bus enumerators */
136
137struct ps3_repository_device {
138	unsigned int bus_index;
139	unsigned int dev_index;
140	enum ps3_bus_type bus_type;
141	enum ps3_dev_type dev_type;
142	u64 bus_id;
143	u64 dev_id;
144};
145
146int ps3_repository_find_device(struct ps3_repository_device *repo);
147int ps3_repository_find_device_by_id(struct ps3_repository_device *repo,
148				     u64 bus_id, u64 dev_id);
149int ps3_repository_find_devices(enum ps3_bus_type bus_type,
150	int (*callback)(const struct ps3_repository_device *repo));
151int ps3_repository_find_bus(enum ps3_bus_type bus_type, unsigned int from,
152	unsigned int *bus_index);
153int ps3_repository_find_interrupt(const struct ps3_repository_device *repo,
154	enum ps3_interrupt_type intr_type, unsigned int *interrupt_id);
155int ps3_repository_find_reg(const struct ps3_repository_device *repo,
156	enum ps3_reg_type reg_type, u64 *bus_addr, u64 *len);
157
158/* repository block device info */
159
160int ps3_repository_read_stor_dev_port(unsigned int bus_index,
161	unsigned int dev_index, u64 *port);
162int ps3_repository_read_stor_dev_blk_size(unsigned int bus_index,
163	unsigned int dev_index, u64 *blk_size);
164int ps3_repository_read_stor_dev_num_blocks(unsigned int bus_index,
165	unsigned int dev_index, u64 *num_blocks);
166int ps3_repository_read_stor_dev_num_regions(unsigned int bus_index,
167	unsigned int dev_index, unsigned int *num_regions);
168int ps3_repository_read_stor_dev_region_id(unsigned int bus_index,
169	unsigned int dev_index, unsigned int region_index,
170	unsigned int *region_id);
171int ps3_repository_read_stor_dev_region_size(unsigned int bus_index,
172	unsigned int dev_index,	unsigned int region_index, u64 *region_size);
173int ps3_repository_read_stor_dev_region_start(unsigned int bus_index,
174	unsigned int dev_index, unsigned int region_index, u64 *region_start);
175int ps3_repository_read_stor_dev_info(unsigned int bus_index,
176	unsigned int dev_index, u64 *port, u64 *blk_size,
177	u64 *num_blocks, unsigned int *num_regions);
178int ps3_repository_read_stor_dev_region(unsigned int bus_index,
179	unsigned int dev_index, unsigned int region_index,
180	unsigned int *region_id, u64 *region_start, u64 *region_size);
181
182/* repository logical pu and memory info */
183
184int ps3_repository_read_num_pu(u64 *num_pu);
185int ps3_repository_read_pu_id(unsigned int pu_index, u64 *pu_id);
186int ps3_repository_read_rm_base(unsigned int ppe_id, u64 *rm_base);
187int ps3_repository_read_rm_size(unsigned int ppe_id, u64 *rm_size);
188int ps3_repository_read_region_total(u64 *region_total);
189int ps3_repository_read_mm_info(u64 *rm_base, u64 *rm_size,
190	u64 *region_total);
191int ps3_repository_read_highmem_region_count(unsigned int *region_count);
192int ps3_repository_read_highmem_base(unsigned int region_index,
193	u64 *highmem_base);
194int ps3_repository_read_highmem_size(unsigned int region_index,
195	u64 *highmem_size);
196int ps3_repository_read_highmem_info(unsigned int region_index,
197	u64 *highmem_base, u64 *highmem_size);
198
199#if defined (CONFIG_PS3_REPOSITORY_WRITE)
200int ps3_repository_write_highmem_region_count(unsigned int region_count);
201int ps3_repository_write_highmem_base(unsigned int region_index,
202	u64 highmem_base);
203int ps3_repository_write_highmem_size(unsigned int region_index,
204	u64 highmem_size);
205int ps3_repository_write_highmem_info(unsigned int region_index,
206	u64 highmem_base, u64 highmem_size);
207int ps3_repository_delete_highmem_info(unsigned int region_index);
208#else
209static inline int ps3_repository_write_highmem_region_count(
210	unsigned int region_count) {return 0;}
211static inline int ps3_repository_write_highmem_base(unsigned int region_index,
212	u64 highmem_base) {return 0;}
213static inline int ps3_repository_write_highmem_size(unsigned int region_index,
214	u64 highmem_size) {return 0;}
215static inline int ps3_repository_write_highmem_info(unsigned int region_index,
216	u64 highmem_base, u64 highmem_size) {return 0;}
217static inline int ps3_repository_delete_highmem_info(unsigned int region_index)
218	{return 0;}
219#endif
220
221/* repository pme info */
222
223int ps3_repository_read_num_be(unsigned int *num_be);
224int ps3_repository_read_be_node_id(unsigned int be_index, u64 *node_id);
225int ps3_repository_read_be_id(u64 node_id, u64 *be_id);
226int ps3_repository_read_tb_freq(u64 node_id, u64 *tb_freq);
227int ps3_repository_read_be_tb_freq(unsigned int be_index, u64 *tb_freq);
228
229/* repository performance monitor info */
230
231int ps3_repository_read_lpm_privileges(unsigned int be_index, u64 *lpar,
232	u64 *rights);
233
234/* repository 'Other OS' area */
235
236int ps3_repository_read_boot_dat_addr(u64 *lpar_addr);
237int ps3_repository_read_boot_dat_size(unsigned int *size);
238int ps3_repository_read_boot_dat_info(u64 *lpar_addr, unsigned int *size);
239
240/* repository spu info */
241
242/**
243 * enum spu_resource_type - Type of spu resource.
244 * @spu_resource_type_shared: Logical spu is shared with other partions.
245 * @spu_resource_type_exclusive: Logical spu is not shared with other partions.
246 *
247 * Returned by ps3_repository_read_spu_resource_id().
248 */
249
250enum ps3_spu_resource_type {
251	PS3_SPU_RESOURCE_TYPE_SHARED = 0,
252	PS3_SPU_RESOURCE_TYPE_EXCLUSIVE = 0x8000000000000000UL,
253};
254
255int ps3_repository_read_num_spu_reserved(unsigned int *num_spu_reserved);
256int ps3_repository_read_num_spu_resource_id(unsigned int *num_resource_id);
257int ps3_repository_read_spu_resource_id(unsigned int res_index,
258	enum ps3_spu_resource_type* resource_type, unsigned int *resource_id);
259
260/* repository vuart info */
261
262int ps3_repository_read_vuart_av_port(unsigned int *port);
263int ps3_repository_read_vuart_sysmgr_port(unsigned int *port);
264
265#endif
266