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>
27 #include <asm/lv1call.h>
33 * ps3_sys_manager - PS3 system manager driver.
35 * The system manager provides an asynchronous system event notification
36 * mechanism for reporting events like thermal alert and button presses to
37 * guests. It also provides support to control system shutdown and startup.
39 * The actual system manager is implemented as an application running in the
40 * system policy module in lpar_1. Guests communicate with the system manager
41 * through port 2 of the vuart using a simple packet message protocol.
42 * Messages are comprised of a fixed field header followed by a message
47 * struct ps3_sys_manager_header - System manager message header.
48 * @version: Header version, currently 1.
49 * @size: Header size in bytes, curently 16.
50 * @payload_size: Message payload size in bytes.
51 * @service_id: Message type, one of enum ps3_sys_manager_service_id.
52 * @request_tag: Unique number to identify reply.
55 struct ps3_sys_manager_header
{
66 #define dump_sm_header(_h) _dump_sm_header(_h, __func__, __LINE__)
67 static void __maybe_unused
_dump_sm_header(
68 const struct ps3_sys_manager_header
*h
, const char *func
, int line
)
70 pr_debug("%s:%d: version: %xh\n", func
, line
, h
->version
);
71 pr_debug("%s:%d: size: %xh\n", func
, line
, h
->size
);
72 pr_debug("%s:%d: payload_size: %xh\n", func
, line
, h
->payload_size
);
73 pr_debug("%s:%d: service_id: %xh\n", func
, line
, h
->service_id
);
74 pr_debug("%s:%d: request_tag: %xh\n", func
, line
, h
->request_tag
);
78 * @PS3_SM_RX_MSG_LEN_MIN - Shortest received message length.
79 * @PS3_SM_RX_MSG_LEN_MAX - Longest received message length.
81 * Currently all messages received from the system manager are either
82 * (16 bytes header + 8 bytes payload = 24 bytes) or (16 bytes header
83 * + 16 bytes payload = 32 bytes). This knowlege is used to simplify
88 PS3_SM_RX_MSG_LEN_MIN
= 24,
89 PS3_SM_RX_MSG_LEN_MAX
= 32,
93 * enum ps3_sys_manager_service_id - Message header service_id.
94 * @PS3_SM_SERVICE_ID_REQUEST: guest --> sys_manager.
95 * @PS3_SM_SERVICE_ID_REQUEST_ERROR: guest <-- sys_manager.
96 * @PS3_SM_SERVICE_ID_COMMAND: guest <-- sys_manager.
97 * @PS3_SM_SERVICE_ID_RESPONSE: guest --> sys_manager.
98 * @PS3_SM_SERVICE_ID_SET_ATTR: guest --> sys_manager.
99 * @PS3_SM_SERVICE_ID_EXTERN_EVENT: guest <-- sys_manager.
100 * @PS3_SM_SERVICE_ID_SET_NEXT_OP: guest --> sys_manager.
102 * PS3_SM_SERVICE_ID_REQUEST_ERROR is returned for invalid data values in a
103 * a PS3_SM_SERVICE_ID_REQUEST message. It also seems to be returned when
104 * a REQUEST message is sent at the wrong time.
107 enum ps3_sys_manager_service_id
{
109 PS3_SM_SERVICE_ID_REQUEST
= 1,
110 PS3_SM_SERVICE_ID_RESPONSE
= 2,
111 PS3_SM_SERVICE_ID_COMMAND
= 3,
112 PS3_SM_SERVICE_ID_EXTERN_EVENT
= 4,
113 PS3_SM_SERVICE_ID_SET_NEXT_OP
= 5,
114 PS3_SM_SERVICE_ID_REQUEST_ERROR
= 6,
115 PS3_SM_SERVICE_ID_SET_ATTR
= 8,
119 * enum ps3_sys_manager_attr - Notification attribute (bit position mask).
120 * @PS3_SM_ATTR_POWER: Power button.
121 * @PS3_SM_ATTR_RESET: Reset button, not available on retail console.
122 * @PS3_SM_ATTR_THERMAL: Sytem thermal alert.
123 * @PS3_SM_ATTR_CONTROLLER: Remote controller event.
124 * @PS3_SM_ATTR_ALL: Logical OR of all.
126 * The guest tells the system manager which events it is interested in receiving
127 * notice of by sending the system manager a logical OR of notification
128 * attributes via the ps3_sys_manager_send_attr() routine.
131 enum ps3_sys_manager_attr
{
133 PS3_SM_ATTR_POWER
= 1,
134 PS3_SM_ATTR_RESET
= 2,
135 PS3_SM_ATTR_THERMAL
= 4,
136 PS3_SM_ATTR_CONTROLLER
= 8, /* bogus? */
137 PS3_SM_ATTR_ALL
= 0x0f,
141 * enum ps3_sys_manager_event - External event type, reported by system manager.
142 * @PS3_SM_EVENT_POWER_PRESSED: payload.value =
143 * enum ps3_sys_manager_button_event.
144 * @PS3_SM_EVENT_POWER_RELEASED: payload.value = time pressed in millisec.
145 * @PS3_SM_EVENT_RESET_PRESSED: payload.value =
146 * enum ps3_sys_manager_button_event.
147 * @PS3_SM_EVENT_RESET_RELEASED: payload.value = time pressed in millisec.
148 * @PS3_SM_EVENT_THERMAL_ALERT: payload.value = thermal zone id.
149 * @PS3_SM_EVENT_THERMAL_CLEARED: payload.value = thermal zone id.
152 enum ps3_sys_manager_event
{
154 PS3_SM_EVENT_POWER_PRESSED
= 3,
155 PS3_SM_EVENT_POWER_RELEASED
= 4,
156 PS3_SM_EVENT_RESET_PRESSED
= 5,
157 PS3_SM_EVENT_RESET_RELEASED
= 6,
158 PS3_SM_EVENT_THERMAL_ALERT
= 7,
159 PS3_SM_EVENT_THERMAL_CLEARED
= 8,
160 /* no info on controller events */
164 * enum ps3_sys_manager_button_event - Button event payload values.
165 * @PS3_SM_BUTTON_EVENT_HARD: Hardware generated event.
166 * @PS3_SM_BUTTON_EVENT_SOFT: Software generated event.
169 enum ps3_sys_manager_button_event
{
170 PS3_SM_BUTTON_EVENT_HARD
= 0,
171 PS3_SM_BUTTON_EVENT_SOFT
= 1,
175 * enum ps3_sys_manager_next_op - Operation to perform after lpar is destroyed.
178 enum ps3_sys_manager_next_op
{
180 PS3_SM_NEXT_OP_SYS_SHUTDOWN
= 1,
181 PS3_SM_NEXT_OP_SYS_REBOOT
= 2,
182 PS3_SM_NEXT_OP_LPAR_REBOOT
= 0x82,
186 * enum ps3_sys_manager_wake_source - Next-op wakeup source (bit position mask).
187 * @PS3_SM_WAKE_DEFAULT: Disk insert, power button, eject button, IR
188 * controller, and bluetooth controller.
190 * @PS3_SM_WAKE_RTC_ERROR:
191 * @PS3_SM_WAKE_P_O_R: Power on reset.
193 * Additional wakeup sources when specifying PS3_SM_NEXT_OP_SYS_SHUTDOWN.
194 * The system will always wake from the PS3_SM_WAKE_DEFAULT sources.
195 * Sources listed here are the only ones available to guests in the
199 enum ps3_sys_manager_wake_source
{
201 PS3_SM_WAKE_DEFAULT
= 0,
202 PS3_SM_WAKE_RTC
= 0x00000040,
203 PS3_SM_WAKE_RTC_ERROR
= 0x00000080,
204 PS3_SM_WAKE_P_O_R
= 0x80000000,
208 * enum ps3_sys_manager_cmd - Command from system manager to guest.
210 * The guest completes the actions needed, then acks or naks the command via
211 * ps3_sys_manager_send_response(). In the case of @PS3_SM_CMD_SHUTDOWN,
212 * the guest must be fully prepared for a system poweroff prior to acking the
216 enum ps3_sys_manager_cmd
{
218 PS3_SM_CMD_SHUTDOWN
= 1, /* shutdown guest OS */
222 * ps3_sm_force_power_off - Poweroff helper.
224 * A global variable used to force a poweroff when the power button has
225 * been pressed irrespective of how init handles the ctrl_alt_del signal.
229 static unsigned int ps3_sm_force_power_off
;
232 * ps3_sys_manager_write - Helper to write a two part message to the vuart.
236 static int ps3_sys_manager_write(struct ps3_system_bus_device
*dev
,
237 const struct ps3_sys_manager_header
*header
, const void *payload
)
241 BUG_ON(header
->version
!= 1);
242 BUG_ON(header
->size
!= 16);
243 BUG_ON(header
->payload_size
!= 8 && header
->payload_size
!= 16);
244 BUG_ON(header
->service_id
> 8);
246 result
= ps3_vuart_write(dev
, header
,
247 sizeof(struct ps3_sys_manager_header
));
250 result
= ps3_vuart_write(dev
, payload
, header
->payload_size
);
256 * ps3_sys_manager_send_attr - Send a 'set attribute' to the system manager.
260 static int ps3_sys_manager_send_attr(struct ps3_system_bus_device
*dev
,
261 enum ps3_sys_manager_attr attr
)
263 struct ps3_sys_manager_header header
;
270 BUILD_BUG_ON(sizeof(payload
) != 8);
272 dev_dbg(&dev
->core
, "%s:%d: %xh\n", __func__
, __LINE__
, attr
);
274 memset(&header
, 0, sizeof(header
));
277 header
.payload_size
= 16;
278 header
.service_id
= PS3_SM_SERVICE_ID_SET_ATTR
;
280 memset(&payload
, 0, sizeof(payload
));
282 payload
.attribute
= attr
;
284 return ps3_sys_manager_write(dev
, &header
, &payload
);
288 * ps3_sys_manager_send_next_op - Send a 'set next op' to the system manager.
290 * Tell the system manager what to do after this lpar is destroyed.
293 static int ps3_sys_manager_send_next_op(struct ps3_system_bus_device
*dev
,
294 enum ps3_sys_manager_next_op op
,
295 enum ps3_sys_manager_wake_source wake_source
)
297 struct ps3_sys_manager_header header
;
307 BUILD_BUG_ON(sizeof(payload
) != 16);
309 dev_dbg(&dev
->core
, "%s:%d: (%xh)\n", __func__
, __LINE__
, op
);
311 memset(&header
, 0, sizeof(header
));
314 header
.payload_size
= 16;
315 header
.service_id
= PS3_SM_SERVICE_ID_SET_NEXT_OP
;
317 memset(&payload
, 0, sizeof(payload
));
320 payload
.gos_id
= 3; /* other os */
321 payload
.wake_source
= wake_source
;
323 return ps3_sys_manager_write(dev
, &header
, &payload
);
327 * ps3_sys_manager_send_request_shutdown - Send 'request' to the system manager.
329 * The guest sends this message to request an operation or action of the system
330 * manager. The reply is a command message from the system manager. In the
331 * command handler the guest performs the requested operation. The result of
332 * the command is then communicated back to the system manager with a response
335 * Currently, the only supported request is the 'shutdown self' request.
338 static int ps3_sys_manager_send_request_shutdown(
339 struct ps3_system_bus_device
*dev
)
341 struct ps3_sys_manager_header header
;
349 BUILD_BUG_ON(sizeof(payload
) != 16);
351 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
353 memset(&header
, 0, sizeof(header
));
356 header
.payload_size
= 16;
357 header
.service_id
= PS3_SM_SERVICE_ID_REQUEST
;
359 memset(&payload
, 0, sizeof(payload
));
361 payload
.type
= 1; /* shutdown */
362 payload
.gos_id
= 0; /* self */
364 return ps3_sys_manager_write(dev
, &header
, &payload
);
368 * ps3_sys_manager_send_response - Send a 'response' to the system manager.
369 * @status: zero = success, others fail.
371 * The guest sends this message to the system manager to acnowledge success or
372 * failure of a command sent by the system manager.
375 static int ps3_sys_manager_send_response(struct ps3_system_bus_device
*dev
,
378 struct ps3_sys_manager_header header
;
386 BUILD_BUG_ON(sizeof(payload
) != 16);
388 dev_dbg(&dev
->core
, "%s:%d: (%s)\n", __func__
, __LINE__
,
389 (status
? "nak" : "ack"));
391 memset(&header
, 0, sizeof(header
));
394 header
.payload_size
= 16;
395 header
.service_id
= PS3_SM_SERVICE_ID_RESPONSE
;
397 memset(&payload
, 0, sizeof(payload
));
399 payload
.status
= status
;
401 return ps3_sys_manager_write(dev
, &header
, &payload
);
405 * ps3_sys_manager_handle_event - Second stage event msg handler.
409 static int ps3_sys_manager_handle_event(struct ps3_system_bus_device
*dev
)
420 BUILD_BUG_ON(sizeof(event
) != 16);
422 result
= ps3_vuart_read(dev
, &event
, sizeof(event
));
423 BUG_ON(result
&& "need to retry here");
425 if (event
.version
!= 1) {
426 dev_dbg(&dev
->core
, "%s:%d: unsupported event version (%u)\n",
427 __func__
, __LINE__
, event
.version
);
431 switch (event
.type
) {
432 case PS3_SM_EVENT_POWER_PRESSED
:
433 dev_dbg(&dev
->core
, "%s:%d: POWER_PRESSED (%s)\n",
435 (event
.value
== PS3_SM_BUTTON_EVENT_SOFT
? "soft"
437 ps3_sm_force_power_off
= 1;
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_POWER_RELEASED
:
447 dev_dbg(&dev
->core
, "%s:%d: POWER_RELEASED (%u ms)\n",
448 __func__
, __LINE__
, event
.value
);
450 case PS3_SM_EVENT_RESET_PRESSED
:
451 dev_dbg(&dev
->core
, "%s:%d: RESET_PRESSED (%s)\n",
453 (event
.value
== PS3_SM_BUTTON_EVENT_SOFT
? "soft"
455 ps3_sm_force_power_off
= 0;
457 * A memory barrier is use here to sync memory since
458 * ps3_sys_manager_final_restart() could be called on
462 kill_cad_pid(SIGINT
, 1); /* ctrl_alt_del */
464 case PS3_SM_EVENT_RESET_RELEASED
:
465 dev_dbg(&dev
->core
, "%s:%d: RESET_RELEASED (%u ms)\n",
466 __func__
, __LINE__
, event
.value
);
468 case PS3_SM_EVENT_THERMAL_ALERT
:
469 dev_dbg(&dev
->core
, "%s:%d: THERMAL_ALERT (zone %u)\n",
470 __func__
, __LINE__
, event
.value
);
471 pr_info("PS3 Thermal Alert Zone %u\n", event
.value
);
473 case PS3_SM_EVENT_THERMAL_CLEARED
:
474 dev_dbg(&dev
->core
, "%s:%d: THERMAL_CLEARED (zone %u)\n",
475 __func__
, __LINE__
, event
.value
);
478 dev_dbg(&dev
->core
, "%s:%d: unknown event (%u)\n",
479 __func__
, __LINE__
, event
.type
);
486 * ps3_sys_manager_handle_cmd - Second stage command msg handler.
488 * The system manager sends this in reply to a 'request' message from the guest.
491 static int ps3_sys_manager_handle_cmd(struct ps3_system_bus_device
*dev
)
500 BUILD_BUG_ON(sizeof(cmd
) != 16);
502 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
504 result
= ps3_vuart_read(dev
, &cmd
, sizeof(cmd
));
505 BUG_ON(result
&& "need to retry here");
510 if (cmd
.version
!= 1) {
511 dev_dbg(&dev
->core
, "%s:%d: unsupported cmd version (%u)\n",
512 __func__
, __LINE__
, cmd
.version
);
516 if (cmd
.type
!= PS3_SM_CMD_SHUTDOWN
) {
517 dev_dbg(&dev
->core
, "%s:%d: unknown cmd (%u)\n",
518 __func__
, __LINE__
, cmd
.type
);
522 ps3_sys_manager_send_response(dev
, 0);
527 * ps3_sys_manager_handle_msg - First stage msg handler.
529 * Can be called directly to manually poll vuart and pump message handler.
532 static int ps3_sys_manager_handle_msg(struct ps3_system_bus_device
*dev
)
535 struct ps3_sys_manager_header header
;
537 result
= ps3_vuart_read(dev
, &header
,
538 sizeof(struct ps3_sys_manager_header
));
543 if (header
.version
!= 1) {
544 dev_dbg(&dev
->core
, "%s:%d: unsupported header version (%u)\n",
545 __func__
, __LINE__
, header
.version
);
546 dump_sm_header(&header
);
550 BUILD_BUG_ON(sizeof(header
) != 16);
552 if (header
.size
!= 16 || (header
.payload_size
!= 8
553 && header
.payload_size
!= 16)) {
554 dump_sm_header(&header
);
558 switch (header
.service_id
) {
559 case PS3_SM_SERVICE_ID_EXTERN_EVENT
:
560 dev_dbg(&dev
->core
, "%s:%d: EVENT\n", __func__
, __LINE__
);
561 return ps3_sys_manager_handle_event(dev
);
562 case PS3_SM_SERVICE_ID_COMMAND
:
563 dev_dbg(&dev
->core
, "%s:%d: COMMAND\n", __func__
, __LINE__
);
564 return ps3_sys_manager_handle_cmd(dev
);
565 case PS3_SM_SERVICE_ID_REQUEST_ERROR
:
566 dev_dbg(&dev
->core
, "%s:%d: REQUEST_ERROR\n", __func__
,
568 dump_sm_header(&header
);
571 dev_dbg(&dev
->core
, "%s:%d: unknown service_id (%u)\n",
572 __func__
, __LINE__
, header
.service_id
);
578 ps3_vuart_clear_rx_bytes(dev
, 0);
581 ps3_vuart_clear_rx_bytes(dev
, header
.payload_size
);
585 static void ps3_sys_manager_fin(struct ps3_system_bus_device
*dev
)
587 ps3_sys_manager_send_request_shutdown(dev
);
589 pr_emerg("System Halted, OK to turn off power\n");
591 while (ps3_sys_manager_handle_msg(dev
)) {
592 /* pause until next DEC interrupt */
597 /* pause, ignoring DEC interrupt */
603 * ps3_sys_manager_final_power_off - The final platform machine_power_off routine.
605 * This routine never returns. The routine disables asynchronous vuart reads
606 * then spins calling ps3_sys_manager_handle_msg() to receive and acknowledge
607 * the shutdown command sent from the system manager. Soon after the
608 * acknowledgement is sent the lpar is destroyed by the HV. This routine
609 * should only be called from ps3_power_off() through
610 * ps3_sys_manager_ops.power_off.
613 static void ps3_sys_manager_final_power_off(struct ps3_system_bus_device
*dev
)
617 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
619 ps3_vuart_cancel_async(dev
);
621 ps3_sys_manager_send_next_op(dev
, PS3_SM_NEXT_OP_SYS_SHUTDOWN
,
622 PS3_SM_WAKE_DEFAULT
);
624 ps3_sys_manager_fin(dev
);
628 * ps3_sys_manager_final_restart - The final platform machine_restart routine.
630 * This routine never returns. The routine disables asynchronous vuart reads
631 * then spins calling ps3_sys_manager_handle_msg() to receive and acknowledge
632 * the shutdown command sent from the system manager. Soon after the
633 * acknowledgement is sent the lpar is destroyed by the HV. This routine
634 * should only be called from ps3_restart() through ps3_sys_manager_ops.restart.
637 static void ps3_sys_manager_final_restart(struct ps3_system_bus_device
*dev
)
641 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
643 /* Check if we got here via a power button event. */
645 if (ps3_sm_force_power_off
) {
646 dev_dbg(&dev
->core
, "%s:%d: forcing poweroff\n",
648 ps3_sys_manager_final_power_off(dev
);
651 ps3_vuart_cancel_async(dev
);
653 ps3_sys_manager_send_attr(dev
, 0);
654 ps3_sys_manager_send_next_op(dev
, PS3_SM_NEXT_OP_SYS_REBOOT
,
655 PS3_SM_WAKE_DEFAULT
);
657 ps3_sys_manager_fin(dev
);
661 * ps3_sys_manager_work - Asynchronous read handler.
663 * Signaled when PS3_SM_RX_MSG_LEN_MIN bytes arrive at the vuart port.
666 static void ps3_sys_manager_work(struct ps3_system_bus_device
*dev
)
668 ps3_sys_manager_handle_msg(dev
);
669 ps3_vuart_read_async(dev
, PS3_SM_RX_MSG_LEN_MIN
);
672 static int ps3_sys_manager_probe(struct ps3_system_bus_device
*dev
)
675 struct ps3_sys_manager_ops ops
;
677 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
679 ops
.power_off
= ps3_sys_manager_final_power_off
;
680 ops
.restart
= ps3_sys_manager_final_restart
;
683 /* ps3_sys_manager_register_ops copies ops. */
685 ps3_sys_manager_register_ops(&ops
);
687 result
= ps3_sys_manager_send_attr(dev
, PS3_SM_ATTR_ALL
);
690 result
= ps3_vuart_read_async(dev
, PS3_SM_RX_MSG_LEN_MIN
);
696 static int ps3_sys_manager_remove(struct ps3_system_bus_device
*dev
)
698 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
702 static void ps3_sys_manager_shutdown(struct ps3_system_bus_device
*dev
)
704 dev_dbg(&dev
->core
, "%s:%d\n", __func__
, __LINE__
);
707 static struct ps3_vuart_port_driver ps3_sys_manager
= {
708 .core
.match_id
= PS3_MATCH_ID_SYSTEM_MANAGER
,
709 .core
.core
.name
= "ps3_sys_manager",
710 .probe
= ps3_sys_manager_probe
,
711 .remove
= ps3_sys_manager_remove
,
712 .shutdown
= ps3_sys_manager_shutdown
,
713 .work
= ps3_sys_manager_work
,
716 static int __init
ps3_sys_manager_init(void)
718 if (!firmware_has_feature(FW_FEATURE_PS3_LV1
))
721 return ps3_vuart_port_driver_register(&ps3_sys_manager
);
724 module_init(ps3_sys_manager_init
);
725 /* Module remove not supported. */
727 MODULE_AUTHOR("Sony Corporation");
728 MODULE_LICENSE("GPL v2");
729 MODULE_DESCRIPTION("PS3 System Manager");
730 MODULE_ALIAS(PS3_MODULE_ALIAS_SYSTEM_MANAGER
);