2 * Intel SST Haswell/Broadwell IPC Support
4 * Copyright (C) 2013, Intel Corporation. All rights reserved.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License version
8 * 2 as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
17 #include <linux/types.h>
18 #include <linux/kernel.h>
19 #include <linux/list.h>
20 #include <linux/device.h>
21 #include <linux/wait.h>
22 #include <linux/spinlock.h>
23 #include <linux/workqueue.h>
24 #include <linux/export.h>
25 #include <linux/slab.h>
26 #include <linux/delay.h>
27 #include <linux/sched.h>
28 #include <linux/platform_device.h>
29 #include <linux/kthread.h>
30 #include <linux/firmware.h>
31 #include <linux/dma-mapping.h>
32 #include <linux/debugfs.h>
33 #include <linux/pm_runtime.h>
35 #include "sst-haswell-ipc.h"
37 #include "sst-dsp-priv.h"
39 /* Global Message - Generic */
40 #define IPC_GLB_TYPE_SHIFT 24
41 #define IPC_GLB_TYPE_MASK (0x1f << IPC_GLB_TYPE_SHIFT)
42 #define IPC_GLB_TYPE(x) (x << IPC_GLB_TYPE_SHIFT)
44 /* Global Message - Reply */
45 #define IPC_GLB_REPLY_SHIFT 0
46 #define IPC_GLB_REPLY_MASK (0x1f << IPC_GLB_REPLY_SHIFT)
47 #define IPC_GLB_REPLY_TYPE(x) (x << IPC_GLB_REPLY_TYPE_SHIFT)
49 /* Stream Message - Generic */
50 #define IPC_STR_TYPE_SHIFT 20
51 #define IPC_STR_TYPE_MASK (0xf << IPC_STR_TYPE_SHIFT)
52 #define IPC_STR_TYPE(x) (x << IPC_STR_TYPE_SHIFT)
53 #define IPC_STR_ID_SHIFT 16
54 #define IPC_STR_ID_MASK (0xf << IPC_STR_ID_SHIFT)
55 #define IPC_STR_ID(x) (x << IPC_STR_ID_SHIFT)
57 /* Stream Message - Reply */
58 #define IPC_STR_REPLY_SHIFT 0
59 #define IPC_STR_REPLY_MASK (0x1f << IPC_STR_REPLY_SHIFT)
61 /* Stream Stage Message - Generic */
62 #define IPC_STG_TYPE_SHIFT 12
63 #define IPC_STG_TYPE_MASK (0xf << IPC_STG_TYPE_SHIFT)
64 #define IPC_STG_TYPE(x) (x << IPC_STG_TYPE_SHIFT)
65 #define IPC_STG_ID_SHIFT 10
66 #define IPC_STG_ID_MASK (0x3 << IPC_STG_ID_SHIFT)
67 #define IPC_STG_ID(x) (x << IPC_STG_ID_SHIFT)
69 /* Stream Stage Message - Reply */
70 #define IPC_STG_REPLY_SHIFT 0
71 #define IPC_STG_REPLY_MASK (0x1f << IPC_STG_REPLY_SHIFT)
73 /* Debug Log Message - Generic */
74 #define IPC_LOG_OP_SHIFT 20
75 #define IPC_LOG_OP_MASK (0xf << IPC_LOG_OP_SHIFT)
76 #define IPC_LOG_OP_TYPE(x) (x << IPC_LOG_OP_SHIFT)
77 #define IPC_LOG_ID_SHIFT 16
78 #define IPC_LOG_ID_MASK (0xf << IPC_LOG_ID_SHIFT)
79 #define IPC_LOG_ID(x) (x << IPC_LOG_ID_SHIFT)
81 /* IPC message timeout (msecs) */
82 #define IPC_TIMEOUT_MSECS 300
83 #define IPC_BOOT_MSECS 200
84 #define IPC_MSG_WAIT 0
85 #define IPC_MSG_NOWAIT 1
87 /* Firmware Ready Message */
88 #define IPC_FW_READY (0x1 << 29)
89 #define IPC_STATUS_MASK (0x3 << 30)
91 #define IPC_EMPTY_LIST_SIZE 8
92 #define IPC_MAX_STREAMS 4
95 #define IPC_MAX_MAILBOX_BYTES 256
97 #define INVALID_STREAM_HW_ID 0xffffffff
99 /* Global Message - Types and Replies */
101 IPC_GLB_GET_FW_VERSION = 0, /* Retrieves firmware version */
102 IPC_GLB_PERFORMANCE_MONITOR = 1, /* Performance monitoring actions */
103 IPC_GLB_ALLOCATE_STREAM = 3, /* Request to allocate new stream */
104 IPC_GLB_FREE_STREAM = 4, /* Request to free stream */
105 IPC_GLB_GET_FW_CAPABILITIES = 5, /* Retrieves firmware capabilities */
106 IPC_GLB_STREAM_MESSAGE = 6, /* Message directed to stream or its stages */
107 /* Request to store firmware context during D0->D3 transition */
108 IPC_GLB_REQUEST_DUMP = 7,
109 /* Request to restore firmware context during D3->D0 transition */
110 IPC_GLB_RESTORE_CONTEXT = 8,
111 IPC_GLB_GET_DEVICE_FORMATS = 9, /* Set device format */
112 IPC_GLB_SET_DEVICE_FORMATS = 10, /* Get device format */
113 IPC_GLB_SHORT_REPLY = 11,
114 IPC_GLB_ENTER_DX_STATE = 12,
115 IPC_GLB_GET_MIXER_STREAM_INFO = 13, /* Request mixer stream params */
116 IPC_GLB_DEBUG_LOG_MESSAGE = 14, /* Message to or from the debug logger. */
117 IPC_GLB_REQUEST_TRANSFER = 16, /* < Request Transfer for host */
118 IPC_GLB_MAX_IPC_MESSAGE_TYPE = 17, /* Maximum message number */
122 IPC_GLB_REPLY_SUCCESS = 0, /* The operation was successful. */
123 IPC_GLB_REPLY_ERROR_INVALID_PARAM = 1, /* Invalid parameter was passed. */
124 IPC_GLB_REPLY_UNKNOWN_MESSAGE_TYPE = 2, /* Uknown message type was resceived. */
125 IPC_GLB_REPLY_OUT_OF_RESOURCES = 3, /* No resources to satisfy the request. */
126 IPC_GLB_REPLY_BUSY = 4, /* The system or resource is busy. */
127 IPC_GLB_REPLY_PENDING = 5, /* The action was scheduled for processing. */
128 IPC_GLB_REPLY_FAILURE = 6, /* Critical error happened. */
129 IPC_GLB_REPLY_INVALID_REQUEST = 7, /* Request can not be completed. */
130 IPC_GLB_REPLY_STAGE_UNINITIALIZED = 8, /* Processing stage was uninitialized. */
131 IPC_GLB_REPLY_NOT_FOUND = 9, /* Required resource can not be found. */
132 IPC_GLB_REPLY_SOURCE_NOT_STARTED = 10, /* Source was not started. */
135 /* Stream Message - Types */
136 enum ipc_str_operation {
140 IPC_STR_STAGE_MESSAGE = 3,
141 IPC_STR_NOTIFICATION = 4,
145 /* Stream Stage Message Types */
146 enum ipc_stg_operation {
147 IPC_STG_GET_VOLUME = 0,
149 IPC_STG_SET_WRITE_POSITION,
150 IPC_STG_SET_FX_ENABLE,
151 IPC_STG_SET_FX_DISABLE,
152 IPC_STG_SET_FX_GET_PARAM,
153 IPC_STG_SET_FX_SET_PARAM,
154 IPC_STG_SET_FX_GET_INFO,
155 IPC_STG_MUTE_LOOPBACK,
159 /* Stream Stage Message Types For Notification*/
160 enum ipc_stg_operation_notify {
161 IPC_POSITION_CHANGED = 0,
166 enum ipc_glitch_type {
167 IPC_GLITCH_UNDERRUN = 1,
168 IPC_GLITCH_DECODER_ERROR,
169 IPC_GLITCH_DOUBLED_WRITE_POS,
174 enum ipc_debug_operation {
175 IPC_DEBUG_ENABLE_LOG = 0,
176 IPC_DEBUG_DISABLE_LOG = 1,
177 IPC_DEBUG_REQUEST_LOG_DUMP = 2,
178 IPC_DEBUG_NOTIFY_LOG_DUMP = 3,
179 IPC_DEBUG_MAX_DEBUG_LOG
183 struct sst_hsw_ipc_fw_ready {
189 u8 fw_info[IPC_MAX_MAILBOX_BYTES - 5 * sizeof(u32)];
190 } __attribute__((packed));
193 struct list_head list;
196 /* direction wrt host CPU */
197 char tx_data[IPC_MAX_MAILBOX_BYTES];
199 char rx_data[IPC_MAX_MAILBOX_BYTES];
202 wait_queue_head_t waitq;
209 struct sst_hsw_stream;
212 /* Stream infomation */
213 struct sst_hsw_stream {
215 struct sst_hsw_ipc_stream_alloc_req request;
216 struct sst_hsw_ipc_stream_alloc_reply reply;
217 struct sst_hsw_ipc_stream_free_req free_req;
220 u32 mute_volume[SST_HSW_NO_CHANNELS];
221 u32 mute[SST_HSW_NO_CHANNELS];
229 /* Notification work */
230 struct work_struct notify_work;
233 /* Position info from DSP */
234 struct sst_hsw_ipc_stream_set_position wpos;
235 struct sst_hsw_ipc_stream_get_position rpos;
236 struct sst_hsw_ipc_stream_glitch_position glitch;
239 struct sst_hsw_ipc_volume_req vol_req;
241 /* driver callback */
242 u32 (*notify_position)(struct sst_hsw_stream *stream, void *data);
245 struct list_head node;
248 /* FW log ring information */
249 struct sst_hsw_log_stream {
251 unsigned char *dma_area;
252 unsigned char *ring_descr;
256 /* Notification work */
257 struct work_struct notify_work;
258 wait_queue_head_t readers_wait_q;
259 struct mutex rw_mutex;
266 u32 config[SST_HSW_FW_LOG_CONFIG_DWORDS];
271 /* SST Haswell IPC data */
275 struct platform_device *pdev_pcm;
278 struct sst_hsw_ipc_fw_ready fw_ready;
279 struct sst_hsw_ipc_fw_version version;
281 struct sst_fw *sst_fw;
284 struct list_head stream_list;
287 struct sst_hsw_ipc_stream_info_reply mixer_info;
288 enum sst_hsw_volume_curve curve_type;
290 u32 mute[SST_HSW_NO_CHANNELS];
291 u32 mute_volume[SST_HSW_NO_CHANNELS];
294 struct sst_hsw_ipc_dx_reply dx;
296 dma_addr_t dx_context_paddr;
299 wait_queue_head_t boot_wait;
304 struct list_head tx_list;
305 struct list_head rx_list;
306 struct list_head empty_list;
307 wait_queue_head_t wait_txq;
308 struct task_struct *tx_thread;
309 struct kthread_worker kworker;
310 struct kthread_work kwork;
312 struct ipc_message *msg;
315 struct sst_hsw_log_stream log_stream;
318 #define CREATE_TRACE_POINTS
319 #include <trace/events/hswadsp.h>
321 static inline u32 msg_get_global_type(u32 msg)
323 return (msg & IPC_GLB_TYPE_MASK) >> IPC_GLB_TYPE_SHIFT;
326 static inline u32 msg_get_global_reply(u32 msg)
328 return (msg & IPC_GLB_REPLY_MASK) >> IPC_GLB_REPLY_SHIFT;
331 static inline u32 msg_get_stream_type(u32 msg)
333 return (msg & IPC_STR_TYPE_MASK) >> IPC_STR_TYPE_SHIFT;
336 static inline u32 msg_get_stage_type(u32 msg)
338 return (msg & IPC_STG_TYPE_MASK) >> IPC_STG_TYPE_SHIFT;
341 static inline u32 msg_get_stream_id(u32 msg)
343 return (msg & IPC_STR_ID_MASK) >> IPC_STR_ID_SHIFT;
346 static inline u32 msg_get_notify_reason(u32 msg)
348 return (msg & IPC_STG_TYPE_MASK) >> IPC_STG_TYPE_SHIFT;
351 u32 create_channel_map(enum sst_hsw_channel_config config)
354 case SST_HSW_CHANNEL_CONFIG_MONO:
355 return (0xFFFFFFF0 | SST_HSW_CHANNEL_CENTER);
356 case SST_HSW_CHANNEL_CONFIG_STEREO:
357 return (0xFFFFFF00 | SST_HSW_CHANNEL_LEFT
358 | (SST_HSW_CHANNEL_RIGHT << 4));
359 case SST_HSW_CHANNEL_CONFIG_2_POINT_1:
360 return (0xFFFFF000 | SST_HSW_CHANNEL_LEFT
361 | (SST_HSW_CHANNEL_RIGHT << 4)
362 | (SST_HSW_CHANNEL_LFE << 8 ));
363 case SST_HSW_CHANNEL_CONFIG_3_POINT_0:
364 return (0xFFFFF000 | SST_HSW_CHANNEL_LEFT
365 | (SST_HSW_CHANNEL_CENTER << 4)
366 | (SST_HSW_CHANNEL_RIGHT << 8));
367 case SST_HSW_CHANNEL_CONFIG_3_POINT_1:
368 return (0xFFFF0000 | SST_HSW_CHANNEL_LEFT
369 | (SST_HSW_CHANNEL_CENTER << 4)
370 | (SST_HSW_CHANNEL_RIGHT << 8)
371 | (SST_HSW_CHANNEL_LFE << 12));
372 case SST_HSW_CHANNEL_CONFIG_QUATRO:
373 return (0xFFFF0000 | SST_HSW_CHANNEL_LEFT
374 | (SST_HSW_CHANNEL_RIGHT << 4)
375 | (SST_HSW_CHANNEL_LEFT_SURROUND << 8)
376 | (SST_HSW_CHANNEL_RIGHT_SURROUND << 12));
377 case SST_HSW_CHANNEL_CONFIG_4_POINT_0:
378 return (0xFFFF0000 | SST_HSW_CHANNEL_LEFT
379 | (SST_HSW_CHANNEL_CENTER << 4)
380 | (SST_HSW_CHANNEL_RIGHT << 8)
381 | (SST_HSW_CHANNEL_CENTER_SURROUND << 12));
382 case SST_HSW_CHANNEL_CONFIG_5_POINT_0:
383 return (0xFFF00000 | SST_HSW_CHANNEL_LEFT
384 | (SST_HSW_CHANNEL_CENTER << 4)
385 | (SST_HSW_CHANNEL_RIGHT << 8)
386 | (SST_HSW_CHANNEL_LEFT_SURROUND << 12)
387 | (SST_HSW_CHANNEL_RIGHT_SURROUND << 16));
388 case SST_HSW_CHANNEL_CONFIG_5_POINT_1:
389 return (0xFF000000 | SST_HSW_CHANNEL_CENTER
390 | (SST_HSW_CHANNEL_LEFT << 4)
391 | (SST_HSW_CHANNEL_RIGHT << 8)
392 | (SST_HSW_CHANNEL_LEFT_SURROUND << 12)
393 | (SST_HSW_CHANNEL_RIGHT_SURROUND << 16)
394 | (SST_HSW_CHANNEL_LFE << 20));
395 case SST_HSW_CHANNEL_CONFIG_DUAL_MONO:
396 return (0xFFFFFF00 | SST_HSW_CHANNEL_LEFT
397 | (SST_HSW_CHANNEL_LEFT << 4));
403 static struct sst_hsw_stream *get_stream_by_id(struct sst_hsw *hsw,
406 struct sst_hsw_stream *stream;
408 list_for_each_entry(stream, &hsw->stream_list, node) {
409 if (stream->reply.stream_hw_id == stream_id)
416 static void ipc_shim_dbg(struct sst_hsw *hsw, const char *text)
418 struct sst_dsp *sst = hsw->dsp;
419 u32 isr, ipcd, imrx, ipcx;
421 ipcx = sst_dsp_shim_read_unlocked(sst, SST_IPCX);
422 isr = sst_dsp_shim_read_unlocked(sst, SST_ISRX);
423 ipcd = sst_dsp_shim_read_unlocked(sst, SST_IPCD);
424 imrx = sst_dsp_shim_read_unlocked(sst, SST_IMRX);
426 dev_err(hsw->dev, "ipc: --%s-- ipcx 0x%8.8x isr 0x%8.8x ipcd 0x%8.8x imrx 0x%8.8x\n",
427 text, ipcx, isr, ipcd, imrx);
430 /* locks held by caller */
431 static struct ipc_message *msg_get_empty(struct sst_hsw *hsw)
433 struct ipc_message *msg = NULL;
435 if (!list_empty(&hsw->empty_list)) {
436 msg = list_first_entry(&hsw->empty_list, struct ipc_message,
438 list_del(&msg->list);
444 static void ipc_tx_msgs(struct kthread_work *work)
446 struct sst_hsw *hsw =
447 container_of(work, struct sst_hsw, kwork);
448 struct ipc_message *msg;
452 spin_lock_irqsave(&hsw->dsp->spinlock, flags);
454 if (list_empty(&hsw->tx_list) || hsw->pending) {
455 spin_unlock_irqrestore(&hsw->dsp->spinlock, flags);
459 /* if the DSP is busy, we will TX messages after IRQ.
460 * also postpone if we are in the middle of procesing completion irq*/
461 ipcx = sst_dsp_shim_read_unlocked(hsw->dsp, SST_IPCX);
462 if (ipcx & (SST_IPCX_BUSY | SST_IPCX_DONE)) {
463 spin_unlock_irqrestore(&hsw->dsp->spinlock, flags);
467 msg = list_first_entry(&hsw->tx_list, struct ipc_message, list);
469 list_move(&msg->list, &hsw->rx_list);
471 /* send the message */
472 sst_dsp_outbox_write(hsw->dsp, msg->tx_data, msg->tx_size);
473 sst_dsp_ipc_msg_tx(hsw->dsp, msg->header | SST_IPCX_BUSY);
475 spin_unlock_irqrestore(&hsw->dsp->spinlock, flags);
478 /* locks held by caller */
479 static void tx_msg_reply_complete(struct sst_hsw *hsw, struct ipc_message *msg)
481 msg->complete = true;
482 trace_ipc_reply("completed", msg->header);
485 list_add_tail(&msg->list, &hsw->empty_list);
487 wake_up(&msg->waitq);
490 static int tx_wait_done(struct sst_hsw *hsw, struct ipc_message *msg,
496 /* wait for DSP completion (in all cases atm inc pending) */
497 ret = wait_event_timeout(msg->waitq, msg->complete,
498 msecs_to_jiffies(IPC_TIMEOUT_MSECS));
500 spin_lock_irqsave(&hsw->dsp->spinlock, flags);
502 ipc_shim_dbg(hsw, "message timeout");
504 trace_ipc_error("error message timeout for", msg->header);
505 list_del(&msg->list);
509 /* copy the data returned from DSP */
511 memcpy(rx_data, msg->rx_data, msg->rx_size);
515 list_add_tail(&msg->list, &hsw->empty_list);
516 spin_unlock_irqrestore(&hsw->dsp->spinlock, flags);
520 static int ipc_tx_message(struct sst_hsw *hsw, u32 header, void *tx_data,
521 size_t tx_bytes, void *rx_data, size_t rx_bytes, int wait)
523 struct ipc_message *msg;
526 spin_lock_irqsave(&hsw->dsp->spinlock, flags);
528 msg = msg_get_empty(hsw);
530 spin_unlock_irqrestore(&hsw->dsp->spinlock, flags);
535 memcpy(msg->tx_data, tx_data, tx_bytes);
537 msg->header = header;
538 msg->tx_size = tx_bytes;
539 msg->rx_size = rx_bytes;
542 msg->pending = false;
543 msg->complete = false;
545 list_add_tail(&msg->list, &hsw->tx_list);
546 spin_unlock_irqrestore(&hsw->dsp->spinlock, flags);
548 queue_kthread_work(&hsw->kworker, &hsw->kwork);
551 return tx_wait_done(hsw, msg, rx_data);
556 static inline int ipc_tx_message_wait(struct sst_hsw *hsw, u32 header,
557 void *tx_data, size_t tx_bytes, void *rx_data, size_t rx_bytes)
559 return ipc_tx_message(hsw, header, tx_data, tx_bytes, rx_data,
563 static inline int ipc_tx_message_nowait(struct sst_hsw *hsw, u32 header,
564 void *tx_data, size_t tx_bytes)
566 return ipc_tx_message(hsw, header, tx_data, tx_bytes, NULL, 0, 0);
569 static void hsw_fw_ready(struct sst_hsw *hsw, u32 header)
571 struct sst_hsw_ipc_fw_ready fw_ready;
573 u8 fw_info[IPC_MAX_MAILBOX_BYTES - 5 * sizeof(u32)];
574 char *tmp[5], *pinfo;
577 offset = (header & 0x1FFFFFFF) << 3;
579 dev_dbg(hsw->dev, "ipc: DSP is ready 0x%8.8x offset %d\n",
582 /* copy data from the DSP FW ready offset */
583 sst_dsp_read(hsw->dsp, &fw_ready, offset, sizeof(fw_ready));
585 sst_dsp_mailbox_init(hsw->dsp, fw_ready.inbox_offset,
586 fw_ready.inbox_size, fw_ready.outbox_offset,
587 fw_ready.outbox_size);
589 hsw->boot_complete = true;
590 wake_up(&hsw->boot_wait);
592 dev_dbg(hsw->dev, " mailbox upstream 0x%x - size 0x%x\n",
593 fw_ready.inbox_offset, fw_ready.inbox_size);
594 dev_dbg(hsw->dev, " mailbox downstream 0x%x - size 0x%x\n",
595 fw_ready.outbox_offset, fw_ready.outbox_size);
596 if (fw_ready.fw_info_size < sizeof(fw_ready.fw_info)) {
597 fw_ready.fw_info[fw_ready.fw_info_size] = 0;
598 dev_dbg(hsw->dev, " Firmware info: %s \n", fw_ready.fw_info);
600 /* log the FW version info got from the mailbox here. */
601 memcpy(fw_info, fw_ready.fw_info, fw_ready.fw_info_size);
603 for (i = 0; i < sizeof(tmp) / sizeof(char *); i++)
604 tmp[i] = strsep(&pinfo, " ");
605 dev_info(hsw->dev, "FW loaded, mailbox readback FW info: type %s, - "
606 "version: %s.%s, build %s, source commit id: %s\n",
607 tmp[0], tmp[1], tmp[2], tmp[3], tmp[4]);
611 static void hsw_notification_work(struct work_struct *work)
613 struct sst_hsw_stream *stream = container_of(work,
614 struct sst_hsw_stream, notify_work);
615 struct sst_hsw_ipc_stream_glitch_position *glitch = &stream->glitch;
616 struct sst_hsw_ipc_stream_get_position *pos = &stream->rpos;
617 struct sst_hsw *hsw = stream->hsw;
620 reason = msg_get_notify_reason(stream->header);
624 trace_ipc_notification("DSP stream under/overrun",
625 stream->reply.stream_hw_id);
626 sst_dsp_inbox_read(hsw->dsp, glitch, sizeof(*glitch));
628 dev_err(hsw->dev, "glitch %d pos 0x%x write pos 0x%x\n",
629 glitch->glitch_type, glitch->present_pos,
633 case IPC_POSITION_CHANGED:
634 trace_ipc_notification("DSP stream position changed for",
635 stream->reply.stream_hw_id);
636 sst_dsp_inbox_read(hsw->dsp, pos, sizeof(*pos));
638 if (stream->notify_position)
639 stream->notify_position(stream, stream->pdata);
643 dev_err(hsw->dev, "error: unknown notification 0x%x\n",
648 /* tell DSP that notification has been handled */
649 sst_dsp_shim_update_bits(hsw->dsp, SST_IPCD,
650 SST_IPCD_BUSY | SST_IPCD_DONE, SST_IPCD_DONE);
652 /* unmask busy interrupt */
653 sst_dsp_shim_update_bits(hsw->dsp, SST_IMRX, SST_IMRX_BUSY, 0);
656 static struct ipc_message *reply_find_msg(struct sst_hsw *hsw, u32 header)
658 struct ipc_message *msg;
660 /* clear reply bits & status bits */
661 header &= ~(IPC_STATUS_MASK | IPC_GLB_REPLY_MASK);
663 if (list_empty(&hsw->rx_list)) {
664 dev_err(hsw->dev, "error: rx list empty but received 0x%x\n",
669 list_for_each_entry(msg, &hsw->rx_list, list) {
670 if (msg->header == header)
677 static void hsw_stream_update(struct sst_hsw *hsw, struct ipc_message *msg)
679 struct sst_hsw_stream *stream;
680 u32 header = msg->header & ~(IPC_STATUS_MASK | IPC_GLB_REPLY_MASK);
681 u32 stream_id = msg_get_stream_id(header);
682 u32 stream_msg = msg_get_stream_type(header);
684 stream = get_stream_by_id(hsw, stream_id);
688 switch (stream_msg) {
689 case IPC_STR_STAGE_MESSAGE:
690 case IPC_STR_NOTIFICATION:
693 trace_ipc_notification("stream reset", stream->reply.stream_hw_id);
696 stream->running = false;
697 trace_ipc_notification("stream paused",
698 stream->reply.stream_hw_id);
701 stream->running = true;
702 trace_ipc_notification("stream running",
703 stream->reply.stream_hw_id);
708 static int hsw_process_reply(struct sst_hsw *hsw, u32 header)
710 struct ipc_message *msg;
711 u32 reply = msg_get_global_reply(header);
713 trace_ipc_reply("processing -->", header);
715 msg = reply_find_msg(hsw, header);
717 trace_ipc_error("error: can't find message header", header);
721 /* first process the header */
723 case IPC_GLB_REPLY_PENDING:
724 trace_ipc_pending_reply("received", header);
728 case IPC_GLB_REPLY_SUCCESS:
730 trace_ipc_pending_reply("completed", header);
731 sst_dsp_inbox_read(hsw->dsp, msg->rx_data,
733 hsw->pending = false;
735 /* copy data from the DSP */
736 sst_dsp_outbox_read(hsw->dsp, msg->rx_data,
740 /* these will be rare - but useful for debug */
741 case IPC_GLB_REPLY_UNKNOWN_MESSAGE_TYPE:
742 trace_ipc_error("error: unknown message type", header);
743 msg->errno = -EBADMSG;
745 case IPC_GLB_REPLY_OUT_OF_RESOURCES:
746 trace_ipc_error("error: out of resources", header);
747 msg->errno = -ENOMEM;
749 case IPC_GLB_REPLY_BUSY:
750 trace_ipc_error("error: reply busy", header);
753 case IPC_GLB_REPLY_FAILURE:
754 trace_ipc_error("error: reply failure", header);
755 msg->errno = -EINVAL;
757 case IPC_GLB_REPLY_STAGE_UNINITIALIZED:
758 trace_ipc_error("error: stage uninitialized", header);
759 msg->errno = -EINVAL;
761 case IPC_GLB_REPLY_NOT_FOUND:
762 trace_ipc_error("error: reply not found", header);
763 msg->errno = -EINVAL;
765 case IPC_GLB_REPLY_SOURCE_NOT_STARTED:
766 trace_ipc_error("error: source not started", header);
767 msg->errno = -EINVAL;
769 case IPC_GLB_REPLY_INVALID_REQUEST:
770 trace_ipc_error("error: invalid request", header);
771 msg->errno = -EINVAL;
773 case IPC_GLB_REPLY_ERROR_INVALID_PARAM:
774 trace_ipc_error("error: invalid parameter", header);
775 msg->errno = -EINVAL;
778 trace_ipc_error("error: unknown reply", header);
779 msg->errno = -EINVAL;
783 /* update any stream states */
784 if (msg_get_global_type(header) == IPC_GLB_STREAM_MESSAGE)
785 hsw_stream_update(hsw, msg);
787 /* wake up and return the error if we have waiters on this message ? */
788 list_del(&msg->list);
789 tx_msg_reply_complete(hsw, msg);
794 static int hsw_stream_message(struct sst_hsw *hsw, u32 header)
796 u32 stream_msg, stream_id, stage_type;
797 struct sst_hsw_stream *stream;
800 stream_msg = msg_get_stream_type(header);
801 stream_id = msg_get_stream_id(header);
802 stage_type = msg_get_stage_type(header);
804 stream = get_stream_by_id(hsw, stream_id);
808 stream->header = header;
810 switch (stream_msg) {
811 case IPC_STR_STAGE_MESSAGE:
812 dev_err(hsw->dev, "error: stage msg not implemented 0x%8.8x\n",
815 case IPC_STR_NOTIFICATION:
816 schedule_work(&stream->notify_work);
819 /* handle pending message complete request */
820 handled = hsw_process_reply(hsw, header);
827 static int hsw_log_message(struct sst_hsw *hsw, u32 header)
829 u32 operation = (header & IPC_LOG_OP_MASK) >> IPC_LOG_OP_SHIFT;
830 struct sst_hsw_log_stream *stream = &hsw->log_stream;
833 if (operation != IPC_DEBUG_REQUEST_LOG_DUMP) {
835 "error: log msg not implemented 0x%8.8x\n", header);
839 mutex_lock(&stream->rw_mutex);
840 stream->last_pos = stream->curr_pos;
842 hsw->dsp, &stream->curr_pos, sizeof(stream->curr_pos));
843 mutex_unlock(&stream->rw_mutex);
845 schedule_work(&stream->notify_work);
850 static int hsw_process_notification(struct sst_hsw *hsw)
852 struct sst_dsp *sst = hsw->dsp;
856 header = sst_dsp_shim_read_unlocked(sst, SST_IPCD);
857 type = msg_get_global_type(header);
859 trace_ipc_request("processing -->", header);
861 /* FW Ready is a special case */
862 if (!hsw->boot_complete && header & IPC_FW_READY) {
863 hsw_fw_ready(hsw, header);
868 case IPC_GLB_GET_FW_VERSION:
869 case IPC_GLB_ALLOCATE_STREAM:
870 case IPC_GLB_FREE_STREAM:
871 case IPC_GLB_GET_FW_CAPABILITIES:
872 case IPC_GLB_REQUEST_DUMP:
873 case IPC_GLB_GET_DEVICE_FORMATS:
874 case IPC_GLB_SET_DEVICE_FORMATS:
875 case IPC_GLB_ENTER_DX_STATE:
876 case IPC_GLB_GET_MIXER_STREAM_INFO:
877 case IPC_GLB_MAX_IPC_MESSAGE_TYPE:
878 case IPC_GLB_RESTORE_CONTEXT:
879 case IPC_GLB_SHORT_REPLY:
880 dev_err(hsw->dev, "error: message type %d header 0x%x\n",
883 case IPC_GLB_STREAM_MESSAGE:
884 handled = hsw_stream_message(hsw, header);
886 case IPC_GLB_DEBUG_LOG_MESSAGE:
887 handled = hsw_log_message(hsw, header);
890 dev_err(hsw->dev, "error: unexpected type %d hdr 0x%8.8x\n",
898 static irqreturn_t hsw_irq_thread(int irq, void *context)
900 struct sst_dsp *sst = (struct sst_dsp *) context;
901 struct sst_hsw *hsw = sst_dsp_get_thread_context(sst);
906 spin_lock_irqsave(&sst->spinlock, flags);
908 ipcx = sst_dsp_ipc_msg_rx(hsw->dsp);
909 ipcd = sst_dsp_shim_read_unlocked(sst, SST_IPCD);
911 /* reply message from DSP */
912 if (ipcx & SST_IPCX_DONE) {
914 /* Handle Immediate reply from DSP Core */
915 handled = hsw_process_reply(hsw, ipcx);
918 /* clear DONE bit - tell DSP we have completed */
919 sst_dsp_shim_update_bits_unlocked(sst, SST_IPCX,
922 /* unmask Done interrupt */
923 sst_dsp_shim_update_bits_unlocked(sst, SST_IMRX,
928 /* new message from DSP */
929 if (ipcd & SST_IPCD_BUSY) {
931 /* Handle Notification and Delayed reply from DSP Core */
932 handled = hsw_process_notification(hsw);
934 /* clear BUSY bit and set DONE bit - accept new messages */
936 sst_dsp_shim_update_bits_unlocked(sst, SST_IPCD,
937 SST_IPCD_BUSY | SST_IPCD_DONE, SST_IPCD_DONE);
939 /* unmask busy interrupt */
940 sst_dsp_shim_update_bits_unlocked(sst, SST_IMRX,
945 spin_unlock_irqrestore(&sst->spinlock, flags);
947 /* continue to send any remaining messages... */
948 queue_kthread_work(&hsw->kworker, &hsw->kwork);
953 int sst_hsw_fw_get_version(struct sst_hsw *hsw,
954 struct sst_hsw_ipc_fw_version *version)
958 ret = ipc_tx_message_wait(hsw, IPC_GLB_TYPE(IPC_GLB_GET_FW_VERSION),
959 NULL, 0, version, sizeof(*version));
961 dev_err(hsw->dev, "error: get version failed\n");
967 int sst_hsw_stream_get_volume(struct sst_hsw *hsw, struct sst_hsw_stream *stream,
968 u32 stage_id, u32 channel, u32 *volume)
973 sst_dsp_read(hsw->dsp, volume,
974 stream->reply.volume_register_address[channel],
981 int sst_hsw_stream_set_volume(struct sst_hsw *hsw,
982 struct sst_hsw_stream *stream, u32 stage_id, u32 channel, u32 volume)
984 struct sst_hsw_ipc_volume_req *req;
988 trace_ipc_request("set stream volume", stream->reply.stream_hw_id);
990 if (channel >= 2 && channel != SST_HSW_CHANNELS_ALL)
993 header = IPC_GLB_TYPE(IPC_GLB_STREAM_MESSAGE) |
994 IPC_STR_TYPE(IPC_STR_STAGE_MESSAGE);
995 header |= (stream->reply.stream_hw_id << IPC_STR_ID_SHIFT);
996 header |= (IPC_STG_SET_VOLUME << IPC_STG_TYPE_SHIFT);
997 header |= (stage_id << IPC_STG_ID_SHIFT);
999 req = &stream->vol_req;
1000 req->target_volume = volume;
1002 /* set both at same time ? */
1003 if (channel == SST_HSW_CHANNELS_ALL) {
1004 if (hsw->mute[0] && hsw->mute[1]) {
1005 hsw->mute_volume[0] = hsw->mute_volume[1] = volume;
1007 } else if (hsw->mute[0])
1009 else if (hsw->mute[1])
1012 req->channel = SST_HSW_CHANNELS_ALL;
1014 /* set only 1 channel */
1015 if (hsw->mute[channel]) {
1016 hsw->mute_volume[channel] = volume;
1019 req->channel = channel;
1022 ret = ipc_tx_message_wait(hsw, header, req, sizeof(*req), NULL, 0);
1024 dev_err(hsw->dev, "error: set stream volume failed\n");
1031 int sst_hsw_mixer_get_volume(struct sst_hsw *hsw, u32 stage_id, u32 channel,
1037 sst_dsp_read(hsw->dsp, volume,
1038 hsw->mixer_info.volume_register_address[channel],
1044 /* global mixer volume */
1045 int sst_hsw_mixer_set_volume(struct sst_hsw *hsw, u32 stage_id, u32 channel,
1048 struct sst_hsw_ipc_volume_req req;
1052 trace_ipc_request("set mixer volume", volume);
1054 if (channel >= 2 && channel != SST_HSW_CHANNELS_ALL)
1057 /* set both at same time ? */
1058 if (channel == SST_HSW_CHANNELS_ALL) {
1059 if (hsw->mute[0] && hsw->mute[1]) {
1060 hsw->mute_volume[0] = hsw->mute_volume[1] = volume;
1062 } else if (hsw->mute[0])
1064 else if (hsw->mute[1])
1067 req.channel = SST_HSW_CHANNELS_ALL;
1069 /* set only 1 channel */
1070 if (hsw->mute[channel]) {
1071 hsw->mute_volume[channel] = volume;
1074 req.channel = channel;
1077 header = IPC_GLB_TYPE(IPC_GLB_STREAM_MESSAGE) |
1078 IPC_STR_TYPE(IPC_STR_STAGE_MESSAGE);
1079 header |= (hsw->mixer_info.mixer_hw_id << IPC_STR_ID_SHIFT);
1080 header |= (IPC_STG_SET_VOLUME << IPC_STG_TYPE_SHIFT);
1081 header |= (stage_id << IPC_STG_ID_SHIFT);
1083 req.curve_duration = hsw->curve_duration;
1084 req.curve_type = hsw->curve_type;
1085 req.target_volume = volume;
1087 ret = ipc_tx_message_wait(hsw, header, &req, sizeof(req), NULL, 0);
1089 dev_err(hsw->dev, "error: set mixer volume failed\n");
1097 struct sst_hsw_stream *sst_hsw_stream_new(struct sst_hsw *hsw, int id,
1098 u32 (*notify_position)(struct sst_hsw_stream *stream, void *data),
1101 struct sst_hsw_stream *stream;
1102 struct sst_dsp *sst = hsw->dsp;
1103 unsigned long flags;
1105 stream = kzalloc(sizeof(*stream), GFP_KERNEL);
1109 spin_lock_irqsave(&sst->spinlock, flags);
1110 stream->reply.stream_hw_id = INVALID_STREAM_HW_ID;
1111 list_add(&stream->node, &hsw->stream_list);
1112 stream->notify_position = notify_position;
1113 stream->pdata = data;
1115 stream->host_id = id;
1117 /* work to process notification messages */
1118 INIT_WORK(&stream->notify_work, hsw_notification_work);
1119 spin_unlock_irqrestore(&sst->spinlock, flags);
1124 int sst_hsw_stream_free(struct sst_hsw *hsw, struct sst_hsw_stream *stream)
1128 struct sst_dsp *sst = hsw->dsp;
1129 unsigned long flags;
1132 dev_warn(hsw->dev, "warning: stream is NULL, no stream to free, ignore it.\n");
1136 /* dont free DSP streams that are not commited */
1137 if (!stream->commited)
1140 trace_ipc_request("stream free", stream->host_id);
1142 stream->free_req.stream_id = stream->reply.stream_hw_id;
1143 header = IPC_GLB_TYPE(IPC_GLB_FREE_STREAM);
1145 ret = ipc_tx_message_wait(hsw, header, &stream->free_req,
1146 sizeof(stream->free_req), NULL, 0);
1148 dev_err(hsw->dev, "error: free stream %d failed\n",
1149 stream->free_req.stream_id);
1153 trace_hsw_stream_free_req(stream, &stream->free_req);
1156 cancel_work_sync(&stream->notify_work);
1157 spin_lock_irqsave(&sst->spinlock, flags);
1158 list_del(&stream->node);
1160 spin_unlock_irqrestore(&sst->spinlock, flags);
1165 int sst_hsw_stream_set_bits(struct sst_hsw *hsw,
1166 struct sst_hsw_stream *stream, enum sst_hsw_bitdepth bits)
1168 if (stream->commited) {
1169 dev_err(hsw->dev, "error: stream committed for set bits\n");
1173 stream->request.format.bitdepth = bits;
1177 int sst_hsw_stream_set_channels(struct sst_hsw *hsw,
1178 struct sst_hsw_stream *stream, int channels)
1180 if (stream->commited) {
1181 dev_err(hsw->dev, "error: stream committed for set channels\n");
1185 stream->request.format.ch_num = channels;
1189 int sst_hsw_stream_set_rate(struct sst_hsw *hsw,
1190 struct sst_hsw_stream *stream, int rate)
1192 if (stream->commited) {
1193 dev_err(hsw->dev, "error: stream committed for set rate\n");
1197 stream->request.format.frequency = rate;
1201 int sst_hsw_stream_set_map_config(struct sst_hsw *hsw,
1202 struct sst_hsw_stream *stream, u32 map,
1203 enum sst_hsw_channel_config config)
1205 if (stream->commited) {
1206 dev_err(hsw->dev, "error: stream committed for set map\n");
1210 stream->request.format.map = map;
1211 stream->request.format.config = config;
1215 int sst_hsw_stream_set_style(struct sst_hsw *hsw,
1216 struct sst_hsw_stream *stream, enum sst_hsw_interleaving style)
1218 if (stream->commited) {
1219 dev_err(hsw->dev, "error: stream committed for set style\n");
1223 stream->request.format.style = style;
1227 int sst_hsw_stream_set_valid(struct sst_hsw *hsw,
1228 struct sst_hsw_stream *stream, u32 bits)
1230 if (stream->commited) {
1231 dev_err(hsw->dev, "error: stream committed for set valid bits\n");
1235 stream->request.format.valid_bit = bits;
1239 /* Stream Configuration */
1240 int sst_hsw_stream_format(struct sst_hsw *hsw, struct sst_hsw_stream *stream,
1241 enum sst_hsw_stream_path_id path_id,
1242 enum sst_hsw_stream_type stream_type,
1243 enum sst_hsw_stream_format format_id)
1245 if (stream->commited) {
1246 dev_err(hsw->dev, "error: stream committed for set format\n");
1250 stream->request.path_id = path_id;
1251 stream->request.stream_type = stream_type;
1252 stream->request.format_id = format_id;
1254 trace_hsw_stream_alloc_request(stream, &stream->request);
1259 int sst_hsw_stream_buffer(struct sst_hsw *hsw, struct sst_hsw_stream *stream,
1260 u32 ring_pt_address, u32 num_pages,
1261 u32 ring_size, u32 ring_offset, u32 ring_first_pfn)
1263 if (stream->commited) {
1264 dev_err(hsw->dev, "error: stream committed for buffer\n");
1268 stream->request.ringinfo.ring_pt_address = ring_pt_address;
1269 stream->request.ringinfo.num_pages = num_pages;
1270 stream->request.ringinfo.ring_size = ring_size;
1271 stream->request.ringinfo.ring_offset = ring_offset;
1272 stream->request.ringinfo.ring_first_pfn = ring_first_pfn;
1274 trace_hsw_stream_buffer(stream);
1279 int sst_hsw_stream_set_module_info(struct sst_hsw *hsw,
1280 struct sst_hsw_stream *stream, struct sst_module_runtime *runtime)
1282 struct sst_hsw_module_map *map = &stream->request.map;
1283 struct sst_dsp *dsp = sst_hsw_get_dsp(hsw);
1284 struct sst_module *module = runtime->module;
1286 if (stream->commited) {
1287 dev_err(hsw->dev, "error: stream committed for set module\n");
1291 /* only support initial module atm */
1292 map->module_entries_count = 1;
1293 map->module_entries[0].module_id = module->id;
1294 map->module_entries[0].entry_point = module->entry;
1296 stream->request.persistent_mem.offset =
1297 sst_dsp_get_offset(dsp, runtime->persistent_offset, SST_MEM_DRAM);
1298 stream->request.persistent_mem.size = module->persistent_size;
1300 stream->request.scratch_mem.offset =
1301 sst_dsp_get_offset(dsp, dsp->scratch_offset, SST_MEM_DRAM);
1302 stream->request.scratch_mem.size = dsp->scratch_size;
1304 dev_dbg(hsw->dev, "module %d runtime %d using:\n", module->id,
1306 dev_dbg(hsw->dev, " persistent offset 0x%x bytes 0x%x\n",
1307 stream->request.persistent_mem.offset,
1308 stream->request.persistent_mem.size);
1309 dev_dbg(hsw->dev, " scratch offset 0x%x bytes 0x%x\n",
1310 stream->request.scratch_mem.offset,
1311 stream->request.scratch_mem.size);
1316 int sst_hsw_stream_commit(struct sst_hsw *hsw, struct sst_hsw_stream *stream)
1318 struct sst_hsw_ipc_stream_alloc_req *str_req = &stream->request;
1319 struct sst_hsw_ipc_stream_alloc_reply *reply = &stream->reply;
1324 dev_warn(hsw->dev, "warning: stream is NULL, no stream to commit, ignore it.\n");
1328 if (stream->commited) {
1329 dev_warn(hsw->dev, "warning: stream is already committed, ignore it.\n");
1333 trace_ipc_request("stream alloc", stream->host_id);
1335 header = IPC_GLB_TYPE(IPC_GLB_ALLOCATE_STREAM);
1337 ret = ipc_tx_message_wait(hsw, header, str_req, sizeof(*str_req),
1338 reply, sizeof(*reply));
1340 dev_err(hsw->dev, "error: stream commit failed\n");
1344 stream->commited = 1;
1345 trace_hsw_stream_alloc_reply(stream);
1350 /* Stream Information - these calls could be inline but we want the IPC
1351 ABI to be opaque to client PCM drivers to cope with any future ABI changes */
1352 int sst_hsw_mixer_get_info(struct sst_hsw *hsw)
1354 struct sst_hsw_ipc_stream_info_reply *reply;
1358 reply = &hsw->mixer_info;
1359 header = IPC_GLB_TYPE(IPC_GLB_GET_MIXER_STREAM_INFO);
1361 trace_ipc_request("get global mixer info", 0);
1363 ret = ipc_tx_message_wait(hsw, header, NULL, 0, reply, sizeof(*reply));
1365 dev_err(hsw->dev, "error: get stream info failed\n");
1369 trace_hsw_mixer_info_reply(reply);
1374 /* Send stream command */
1375 static int sst_hsw_stream_operations(struct sst_hsw *hsw, int type,
1376 int stream_id, int wait)
1380 header = IPC_GLB_TYPE(IPC_GLB_STREAM_MESSAGE) | IPC_STR_TYPE(type);
1381 header |= (stream_id << IPC_STR_ID_SHIFT);
1384 return ipc_tx_message_wait(hsw, header, NULL, 0, NULL, 0);
1386 return ipc_tx_message_nowait(hsw, header, NULL, 0);
1389 /* Stream ALSA trigger operations */
1390 int sst_hsw_stream_pause(struct sst_hsw *hsw, struct sst_hsw_stream *stream,
1396 dev_warn(hsw->dev, "warning: stream is NULL, no stream to pause, ignore it.\n");
1400 trace_ipc_request("stream pause", stream->reply.stream_hw_id);
1402 ret = sst_hsw_stream_operations(hsw, IPC_STR_PAUSE,
1403 stream->reply.stream_hw_id, wait);
1405 dev_err(hsw->dev, "error: failed to pause stream %d\n",
1406 stream->reply.stream_hw_id);
1411 int sst_hsw_stream_resume(struct sst_hsw *hsw, struct sst_hsw_stream *stream,
1417 dev_warn(hsw->dev, "warning: stream is NULL, no stream to resume, ignore it.\n");
1421 trace_ipc_request("stream resume", stream->reply.stream_hw_id);
1423 ret = sst_hsw_stream_operations(hsw, IPC_STR_RESUME,
1424 stream->reply.stream_hw_id, wait);
1426 dev_err(hsw->dev, "error: failed to resume stream %d\n",
1427 stream->reply.stream_hw_id);
1432 int sst_hsw_stream_reset(struct sst_hsw *hsw, struct sst_hsw_stream *stream)
1434 int ret, tries = 10;
1437 dev_warn(hsw->dev, "warning: stream is NULL, no stream to reset, ignore it.\n");
1441 /* dont reset streams that are not commited */
1442 if (!stream->commited)
1445 /* wait for pause to complete before we reset the stream */
1446 while (stream->running && tries--)
1449 dev_err(hsw->dev, "error: reset stream %d still running\n",
1450 stream->reply.stream_hw_id);
1454 trace_ipc_request("stream reset", stream->reply.stream_hw_id);
1456 ret = sst_hsw_stream_operations(hsw, IPC_STR_RESET,
1457 stream->reply.stream_hw_id, 1);
1459 dev_err(hsw->dev, "error: failed to reset stream %d\n",
1460 stream->reply.stream_hw_id);
1464 /* Stream pointer positions */
1465 u32 sst_hsw_get_dsp_position(struct sst_hsw *hsw,
1466 struct sst_hsw_stream *stream)
1470 sst_dsp_read(hsw->dsp, &rpos,
1471 stream->reply.read_position_register_address, sizeof(rpos));
1476 /* Stream presentation (monotonic) positions */
1477 u64 sst_hsw_get_dsp_presentation_position(struct sst_hsw *hsw,
1478 struct sst_hsw_stream *stream)
1482 sst_dsp_read(hsw->dsp, &ppos,
1483 stream->reply.presentation_position_register_address,
1489 /* physical BE config */
1490 int sst_hsw_device_set_config(struct sst_hsw *hsw,
1491 enum sst_hsw_device_id dev, enum sst_hsw_device_mclk mclk,
1492 enum sst_hsw_device_mode mode, u32 clock_divider)
1494 struct sst_hsw_ipc_device_config_req config;
1498 trace_ipc_request("set device config", dev);
1500 config.ssp_interface = dev;
1501 config.clock_frequency = mclk;
1503 config.clock_divider = clock_divider;
1504 if (mode == SST_HSW_DEVICE_TDM_CLOCK_MASTER)
1505 config.channels = 4;
1507 config.channels = 2;
1509 trace_hsw_device_config_req(&config);
1511 header = IPC_GLB_TYPE(IPC_GLB_SET_DEVICE_FORMATS);
1513 ret = ipc_tx_message_wait(hsw, header, &config, sizeof(config),
1516 dev_err(hsw->dev, "error: set device formats failed\n");
1520 EXPORT_SYMBOL_GPL(sst_hsw_device_set_config);
1523 int sst_hsw_dx_set_state(struct sst_hsw *hsw,
1524 enum sst_hsw_dx_state state, struct sst_hsw_ipc_dx_reply *dx)
1529 header = IPC_GLB_TYPE(IPC_GLB_ENTER_DX_STATE);
1532 trace_ipc_request("PM enter Dx state", state);
1534 ret = ipc_tx_message_wait(hsw, header, &state_, sizeof(state_),
1537 dev_err(hsw->dev, "ipc: error set dx state %d failed\n", state);
1541 for (item = 0; item < dx->entries_no; item++) {
1543 "Item[%d] offset[%x] - size[%x] - source[%x]\n",
1544 item, dx->mem_info[item].offset,
1545 dx->mem_info[item].size,
1546 dx->mem_info[item].source);
1548 dev_dbg(hsw->dev, "ipc: got %d entry numbers for state %d\n",
1549 dx->entries_no, state);
1554 struct sst_module_runtime *sst_hsw_runtime_module_create(struct sst_hsw *hsw,
1555 int mod_id, int offset)
1557 struct sst_dsp *dsp = hsw->dsp;
1558 struct sst_module *module;
1559 struct sst_module_runtime *runtime;
1562 module = sst_module_get_from_id(dsp, mod_id);
1563 if (module == NULL) {
1564 dev_err(dsp->dev, "error: failed to get module %d for pcm\n",
1569 runtime = sst_module_runtime_new(module, mod_id, NULL);
1570 if (runtime == NULL) {
1571 dev_err(dsp->dev, "error: failed to create module %d runtime\n",
1576 err = sst_module_runtime_alloc_blocks(runtime, offset);
1578 dev_err(dsp->dev, "error: failed to alloc blocks for module %d runtime\n",
1580 sst_module_runtime_free(runtime);
1584 dev_dbg(dsp->dev, "runtime id %d created for module %d\n", runtime->id,
1589 void sst_hsw_runtime_module_free(struct sst_module_runtime *runtime)
1591 sst_module_runtime_free_blocks(runtime);
1592 sst_module_runtime_free(runtime);
1596 static int sst_hsw_dx_state_dump(struct sst_hsw *hsw)
1598 struct sst_dsp *sst = hsw->dsp;
1599 u32 item, offset, size;
1602 trace_ipc_request("PM state dump. Items #", SST_HSW_MAX_DX_REGIONS);
1604 if (hsw->dx.entries_no > SST_HSW_MAX_DX_REGIONS) {
1606 "error: number of FW context regions greater than %d\n",
1607 SST_HSW_MAX_DX_REGIONS);
1608 memset(&hsw->dx, 0, sizeof(hsw->dx));
1612 ret = sst_dsp_dma_get_channel(sst, 0);
1614 dev_err(hsw->dev, "error: cant allocate dma channel %d\n", ret);
1618 /* set on-demond mode on engine 0 channel 3 */
1619 sst_dsp_shim_update_bits(sst, SST_HMDC,
1620 SST_HMDC_HDDA_E0_ALLCH | SST_HMDC_HDDA_E1_ALLCH,
1621 SST_HMDC_HDDA_E0_ALLCH | SST_HMDC_HDDA_E1_ALLCH);
1623 for (item = 0; item < hsw->dx.entries_no; item++) {
1624 if (hsw->dx.mem_info[item].source == SST_HSW_DX_TYPE_MEMORY_DUMP
1625 && hsw->dx.mem_info[item].offset > DSP_DRAM_ADDR_OFFSET
1626 && hsw->dx.mem_info[item].offset <
1627 DSP_DRAM_ADDR_OFFSET + SST_HSW_DX_CONTEXT_SIZE) {
1629 offset = hsw->dx.mem_info[item].offset
1630 - DSP_DRAM_ADDR_OFFSET;
1631 size = (hsw->dx.mem_info[item].size + 3) & (~3);
1633 ret = sst_dsp_dma_copyfrom(sst, hsw->dx_context_paddr + offset,
1634 sst->addr.lpe_base + offset, size);
1637 "error: FW context dump failed\n");
1638 memset(&hsw->dx, 0, sizeof(hsw->dx));
1645 sst_dsp_dma_put_channel(sst);
1649 static int sst_hsw_dx_state_restore(struct sst_hsw *hsw)
1651 struct sst_dsp *sst = hsw->dsp;
1652 u32 item, offset, size;
1655 for (item = 0; item < hsw->dx.entries_no; item++) {
1656 if (hsw->dx.mem_info[item].source == SST_HSW_DX_TYPE_MEMORY_DUMP
1657 && hsw->dx.mem_info[item].offset > DSP_DRAM_ADDR_OFFSET
1658 && hsw->dx.mem_info[item].offset <
1659 DSP_DRAM_ADDR_OFFSET + SST_HSW_DX_CONTEXT_SIZE) {
1661 offset = hsw->dx.mem_info[item].offset
1662 - DSP_DRAM_ADDR_OFFSET;
1663 size = (hsw->dx.mem_info[item].size + 3) & (~3);
1665 ret = sst_dsp_dma_copyto(sst, sst->addr.lpe_base + offset,
1666 hsw->dx_context_paddr + offset, size);
1669 "error: FW context restore failed\n");
1678 static void sst_hsw_drop_all(struct sst_hsw *hsw)
1680 struct ipc_message *msg, *tmp;
1681 unsigned long flags;
1682 int tx_drop_cnt = 0, rx_drop_cnt = 0;
1684 /* drop all TX and Rx messages before we stall + reset DSP */
1685 spin_lock_irqsave(&hsw->dsp->spinlock, flags);
1687 list_for_each_entry_safe(msg, tmp, &hsw->tx_list, list) {
1688 list_move(&msg->list, &hsw->empty_list);
1692 list_for_each_entry_safe(msg, tmp, &hsw->rx_list, list) {
1693 list_move(&msg->list, &hsw->empty_list);
1697 spin_unlock_irqrestore(&hsw->dsp->spinlock, flags);
1699 if (tx_drop_cnt || rx_drop_cnt)
1700 dev_err(hsw->dev, "dropped IPC msg RX=%d, TX=%d\n",
1701 tx_drop_cnt, rx_drop_cnt);
1704 int sst_hsw_dsp_load(struct sst_hsw *hsw)
1706 struct sst_dsp *dsp = hsw->dsp;
1709 dev_dbg(hsw->dev, "loading audio DSP....");
1711 ret = sst_dsp_wake(dsp);
1713 dev_err(hsw->dev, "error: failed to wake audio DSP\n");
1717 ret = sst_dsp_dma_get_channel(dsp, 0);
1719 dev_err(hsw->dev, "error: cant allocate dma channel %d\n", ret);
1723 ret = sst_fw_reload(hsw->sst_fw);
1725 dev_err(hsw->dev, "error: SST FW reload failed\n");
1726 sst_dsp_dma_put_channel(dsp);
1730 sst_dsp_dma_put_channel(dsp);
1734 static int sst_hsw_dsp_restore(struct sst_hsw *hsw)
1736 struct sst_dsp *dsp = hsw->dsp;
1739 dev_dbg(hsw->dev, "restoring audio DSP....");
1741 ret = sst_dsp_dma_get_channel(dsp, 0);
1743 dev_err(hsw->dev, "error: cant allocate dma channel %d\n", ret);
1747 ret = sst_hsw_dx_state_restore(hsw);
1749 dev_err(hsw->dev, "error: SST FW context restore failed\n");
1750 sst_dsp_dma_put_channel(dsp);
1753 sst_dsp_dma_put_channel(dsp);
1755 /* wait for DSP boot completion */
1761 int sst_hsw_dsp_runtime_suspend(struct sst_hsw *hsw)
1765 dev_dbg(hsw->dev, "audio dsp runtime suspend\n");
1767 ret = sst_hsw_dx_set_state(hsw, SST_HSW_DX_STATE_D3, &hsw->dx);
1771 sst_dsp_stall(hsw->dsp);
1773 ret = sst_hsw_dx_state_dump(hsw);
1777 sst_hsw_drop_all(hsw);
1782 int sst_hsw_dsp_runtime_sleep(struct sst_hsw *hsw)
1784 sst_fw_unload(hsw->sst_fw);
1785 sst_block_free_scratch(hsw->dsp);
1787 hsw->boot_complete = false;
1789 sst_dsp_sleep(hsw->dsp);
1794 int sst_hsw_dsp_runtime_resume(struct sst_hsw *hsw)
1796 struct device *dev = hsw->dev;
1799 dev_dbg(dev, "audio dsp runtime resume\n");
1801 if (hsw->boot_complete)
1802 return 1; /* tell caller no action is required */
1804 ret = sst_hsw_dsp_restore(hsw);
1806 dev_err(dev, "error: audio DSP boot failure\n");
1808 ret = wait_event_timeout(hsw->boot_wait, hsw->boot_complete,
1809 msecs_to_jiffies(IPC_BOOT_MSECS));
1811 dev_err(hsw->dev, "error: audio DSP boot timeout IPCD 0x%x IPCX 0x%x\n",
1812 sst_dsp_shim_read_unlocked(hsw->dsp, SST_IPCD),
1813 sst_dsp_shim_read_unlocked(hsw->dsp, SST_IPCX));
1817 /* Set ADSP SSP port settings */
1818 ret = sst_hsw_device_set_config(hsw, SST_HSW_DEVICE_SSP_0,
1819 SST_HSW_DEVICE_MCLK_FREQ_24_MHZ,
1820 SST_HSW_DEVICE_CLOCK_MASTER, 9);
1822 dev_err(dev, "error: SSP re-initialization failed\n");
1828 static int msg_empty_list_init(struct sst_hsw *hsw)
1832 hsw->msg = kzalloc(sizeof(struct ipc_message) *
1833 IPC_EMPTY_LIST_SIZE, GFP_KERNEL);
1834 if (hsw->msg == NULL)
1837 for (i = 0; i < IPC_EMPTY_LIST_SIZE; i++) {
1838 init_waitqueue_head(&hsw->msg[i].waitq);
1839 list_add(&hsw->msg[i].list, &hsw->empty_list);
1845 struct sst_dsp *sst_hsw_get_dsp(struct sst_hsw *hsw)
1850 static struct sst_dsp_device hsw_dev = {
1851 .thread = hsw_irq_thread,
1852 .ops = &haswell_ops,
1855 int sst_hsw_dsp_init(struct device *dev, struct sst_pdata *pdata)
1857 struct sst_hsw_ipc_fw_version version;
1858 struct sst_hsw *hsw;
1861 dev_dbg(dev, "initialising Audio DSP IPC\n");
1863 hsw = devm_kzalloc(dev, sizeof(*hsw), GFP_KERNEL);
1868 INIT_LIST_HEAD(&hsw->stream_list);
1869 INIT_LIST_HEAD(&hsw->tx_list);
1870 INIT_LIST_HEAD(&hsw->rx_list);
1871 INIT_LIST_HEAD(&hsw->empty_list);
1872 init_waitqueue_head(&hsw->boot_wait);
1873 init_waitqueue_head(&hsw->wait_txq);
1875 ret = msg_empty_list_init(hsw);
1879 /* start the IPC message thread */
1880 init_kthread_worker(&hsw->kworker);
1881 hsw->tx_thread = kthread_run(kthread_worker_fn,
1882 &hsw->kworker, "%s",
1883 dev_name(hsw->dev));
1884 if (IS_ERR(hsw->tx_thread)) {
1885 ret = PTR_ERR(hsw->tx_thread);
1886 dev_err(hsw->dev, "error: failed to create message TX task\n");
1889 init_kthread_work(&hsw->kwork, ipc_tx_msgs);
1891 hsw_dev.thread_context = hsw;
1894 hsw->dsp = sst_dsp_new(dev, &hsw_dev, pdata);
1895 if (hsw->dsp == NULL) {
1900 /* allocate DMA buffer for context storage */
1901 hsw->dx_context = dma_alloc_coherent(hsw->dsp->dma_dev,
1902 SST_HSW_DX_CONTEXT_SIZE, &hsw->dx_context_paddr, GFP_KERNEL);
1903 if (hsw->dx_context == NULL) {
1908 /* keep the DSP in reset state for base FW loading */
1909 sst_dsp_reset(hsw->dsp);
1911 hsw->sst_fw = sst_fw_new(hsw->dsp, pdata->fw, hsw);
1912 if (hsw->sst_fw == NULL) {
1914 dev_err(dev, "error: failed to load firmware\n");
1918 /* wait for DSP boot completion */
1919 sst_dsp_boot(hsw->dsp);
1920 ret = wait_event_timeout(hsw->boot_wait, hsw->boot_complete,
1921 msecs_to_jiffies(IPC_BOOT_MSECS));
1924 dev_err(hsw->dev, "error: audio DSP boot timeout IPCD 0x%x IPCX 0x%x\n",
1925 sst_dsp_shim_read_unlocked(hsw->dsp, SST_IPCD),
1926 sst_dsp_shim_read_unlocked(hsw->dsp, SST_IPCX));
1930 /* get the FW version */
1931 sst_hsw_fw_get_version(hsw, &version);
1933 /* get the globalmixer */
1934 ret = sst_hsw_mixer_get_info(hsw);
1936 dev_err(hsw->dev, "error: failed to get stream info\n");
1944 sst_dsp_reset(hsw->dsp);
1945 sst_fw_free(hsw->sst_fw);
1947 dma_free_coherent(hsw->dsp->dma_dev, SST_HSW_DX_CONTEXT_SIZE,
1948 hsw->dx_context, hsw->dx_context_paddr);
1950 sst_dsp_free(hsw->dsp);
1952 kthread_stop(hsw->tx_thread);
1958 EXPORT_SYMBOL_GPL(sst_hsw_dsp_init);
1960 void sst_hsw_dsp_free(struct device *dev, struct sst_pdata *pdata)
1962 struct sst_hsw *hsw = pdata->dsp;
1964 sst_dsp_reset(hsw->dsp);
1965 sst_fw_free_all(hsw->dsp);
1966 dma_free_coherent(hsw->dsp->dma_dev, SST_HSW_DX_CONTEXT_SIZE,
1967 hsw->dx_context, hsw->dx_context_paddr);
1968 sst_dsp_free(hsw->dsp);
1969 kthread_stop(hsw->tx_thread);
1972 EXPORT_SYMBOL_GPL(sst_hsw_dsp_free);