4 * Copyright (C) 2007 Sony Computer Entertainment Inc.
5 * Copyright 2007 Sony Corp.
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.
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.
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
21 #include <linux/kernel.h>
22 #include <linux/module.h>
23 #include <linux/workqueue.h>
24 #include <linux/reboot.h>
26 #include <asm/firmware.h>
32 * ps3_sys_manager - PS3 system manager driver.
34 * The system manager provides an asynchronous system event notification
35 * mechanism for reporting events like thermal alert and button presses to
36 * guests. It also provides support to control system shutdown and startup.
38 * The actual system manager is implemented as an application running in the
39 * system policy module in lpar_1. Guests communicate with the system manager
40 * through port 2 of the vuart using a simple packet message protocol.
41 * Messages are comprised of a fixed field header followed by a message
46 * struct ps3_sys_manager_header - System manager message header.
47 * @version: Header version, currently 1.
48 * @size: Header size in bytes, curently 16.
49 * @payload_size: Message payload size in bytes.
50 * @service_id: Message type, one of enum ps3_sys_manager_service_id.
51 * @request_tag: Unique number to identify reply.
54 struct ps3_sys_manager_header
{
65 #define dump_sm_header(_h) _dump_sm_header(_h, __func__, __LINE__)
66 static void __maybe_unused
_dump_sm_header(
67 const struct ps3_sys_manager_header
*h
, const char *func
, int line
)
69 pr_debug("%s:%d: version: %xh\n", func
, line
, h
->version
);
70 pr_debug("%s:%d: size: %xh\n", func
, line
, h
->size
);
71 pr_debug("%s:%d: payload_size: %xh\n", func
, line
, h
->payload_size
);
72 pr_debug("%s:%d: service_id: %xh\n", func
, line
, h
->service_id
);
73 pr_debug("%s:%d: request_tag: %xh\n", func
, line
, h
->request_tag
);
77 * @PS3_SM_RX_MSG_LEN_MIN - Shortest received message length.
78 * @PS3_SM_RX_MSG_LEN_MAX - Longest received message length.
80 * Currently all messages received from the system manager are either
81 * (16 bytes header + 8 bytes payload = 24 bytes) or (16 bytes header
82 * + 16 bytes payload = 32 bytes). This knowlege is used to simplify
87 PS3_SM_RX_MSG_LEN_MIN
= 24,
88 PS3_SM_RX_MSG_LEN_MAX
= 32,
92 * enum ps3_sys_manager_service_id - Message header service_id.
93 * @PS3_SM_SERVICE_ID_REQUEST: guest --> sys_manager.
94 * @PS3_SM_SERVICE_ID_REQUEST_ERROR: guest <-- sys_manager.
95 * @PS3_SM_SERVICE_ID_COMMAND: guest <-- sys_manager.
96 * @PS3_SM_SERVICE_ID_RESPONSE: guest --> sys_manager.
97 * @PS3_SM_SERVICE_ID_SET_ATTR: guest --> sys_manager.
98 * @PS3_SM_SERVICE_ID_EXTERN_EVENT: guest <-- sys_manager.
99 * @PS3_SM_SERVICE_ID_SET_NEXT_OP: guest --> sys_manager.
101 * PS3_SM_SERVICE_ID_REQUEST_ERROR is returned for invalid data values in a
102 * a PS3_SM_SERVICE_ID_REQUEST message. It also seems to be returned when
103 * a REQUEST message is sent at the wrong time.
106 enum ps3_sys_manager_service_id
{
108 PS3_SM_SERVICE_ID_REQUEST
= 1,
109 PS3_SM_SERVICE_ID_RESPONSE
= 2,
110 PS3_SM_SERVICE_ID_COMMAND
= 3,
111 PS3_SM_SERVICE_ID_EXTERN_EVENT
= 4,
112 PS3_SM_SERVICE_ID_SET_NEXT_OP
= 5,
113 PS3_SM_SERVICE_ID_REQUEST_ERROR
= 6,
114 PS3_SM_SERVICE_ID_SET_ATTR
= 8,
118 * enum ps3_sys_manager_attr - Notification attribute (bit position mask).
119 * @PS3_SM_ATTR_POWER: Power button.
120 * @PS3_SM_ATTR_RESET: Reset button, not available on retail console.
121 * @PS3_SM_ATTR_THERMAL: Sytem thermal alert.
122 * @PS3_SM_ATTR_CONTROLLER: Remote controller event.
123 * @PS3_SM_ATTR_ALL: Logical OR of all.
125 * The guest tells the system manager which events it is interested in receiving
126 * notice of by sending the system manager a logical OR of notification
127 * attributes via the ps3_sys_manager_send_attr() routine.
130 enum ps3_sys_manager_attr
{
132 PS3_SM_ATTR_POWER
= 1,
133 PS3_SM_ATTR_RESET
= 2,
134 PS3_SM_ATTR_THERMAL
= 4,
135 PS3_SM_ATTR_CONTROLLER
= 8, /* bogus? */
136 PS3_SM_ATTR_ALL
= 0x0f,
140 * enum ps3_sys_manager_event - External event type, reported by system manager.
141 * @PS3_SM_EVENT_POWER_PRESSED: payload.value not used.
142 * @PS3_SM_EVENT_POWER_RELEASED: payload.value = time pressed in millisec.
143 * @PS3_SM_EVENT_RESET_PRESSED: payload.value not used.
144 * @PS3_SM_EVENT_RESET_RELEASED: payload.value = time pressed in millisec.
145 * @PS3_SM_EVENT_THERMAL_ALERT: payload.value = thermal zone id.
146 * @PS3_SM_EVENT_THERMAL_CLEARED: payload.value = thermal zone id.
149 enum ps3_sys_manager_event
{
151 PS3_SM_EVENT_POWER_PRESSED
= 3,
152 PS3_SM_EVENT_POWER_RELEASED
= 4,
153 PS3_SM_EVENT_RESET_PRESSED
= 5,
154 PS3_SM_EVENT_RESET_RELEASED
= 6,
155 PS3_SM_EVENT_THERMAL_ALERT
= 7,
156 PS3_SM_EVENT_THERMAL_CLEARED
= 8,
157 /* no info on controller events */
161 * enum ps3_sys_manager_next_op - Operation to perform after lpar is destroyed.
164 enum ps3_sys_manager_next_op
{
166 PS3_SM_NEXT_OP_SYS_SHUTDOWN
= 1,
167 PS3_SM_NEXT_OP_SYS_REBOOT
= 2,
168 PS3_SM_NEXT_OP_LPAR_REBOOT
= 0x82,
172 * enum ps3_sys_manager_wake_source - Next-op wakeup source (bit position mask).
173 * @PS3_SM_WAKE_DEFAULT: Disk insert, power button, eject button, IR
174 * controller, and bluetooth controller.
176 * @PS3_SM_WAKE_RTC_ERROR:
177 * @PS3_SM_WAKE_P_O_R: Power on reset.
179 * Additional wakeup sources when specifying PS3_SM_NEXT_OP_SYS_SHUTDOWN.
180 * The system will always wake from the PS3_SM_WAKE_DEFAULT sources.
181 * Sources listed here are the only ones available to guests in the
185 enum ps3_sys_manager_wake_source
{
187 PS3_SM_WAKE_DEFAULT
= 0,
188 PS3_SM_WAKE_RTC
= 0x00000040,
189 PS3_SM_WAKE_RTC_ERROR
= 0x00000080,
190 PS3_SM_WAKE_P_O_R
= 0x80000000,
194 * enum ps3_sys_manager_cmd - Command from system manager to guest.
196 * The guest completes the actions needed, then acks or naks the command via
197 * ps3_sys_manager_send_response(). In the case of @PS3_SM_CMD_SHUTDOWN,
198 * the guest must be fully prepared for a system poweroff prior to acking the
202 enum ps3_sys_manager_cmd
{
204 PS3_SM_CMD_SHUTDOWN
= 1, /* shutdown guest OS */
208 * ps3_sm_force_power_off - Poweroff helper.
210 * A global variable used to force a poweroff when the power button has
211 * been pressed irrespective of how init handles the ctrl_alt_del signal.
215 static unsigned int ps3_sm_force_power_off
;
218 * ps3_sys_manager_write - Helper to write a two part message to the vuart.
222 static int ps3_sys_manager_write(struct ps3_system_bus_device
*dev
,
223 const struct ps3_sys_manager_header
*header
, const void *payload
)
227 BUG_ON(header
->version
!= 1);
228 BUG_ON(header
->size
!= 16);
229 BUG_ON(header
->payload_size
!= 8 && header
->payload_size
!= 16);
230 BUG_ON(header
->service_id
> 8);
232 result
= ps3_vuart_write(dev
, header
,
233 sizeof(struct ps3_sys_manager_header
));
236 result
= ps3_vuart_write(dev
, payload
, header
->payload_size
);
242 * ps3_sys_manager_send_attr - Send a 'set attribute' to the system manager.
246 static int ps3_sys_manager_send_attr(struct ps3_system_bus_device
*dev
,
247 enum ps3_sys_manager_attr attr
)
249 struct ps3_sys_manager_header header
;
256 BUILD_BUG_ON(sizeof(payload
) != 8);
258 dev_dbg(&dev
->core
, "%s:%d: %xh\n", __func__
, __LINE__
, attr
);
260 memset(&header
, 0, sizeof(header
));
263 header
.payload_size
= 16;
264 header
.service_id
= PS3_SM_SERVICE_ID_SET_ATTR
;
266 memset(&payload
, 0, sizeof(payload
));
268 payload
.attribute
= attr
;
270 return ps3_sys_manager_write(dev
, &header
, &payload
);
274 * ps3_sys_manager_send_next_op - Send a 'set next op' to the system manager.
276 * Tell the system manager what to do after this lpar is destroyed.
279 static int ps3_sys_manager_send_next_op(struct ps3_system_bus_device
*dev
,
280 enum ps3_sys_manager_next_op op
,
281 enum ps3_sys_manager_wake_source wake_source
)
283 struct ps3_sys_manager_header header
;
293 BUILD_BUG_ON(sizeof(payload
) != 16);
295 dev_dbg(&dev
->core
, "%s:%d: (%xh)\n", __func__
, __LINE__
, op
);
297 memset(&header
, 0, sizeof(header
));
300 header
.payload_size
= 16;
301 header
.service_id
= PS3_SM_SERVICE_ID_SET_NEXT_OP
;
303 memset(&payload
, 0, sizeof(payload
));
306 payload
.gos_id
= 3; /* other os */
307 payload
.wake_source
= wake_source
;
309 return ps3_sys_manager_write(dev
, &header
, &payload
);
313 * ps3_sys_manager_send_request_shutdown - Send 'request' to the system manager.
315 * The guest sends this message to request an operation or action of the system
316 * manager. The reply is a command message from the system manager. In the
317 * command handler the guest performs the requested operation. The result of
318 * the command is then communicated back to the system manager with a response
321 * Currently, the only supported request is the 'shutdown self' request.
324 static int ps3_sys_manager_send_request_shutdown(
325 struct ps3_system_bus_device
*dev
)
327 struct ps3_sys_manager_header header
;
335 BUILD_BUG_ON(sizeof(payload
) != 16);
337 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
339 memset(&header
, 0, sizeof(header
));
342 header
.payload_size
= 16;
343 header
.service_id
= PS3_SM_SERVICE_ID_REQUEST
;
345 memset(&payload
, 0, sizeof(payload
));
347 payload
.type
= 1; /* shutdown */
348 payload
.gos_id
= 0; /* self */
350 return ps3_sys_manager_write(dev
, &header
, &payload
);
354 * ps3_sys_manager_send_response - Send a 'response' to the system manager.
355 * @status: zero = success, others fail.
357 * The guest sends this message to the system manager to acnowledge success or
358 * failure of a command sent by the system manager.
361 static int ps3_sys_manager_send_response(struct ps3_system_bus_device
*dev
,
364 struct ps3_sys_manager_header header
;
372 BUILD_BUG_ON(sizeof(payload
) != 16);
374 dev_dbg(&dev
->core
, "%s:%d: (%s)\n", __func__
, __LINE__
,
375 (status
? "nak" : "ack"));
377 memset(&header
, 0, sizeof(header
));
380 header
.payload_size
= 16;
381 header
.service_id
= PS3_SM_SERVICE_ID_RESPONSE
;
383 memset(&payload
, 0, sizeof(payload
));
385 payload
.status
= status
;
387 return ps3_sys_manager_write(dev
, &header
, &payload
);
391 * ps3_sys_manager_handle_event - Second stage event msg handler.
395 static int ps3_sys_manager_handle_event(struct ps3_system_bus_device
*dev
)
406 BUILD_BUG_ON(sizeof(event
) != 16);
408 result
= ps3_vuart_read(dev
, &event
, sizeof(event
));
409 BUG_ON(result
&& "need to retry here");
411 if (event
.version
!= 1) {
412 dev_dbg(&dev
->core
, "%s:%d: unsupported event version (%u)\n",
413 __func__
, __LINE__
, event
.version
);
417 switch (event
.type
) {
418 case PS3_SM_EVENT_POWER_PRESSED
:
419 dev_dbg(&dev
->core
, "%s:%d: POWER_PRESSED\n",
421 ps3_sm_force_power_off
= 1;
423 * A memory barrier is use here to sync memory since
424 * ps3_sys_manager_final_restart() could be called on
428 kill_cad_pid(SIGINT
, 1); /* ctrl_alt_del */
430 case PS3_SM_EVENT_POWER_RELEASED
:
431 dev_dbg(&dev
->core
, "%s:%d: POWER_RELEASED (%u ms)\n",
432 __func__
, __LINE__
, event
.value
);
434 case PS3_SM_EVENT_RESET_PRESSED
:
435 dev_dbg(&dev
->core
, "%s:%d: RESET_PRESSED\n",
437 ps3_sm_force_power_off
= 0;
439 * A memory barrier is use here to sync memory since
440 * ps3_sys_manager_final_restart() could be called on
444 kill_cad_pid(SIGINT
, 1); /* ctrl_alt_del */
446 case PS3_SM_EVENT_RESET_RELEASED
:
447 dev_dbg(&dev
->core
, "%s:%d: RESET_RELEASED (%u ms)\n",
448 __func__
, __LINE__
, event
.value
);
450 case PS3_SM_EVENT_THERMAL_ALERT
:
451 dev_dbg(&dev
->core
, "%s:%d: THERMAL_ALERT (zone %u)\n",
452 __func__
, __LINE__
, event
.value
);
453 pr_info("PS3 Thermal Alert Zone %u\n", event
.value
);
455 case PS3_SM_EVENT_THERMAL_CLEARED
:
456 dev_dbg(&dev
->core
, "%s:%d: THERMAL_CLEARED (zone %u)\n",
457 __func__
, __LINE__
, event
.value
);
460 dev_dbg(&dev
->core
, "%s:%d: unknown event (%u)\n",
461 __func__
, __LINE__
, event
.type
);
468 * ps3_sys_manager_handle_cmd - Second stage command msg handler.
470 * The system manager sends this in reply to a 'request' message from the guest.
473 static int ps3_sys_manager_handle_cmd(struct ps3_system_bus_device
*dev
)
482 BUILD_BUG_ON(sizeof(cmd
) != 16);
484 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
486 result
= ps3_vuart_read(dev
, &cmd
, sizeof(cmd
));
487 BUG_ON(result
&& "need to retry here");
492 if (cmd
.version
!= 1) {
493 dev_dbg(&dev
->core
, "%s:%d: unsupported cmd version (%u)\n",
494 __func__
, __LINE__
, cmd
.version
);
498 if (cmd
.type
!= PS3_SM_CMD_SHUTDOWN
) {
499 dev_dbg(&dev
->core
, "%s:%d: unknown cmd (%u)\n",
500 __func__
, __LINE__
, cmd
.type
);
504 ps3_sys_manager_send_response(dev
, 0);
509 * ps3_sys_manager_handle_msg - First stage msg handler.
511 * Can be called directly to manually poll vuart and pump message handler.
514 static int ps3_sys_manager_handle_msg(struct ps3_system_bus_device
*dev
)
517 struct ps3_sys_manager_header header
;
519 result
= ps3_vuart_read(dev
, &header
,
520 sizeof(struct ps3_sys_manager_header
));
525 if (header
.version
!= 1) {
526 dev_dbg(&dev
->core
, "%s:%d: unsupported header version (%u)\n",
527 __func__
, __LINE__
, header
.version
);
528 dump_sm_header(&header
);
532 BUILD_BUG_ON(sizeof(header
) != 16);
534 if (header
.size
!= 16 || (header
.payload_size
!= 8
535 && header
.payload_size
!= 16)) {
536 dump_sm_header(&header
);
540 switch (header
.service_id
) {
541 case PS3_SM_SERVICE_ID_EXTERN_EVENT
:
542 dev_dbg(&dev
->core
, "%s:%d: EVENT\n", __func__
, __LINE__
);
543 return ps3_sys_manager_handle_event(dev
);
544 case PS3_SM_SERVICE_ID_COMMAND
:
545 dev_dbg(&dev
->core
, "%s:%d: COMMAND\n", __func__
, __LINE__
);
546 return ps3_sys_manager_handle_cmd(dev
);
547 case PS3_SM_SERVICE_ID_REQUEST_ERROR
:
548 dev_dbg(&dev
->core
, "%s:%d: REQUEST_ERROR\n", __func__
,
550 dump_sm_header(&header
);
553 dev_dbg(&dev
->core
, "%s:%d: unknown service_id (%u)\n",
554 __func__
, __LINE__
, header
.service_id
);
560 ps3_vuart_clear_rx_bytes(dev
, 0);
563 ps3_vuart_clear_rx_bytes(dev
, header
.payload_size
);
568 * ps3_sys_manager_final_power_off - The final platform machine_power_off routine.
570 * This routine never returns. The routine disables asynchronous vuart reads
571 * then spins calling ps3_sys_manager_handle_msg() to receive and acknowledge
572 * the shutdown command sent from the system manager. Soon after the
573 * acknowledgement is sent the lpar is destroyed by the HV. This routine
574 * should only be called from ps3_power_off() through
575 * ps3_sys_manager_ops.power_off.
578 static void ps3_sys_manager_final_power_off(struct ps3_system_bus_device
*dev
)
582 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
584 ps3_vuart_cancel_async(dev
);
586 ps3_sys_manager_send_next_op(dev
, PS3_SM_NEXT_OP_SYS_SHUTDOWN
,
587 PS3_SM_WAKE_DEFAULT
);
588 ps3_sys_manager_send_request_shutdown(dev
);
590 pr_emerg("System Halted, OK to turn off power\n");
593 ps3_sys_manager_handle_msg(dev
);
597 * ps3_sys_manager_final_restart - The final platform machine_restart routine.
599 * This routine never returns. The routine disables asynchronous vuart reads
600 * then spins calling ps3_sys_manager_handle_msg() to receive and acknowledge
601 * the shutdown command sent from the system manager. Soon after the
602 * acknowledgement is sent the lpar is destroyed by the HV. This routine
603 * should only be called from ps3_restart() through ps3_sys_manager_ops.restart.
606 static void ps3_sys_manager_final_restart(struct ps3_system_bus_device
*dev
)
610 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
612 /* Check if we got here via a power button event. */
614 if (ps3_sm_force_power_off
) {
615 dev_dbg(&dev
->core
, "%s:%d: forcing poweroff\n",
617 ps3_sys_manager_final_power_off(dev
);
620 ps3_vuart_cancel_async(dev
);
622 ps3_sys_manager_send_attr(dev
, 0);
623 ps3_sys_manager_send_next_op(dev
, PS3_SM_NEXT_OP_SYS_REBOOT
,
624 PS3_SM_WAKE_DEFAULT
);
625 ps3_sys_manager_send_request_shutdown(dev
);
627 pr_emerg("System Halted, OK to turn off power\n");
630 ps3_sys_manager_handle_msg(dev
);
634 * ps3_sys_manager_work - Asynchronous read handler.
636 * Signaled when PS3_SM_RX_MSG_LEN_MIN bytes arrive at the vuart port.
639 static void ps3_sys_manager_work(struct ps3_system_bus_device
*dev
)
641 ps3_sys_manager_handle_msg(dev
);
642 ps3_vuart_read_async(dev
, PS3_SM_RX_MSG_LEN_MIN
);
645 static int ps3_sys_manager_probe(struct ps3_system_bus_device
*dev
)
648 struct ps3_sys_manager_ops ops
;
650 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
652 ops
.power_off
= ps3_sys_manager_final_power_off
;
653 ops
.restart
= ps3_sys_manager_final_restart
;
656 /* ps3_sys_manager_register_ops copies ops. */
658 ps3_sys_manager_register_ops(&ops
);
660 result
= ps3_sys_manager_send_attr(dev
, PS3_SM_ATTR_ALL
);
663 result
= ps3_vuart_read_async(dev
, PS3_SM_RX_MSG_LEN_MIN
);
669 static int ps3_sys_manager_remove(struct ps3_system_bus_device
*dev
)
671 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
675 static void ps3_sys_manager_shutdown(struct ps3_system_bus_device
*dev
)
677 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
680 static struct ps3_vuart_port_driver ps3_sys_manager
= {
681 .core
.match_id
= PS3_MATCH_ID_SYSTEM_MANAGER
,
682 .core
.core
.name
= "ps3_sys_manager",
683 .probe
= ps3_sys_manager_probe
,
684 .remove
= ps3_sys_manager_remove
,
685 .shutdown
= ps3_sys_manager_shutdown
,
686 .work
= ps3_sys_manager_work
,
689 static int __init
ps3_sys_manager_init(void)
691 if (!firmware_has_feature(FW_FEATURE_PS3_LV1
))
694 return ps3_vuart_port_driver_register(&ps3_sys_manager
);
697 module_init(ps3_sys_manager_init
);
698 /* Module remove not supported. */
700 MODULE_AUTHOR("Sony Corporation");
701 MODULE_LICENSE("GPL v2");
702 MODULE_DESCRIPTION("PS3 System Manager");
703 MODULE_ALIAS(PS3_MODULE_ALIAS_SYSTEM_MANAGER
);