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 /* Global Message - Types and Replies */
99 IPC_GLB_GET_FW_VERSION
= 0, /* Retrieves firmware version */
100 IPC_GLB_PERFORMANCE_MONITOR
= 1, /* Performance monitoring actions */
101 IPC_GLB_ALLOCATE_STREAM
= 3, /* Request to allocate new stream */
102 IPC_GLB_FREE_STREAM
= 4, /* Request to free stream */
103 IPC_GLB_GET_FW_CAPABILITIES
= 5, /* Retrieves firmware capabilities */
104 IPC_GLB_STREAM_MESSAGE
= 6, /* Message directed to stream or its stages */
105 /* Request to store firmware context during D0->D3 transition */
106 IPC_GLB_REQUEST_DUMP
= 7,
107 /* Request to restore firmware context during D3->D0 transition */
108 IPC_GLB_RESTORE_CONTEXT
= 8,
109 IPC_GLB_GET_DEVICE_FORMATS
= 9, /* Set device format */
110 IPC_GLB_SET_DEVICE_FORMATS
= 10, /* Get device format */
111 IPC_GLB_SHORT_REPLY
= 11,
112 IPC_GLB_ENTER_DX_STATE
= 12,
113 IPC_GLB_GET_MIXER_STREAM_INFO
= 13, /* Request mixer stream params */
114 IPC_GLB_DEBUG_LOG_MESSAGE
= 14, /* Message to or from the debug logger. */
115 IPC_GLB_REQUEST_TRANSFER
= 16, /* < Request Transfer for host */
116 IPC_GLB_MAX_IPC_MESSAGE_TYPE
= 17, /* Maximum message number */
120 IPC_GLB_REPLY_SUCCESS
= 0, /* The operation was successful. */
121 IPC_GLB_REPLY_ERROR_INVALID_PARAM
= 1, /* Invalid parameter was passed. */
122 IPC_GLB_REPLY_UNKNOWN_MESSAGE_TYPE
= 2, /* Uknown message type was resceived. */
123 IPC_GLB_REPLY_OUT_OF_RESOURCES
= 3, /* No resources to satisfy the request. */
124 IPC_GLB_REPLY_BUSY
= 4, /* The system or resource is busy. */
125 IPC_GLB_REPLY_PENDING
= 5, /* The action was scheduled for processing. */
126 IPC_GLB_REPLY_FAILURE
= 6, /* Critical error happened. */
127 IPC_GLB_REPLY_INVALID_REQUEST
= 7, /* Request can not be completed. */
128 IPC_GLB_REPLY_STAGE_UNINITIALIZED
= 8, /* Processing stage was uninitialized. */
129 IPC_GLB_REPLY_NOT_FOUND
= 9, /* Required resource can not be found. */
130 IPC_GLB_REPLY_SOURCE_NOT_STARTED
= 10, /* Source was not started. */
133 /* Stream Message - Types */
134 enum ipc_str_operation
{
138 IPC_STR_STAGE_MESSAGE
= 3,
139 IPC_STR_NOTIFICATION
= 4,
143 /* Stream Stage Message Types */
144 enum ipc_stg_operation
{
145 IPC_STG_GET_VOLUME
= 0,
147 IPC_STG_SET_WRITE_POSITION
,
148 IPC_STG_SET_FX_ENABLE
,
149 IPC_STG_SET_FX_DISABLE
,
150 IPC_STG_SET_FX_GET_PARAM
,
151 IPC_STG_SET_FX_SET_PARAM
,
152 IPC_STG_SET_FX_GET_INFO
,
153 IPC_STG_MUTE_LOOPBACK
,
157 /* Stream Stage Message Types For Notification*/
158 enum ipc_stg_operation_notify
{
159 IPC_POSITION_CHANGED
= 0,
164 enum ipc_glitch_type
{
165 IPC_GLITCH_UNDERRUN
= 1,
166 IPC_GLITCH_DECODER_ERROR
,
167 IPC_GLITCH_DOUBLED_WRITE_POS
,
172 enum ipc_debug_operation
{
173 IPC_DEBUG_ENABLE_LOG
= 0,
174 IPC_DEBUG_DISABLE_LOG
= 1,
175 IPC_DEBUG_REQUEST_LOG_DUMP
= 2,
176 IPC_DEBUG_NOTIFY_LOG_DUMP
= 3,
177 IPC_DEBUG_MAX_DEBUG_LOG
181 struct sst_hsw_ipc_fw_ready
{
187 u8 fw_info
[IPC_MAX_MAILBOX_BYTES
- 5 * sizeof(u32
)];
188 } __attribute__((packed
));
191 struct list_head list
;
194 /* direction wrt host CPU */
195 char tx_data
[IPC_MAX_MAILBOX_BYTES
];
197 char rx_data
[IPC_MAX_MAILBOX_BYTES
];
200 wait_queue_head_t waitq
;
207 struct sst_hsw_stream
;
210 /* Stream infomation */
211 struct sst_hsw_stream
{
213 struct sst_hsw_ipc_stream_alloc_req request
;
214 struct sst_hsw_ipc_stream_alloc_reply reply
;
215 struct sst_hsw_ipc_stream_free_req free_req
;
218 u32 mute_volume
[SST_HSW_NO_CHANNELS
];
219 u32 mute
[SST_HSW_NO_CHANNELS
];
227 /* Notification work */
228 struct work_struct notify_work
;
231 /* Position info from DSP */
232 struct sst_hsw_ipc_stream_set_position wpos
;
233 struct sst_hsw_ipc_stream_get_position rpos
;
234 struct sst_hsw_ipc_stream_glitch_position glitch
;
237 struct sst_hsw_ipc_volume_req vol_req
;
239 /* driver callback */
240 u32 (*notify_position
)(struct sst_hsw_stream
*stream
, void *data
);
243 struct list_head node
;
246 /* FW log ring information */
247 struct sst_hsw_log_stream
{
249 unsigned char *dma_area
;
250 unsigned char *ring_descr
;
254 /* Notification work */
255 struct work_struct notify_work
;
256 wait_queue_head_t readers_wait_q
;
257 struct mutex rw_mutex
;
264 u32 config
[SST_HSW_FW_LOG_CONFIG_DWORDS
];
269 /* SST Haswell IPC data */
273 struct platform_device
*pdev_pcm
;
276 struct sst_hsw_ipc_fw_ready fw_ready
;
277 struct sst_hsw_ipc_fw_version version
;
278 struct sst_module
*scratch
;
280 struct sst_fw
*sst_fw
;
283 struct list_head stream_list
;
286 struct sst_hsw_ipc_stream_info_reply mixer_info
;
287 enum sst_hsw_volume_curve curve_type
;
289 u32 mute
[SST_HSW_NO_CHANNELS
];
290 u32 mute_volume
[SST_HSW_NO_CHANNELS
];
293 struct sst_hsw_ipc_dx_reply dx
;
295 dma_addr_t dx_context_paddr
;
298 wait_queue_head_t boot_wait
;
303 struct list_head tx_list
;
304 struct list_head rx_list
;
305 struct list_head empty_list
;
306 wait_queue_head_t wait_txq
;
307 struct task_struct
*tx_thread
;
308 struct kthread_worker kworker
;
309 struct kthread_work kwork
;
311 struct ipc_message
*msg
;
314 struct sst_hsw_log_stream log_stream
;
317 #define CREATE_TRACE_POINTS
318 #include <trace/events/hswadsp.h>
320 static inline u32
msg_get_global_type(u32 msg
)
322 return (msg
& IPC_GLB_TYPE_MASK
) >> IPC_GLB_TYPE_SHIFT
;
325 static inline u32
msg_get_global_reply(u32 msg
)
327 return (msg
& IPC_GLB_REPLY_MASK
) >> IPC_GLB_REPLY_SHIFT
;
330 static inline u32
msg_get_stream_type(u32 msg
)
332 return (msg
& IPC_STR_TYPE_MASK
) >> IPC_STR_TYPE_SHIFT
;
335 static inline u32
msg_get_stage_type(u32 msg
)
337 return (msg
& IPC_STG_TYPE_MASK
) >> IPC_STG_TYPE_SHIFT
;
340 static inline u32
msg_set_stage_type(u32 msg
, u32 type
)
342 return (msg
& ~IPC_STG_TYPE_MASK
) +
343 (type
<< IPC_STG_TYPE_SHIFT
);
346 static inline u32
msg_get_stream_id(u32 msg
)
348 return (msg
& IPC_STR_ID_MASK
) >> IPC_STR_ID_SHIFT
;
351 static inline u32
msg_get_notify_reason(u32 msg
)
353 return (msg
& IPC_STG_TYPE_MASK
) >> IPC_STG_TYPE_SHIFT
;
356 u32
create_channel_map(enum sst_hsw_channel_config config
)
359 case SST_HSW_CHANNEL_CONFIG_MONO
:
360 return (0xFFFFFFF0 | SST_HSW_CHANNEL_CENTER
);
361 case SST_HSW_CHANNEL_CONFIG_STEREO
:
362 return (0xFFFFFF00 | SST_HSW_CHANNEL_LEFT
363 | (SST_HSW_CHANNEL_RIGHT
<< 4));
364 case SST_HSW_CHANNEL_CONFIG_2_POINT_1
:
365 return (0xFFFFF000 | SST_HSW_CHANNEL_LEFT
366 | (SST_HSW_CHANNEL_RIGHT
<< 4)
367 | (SST_HSW_CHANNEL_LFE
<< 8 ));
368 case SST_HSW_CHANNEL_CONFIG_3_POINT_0
:
369 return (0xFFFFF000 | SST_HSW_CHANNEL_LEFT
370 | (SST_HSW_CHANNEL_CENTER
<< 4)
371 | (SST_HSW_CHANNEL_RIGHT
<< 8));
372 case SST_HSW_CHANNEL_CONFIG_3_POINT_1
:
373 return (0xFFFF0000 | SST_HSW_CHANNEL_LEFT
374 | (SST_HSW_CHANNEL_CENTER
<< 4)
375 | (SST_HSW_CHANNEL_RIGHT
<< 8)
376 | (SST_HSW_CHANNEL_LFE
<< 12));
377 case SST_HSW_CHANNEL_CONFIG_QUATRO
:
378 return (0xFFFF0000 | SST_HSW_CHANNEL_LEFT
379 | (SST_HSW_CHANNEL_RIGHT
<< 4)
380 | (SST_HSW_CHANNEL_LEFT_SURROUND
<< 8)
381 | (SST_HSW_CHANNEL_RIGHT_SURROUND
<< 12));
382 case SST_HSW_CHANNEL_CONFIG_4_POINT_0
:
383 return (0xFFFF0000 | SST_HSW_CHANNEL_LEFT
384 | (SST_HSW_CHANNEL_CENTER
<< 4)
385 | (SST_HSW_CHANNEL_RIGHT
<< 8)
386 | (SST_HSW_CHANNEL_CENTER_SURROUND
<< 12));
387 case SST_HSW_CHANNEL_CONFIG_5_POINT_0
:
388 return (0xFFF00000 | SST_HSW_CHANNEL_LEFT
389 | (SST_HSW_CHANNEL_CENTER
<< 4)
390 | (SST_HSW_CHANNEL_RIGHT
<< 8)
391 | (SST_HSW_CHANNEL_LEFT_SURROUND
<< 12)
392 | (SST_HSW_CHANNEL_RIGHT_SURROUND
<< 16));
393 case SST_HSW_CHANNEL_CONFIG_5_POINT_1
:
394 return (0xFF000000 | SST_HSW_CHANNEL_CENTER
395 | (SST_HSW_CHANNEL_LEFT
<< 4)
396 | (SST_HSW_CHANNEL_RIGHT
<< 8)
397 | (SST_HSW_CHANNEL_LEFT_SURROUND
<< 12)
398 | (SST_HSW_CHANNEL_RIGHT_SURROUND
<< 16)
399 | (SST_HSW_CHANNEL_LFE
<< 20));
400 case SST_HSW_CHANNEL_CONFIG_DUAL_MONO
:
401 return (0xFFFFFF00 | SST_HSW_CHANNEL_LEFT
402 | (SST_HSW_CHANNEL_LEFT
<< 4));
408 static struct sst_hsw_stream
*get_stream_by_id(struct sst_hsw
*hsw
,
411 struct sst_hsw_stream
*stream
;
413 list_for_each_entry(stream
, &hsw
->stream_list
, node
) {
414 if (stream
->reply
.stream_hw_id
== stream_id
)
421 static void ipc_shim_dbg(struct sst_hsw
*hsw
, const char *text
)
423 struct sst_dsp
*sst
= hsw
->dsp
;
424 u32 isr
, ipcd
, imrx
, ipcx
;
426 ipcx
= sst_dsp_shim_read_unlocked(sst
, SST_IPCX
);
427 isr
= sst_dsp_shim_read_unlocked(sst
, SST_ISRX
);
428 ipcd
= sst_dsp_shim_read_unlocked(sst
, SST_IPCD
);
429 imrx
= sst_dsp_shim_read_unlocked(sst
, SST_IMRX
);
431 dev_err(hsw
->dev
, "ipc: --%s-- ipcx 0x%8.8x isr 0x%8.8x ipcd 0x%8.8x imrx 0x%8.8x\n",
432 text
, ipcx
, isr
, ipcd
, imrx
);
435 /* locks held by caller */
436 static struct ipc_message
*msg_get_empty(struct sst_hsw
*hsw
)
438 struct ipc_message
*msg
= NULL
;
440 if (!list_empty(&hsw
->empty_list
)) {
441 msg
= list_first_entry(&hsw
->empty_list
, struct ipc_message
,
443 list_del(&msg
->list
);
449 static void ipc_tx_msgs(struct kthread_work
*work
)
451 struct sst_hsw
*hsw
=
452 container_of(work
, struct sst_hsw
, kwork
);
453 struct ipc_message
*msg
;
457 spin_lock_irqsave(&hsw
->dsp
->spinlock
, flags
);
459 if (list_empty(&hsw
->tx_list
) || hsw
->pending
) {
460 spin_unlock_irqrestore(&hsw
->dsp
->spinlock
, flags
);
464 /* if the DSP is busy, we will TX messages after IRQ.
465 * also postpone if we are in the middle of procesing completion irq*/
466 ipcx
= sst_dsp_shim_read_unlocked(hsw
->dsp
, SST_IPCX
);
467 if (ipcx
& (SST_IPCX_BUSY
| SST_IPCX_DONE
)) {
468 spin_unlock_irqrestore(&hsw
->dsp
->spinlock
, flags
);
472 msg
= list_first_entry(&hsw
->tx_list
, struct ipc_message
, list
);
474 list_move(&msg
->list
, &hsw
->rx_list
);
476 /* send the message */
477 sst_dsp_outbox_write(hsw
->dsp
, msg
->tx_data
, msg
->tx_size
);
478 sst_dsp_ipc_msg_tx(hsw
->dsp
, msg
->header
| SST_IPCX_BUSY
);
480 spin_unlock_irqrestore(&hsw
->dsp
->spinlock
, flags
);
483 /* locks held by caller */
484 static void tx_msg_reply_complete(struct sst_hsw
*hsw
, struct ipc_message
*msg
)
486 msg
->complete
= true;
487 trace_ipc_reply("completed", msg
->header
);
490 list_add_tail(&msg
->list
, &hsw
->empty_list
);
492 wake_up(&msg
->waitq
);
495 static int tx_wait_done(struct sst_hsw
*hsw
, struct ipc_message
*msg
,
501 /* wait for DSP completion (in all cases atm inc pending) */
502 ret
= wait_event_timeout(msg
->waitq
, msg
->complete
,
503 msecs_to_jiffies(IPC_TIMEOUT_MSECS
));
505 spin_lock_irqsave(&hsw
->dsp
->spinlock
, flags
);
507 ipc_shim_dbg(hsw
, "message timeout");
509 trace_ipc_error("error message timeout for", msg
->header
);
510 list_del(&msg
->list
);
514 /* copy the data returned from DSP */
516 memcpy(rx_data
, msg
->rx_data
, msg
->rx_size
);
520 list_add_tail(&msg
->list
, &hsw
->empty_list
);
521 spin_unlock_irqrestore(&hsw
->dsp
->spinlock
, flags
);
525 static int ipc_tx_message(struct sst_hsw
*hsw
, u32 header
, void *tx_data
,
526 size_t tx_bytes
, void *rx_data
, size_t rx_bytes
, int wait
)
528 struct ipc_message
*msg
;
531 spin_lock_irqsave(&hsw
->dsp
->spinlock
, flags
);
533 msg
= msg_get_empty(hsw
);
535 spin_unlock_irqrestore(&hsw
->dsp
->spinlock
, flags
);
540 memcpy(msg
->tx_data
, tx_data
, tx_bytes
);
542 msg
->header
= header
;
543 msg
->tx_size
= tx_bytes
;
544 msg
->rx_size
= rx_bytes
;
547 msg
->pending
= false;
548 msg
->complete
= false;
550 list_add_tail(&msg
->list
, &hsw
->tx_list
);
551 spin_unlock_irqrestore(&hsw
->dsp
->spinlock
, flags
);
553 queue_kthread_work(&hsw
->kworker
, &hsw
->kwork
);
556 return tx_wait_done(hsw
, msg
, rx_data
);
561 static inline int ipc_tx_message_wait(struct sst_hsw
*hsw
, u32 header
,
562 void *tx_data
, size_t tx_bytes
, void *rx_data
, size_t rx_bytes
)
564 return ipc_tx_message(hsw
, header
, tx_data
, tx_bytes
, rx_data
,
568 static inline int ipc_tx_message_nowait(struct sst_hsw
*hsw
, u32 header
,
569 void *tx_data
, size_t tx_bytes
)
571 return ipc_tx_message(hsw
, header
, tx_data
, tx_bytes
, NULL
, 0, 0);
574 static void hsw_fw_ready(struct sst_hsw
*hsw
, u32 header
)
576 struct sst_hsw_ipc_fw_ready fw_ready
;
578 u8 fw_info
[IPC_MAX_MAILBOX_BYTES
- 5 * sizeof(u32
)];
579 char *tmp
[5], *pinfo
;
582 offset
= (header
& 0x1FFFFFFF) << 3;
584 dev_dbg(hsw
->dev
, "ipc: DSP is ready 0x%8.8x offset %d\n",
587 /* copy data from the DSP FW ready offset */
588 sst_dsp_read(hsw
->dsp
, &fw_ready
, offset
, sizeof(fw_ready
));
590 sst_dsp_mailbox_init(hsw
->dsp
, fw_ready
.inbox_offset
,
591 fw_ready
.inbox_size
, fw_ready
.outbox_offset
,
592 fw_ready
.outbox_size
);
594 hsw
->boot_complete
= true;
595 wake_up(&hsw
->boot_wait
);
597 dev_dbg(hsw
->dev
, " mailbox upstream 0x%x - size 0x%x\n",
598 fw_ready
.inbox_offset
, fw_ready
.inbox_size
);
599 dev_dbg(hsw
->dev
, " mailbox downstream 0x%x - size 0x%x\n",
600 fw_ready
.outbox_offset
, fw_ready
.outbox_size
);
601 if (fw_ready
.fw_info_size
< sizeof(fw_ready
.fw_info
)) {
602 fw_ready
.fw_info
[fw_ready
.fw_info_size
] = 0;
603 dev_dbg(hsw
->dev
, " Firmware info: %s \n", fw_ready
.fw_info
);
605 /* log the FW version info got from the mailbox here. */
606 memcpy(fw_info
, fw_ready
.fw_info
, fw_ready
.fw_info_size
);
608 for (i
= 0; i
< sizeof(tmp
) / sizeof(char *); i
++)
609 tmp
[i
] = strsep(&pinfo
, " ");
610 dev_info(hsw
->dev
, "FW loaded, mailbox readback FW info: type %s, - "
611 "version: %s.%s, build %s, source commit id: %s\n",
612 tmp
[0], tmp
[1], tmp
[2], tmp
[3], tmp
[4]);
616 static void hsw_notification_work(struct work_struct
*work
)
618 struct sst_hsw_stream
*stream
= container_of(work
,
619 struct sst_hsw_stream
, notify_work
);
620 struct sst_hsw_ipc_stream_glitch_position
*glitch
= &stream
->glitch
;
621 struct sst_hsw_ipc_stream_get_position
*pos
= &stream
->rpos
;
622 struct sst_hsw
*hsw
= stream
->hsw
;
625 reason
= msg_get_notify_reason(stream
->header
);
629 trace_ipc_notification("DSP stream under/overrun",
630 stream
->reply
.stream_hw_id
);
631 sst_dsp_inbox_read(hsw
->dsp
, glitch
, sizeof(*glitch
));
633 dev_err(hsw
->dev
, "glitch %d pos 0x%x write pos 0x%x\n",
634 glitch
->glitch_type
, glitch
->present_pos
,
638 case IPC_POSITION_CHANGED
:
639 trace_ipc_notification("DSP stream position changed for",
640 stream
->reply
.stream_hw_id
);
641 sst_dsp_inbox_read(hsw
->dsp
, pos
, sizeof(*pos
));
643 if (stream
->notify_position
)
644 stream
->notify_position(stream
, stream
->pdata
);
648 dev_err(hsw
->dev
, "error: unknown notification 0x%x\n",
653 /* tell DSP that notification has been handled */
654 sst_dsp_shim_update_bits_unlocked(hsw
->dsp
, SST_IPCD
,
655 SST_IPCD_BUSY
| SST_IPCD_DONE
, SST_IPCD_DONE
);
657 /* unmask busy interrupt */
658 sst_dsp_shim_update_bits_unlocked(hsw
->dsp
, SST_IMRX
, SST_IMRX_BUSY
, 0);
661 static struct ipc_message
*reply_find_msg(struct sst_hsw
*hsw
, u32 header
)
663 struct ipc_message
*msg
;
665 /* clear reply bits & status bits */
666 header
&= ~(IPC_STATUS_MASK
| IPC_GLB_REPLY_MASK
);
668 if (list_empty(&hsw
->rx_list
)) {
669 dev_err(hsw
->dev
, "error: rx list empty but received 0x%x\n",
674 list_for_each_entry(msg
, &hsw
->rx_list
, list
) {
675 if (msg
->header
== header
)
682 static void hsw_stream_update(struct sst_hsw
*hsw
, struct ipc_message
*msg
)
684 struct sst_hsw_stream
*stream
;
685 u32 header
= msg
->header
& ~(IPC_STATUS_MASK
| IPC_GLB_REPLY_MASK
);
686 u32 stream_id
= msg_get_stream_id(header
);
687 u32 stream_msg
= msg_get_stream_type(header
);
689 stream
= get_stream_by_id(hsw
, stream_id
);
693 switch (stream_msg
) {
694 case IPC_STR_STAGE_MESSAGE
:
695 case IPC_STR_NOTIFICATION
:
698 trace_ipc_notification("stream reset", stream
->reply
.stream_hw_id
);
701 stream
->running
= false;
702 trace_ipc_notification("stream paused",
703 stream
->reply
.stream_hw_id
);
706 stream
->running
= true;
707 trace_ipc_notification("stream running",
708 stream
->reply
.stream_hw_id
);
713 static int hsw_process_reply(struct sst_hsw
*hsw
, u32 header
)
715 struct ipc_message
*msg
;
716 u32 reply
= msg_get_global_reply(header
);
718 trace_ipc_reply("processing -->", header
);
720 msg
= reply_find_msg(hsw
, header
);
722 trace_ipc_error("error: can't find message header", header
);
726 /* first process the header */
728 case IPC_GLB_REPLY_PENDING
:
729 trace_ipc_pending_reply("received", header
);
733 case IPC_GLB_REPLY_SUCCESS
:
735 trace_ipc_pending_reply("completed", header
);
736 sst_dsp_inbox_read(hsw
->dsp
, msg
->rx_data
,
738 hsw
->pending
= false;
740 /* copy data from the DSP */
741 sst_dsp_outbox_read(hsw
->dsp
, msg
->rx_data
,
745 /* these will be rare - but useful for debug */
746 case IPC_GLB_REPLY_UNKNOWN_MESSAGE_TYPE
:
747 trace_ipc_error("error: unknown message type", header
);
748 msg
->errno
= -EBADMSG
;
750 case IPC_GLB_REPLY_OUT_OF_RESOURCES
:
751 trace_ipc_error("error: out of resources", header
);
752 msg
->errno
= -ENOMEM
;
754 case IPC_GLB_REPLY_BUSY
:
755 trace_ipc_error("error: reply busy", header
);
758 case IPC_GLB_REPLY_FAILURE
:
759 trace_ipc_error("error: reply failure", header
);
760 msg
->errno
= -EINVAL
;
762 case IPC_GLB_REPLY_STAGE_UNINITIALIZED
:
763 trace_ipc_error("error: stage uninitialized", header
);
764 msg
->errno
= -EINVAL
;
766 case IPC_GLB_REPLY_NOT_FOUND
:
767 trace_ipc_error("error: reply not found", header
);
768 msg
->errno
= -EINVAL
;
770 case IPC_GLB_REPLY_SOURCE_NOT_STARTED
:
771 trace_ipc_error("error: source not started", header
);
772 msg
->errno
= -EINVAL
;
774 case IPC_GLB_REPLY_INVALID_REQUEST
:
775 trace_ipc_error("error: invalid request", header
);
776 msg
->errno
= -EINVAL
;
778 case IPC_GLB_REPLY_ERROR_INVALID_PARAM
:
779 trace_ipc_error("error: invalid parameter", header
);
780 msg
->errno
= -EINVAL
;
783 trace_ipc_error("error: unknown reply", header
);
784 msg
->errno
= -EINVAL
;
788 /* update any stream states */
789 if (msg_get_global_type(header
) == IPC_GLB_STREAM_MESSAGE
)
790 hsw_stream_update(hsw
, msg
);
792 /* wake up and return the error if we have waiters on this message ? */
793 list_del(&msg
->list
);
794 tx_msg_reply_complete(hsw
, msg
);
799 static int hsw_stream_message(struct sst_hsw
*hsw
, u32 header
)
801 u32 stream_msg
, stream_id
, stage_type
;
802 struct sst_hsw_stream
*stream
;
805 stream_msg
= msg_get_stream_type(header
);
806 stream_id
= msg_get_stream_id(header
);
807 stage_type
= msg_get_stage_type(header
);
809 stream
= get_stream_by_id(hsw
, stream_id
);
813 stream
->header
= header
;
815 switch (stream_msg
) {
816 case IPC_STR_STAGE_MESSAGE
:
817 dev_err(hsw
->dev
, "error: stage msg not implemented 0x%8.8x\n",
820 case IPC_STR_NOTIFICATION
:
821 schedule_work(&stream
->notify_work
);
824 /* handle pending message complete request */
825 handled
= hsw_process_reply(hsw
, header
);
832 static int hsw_log_message(struct sst_hsw
*hsw
, u32 header
)
834 u32 operation
= (header
& IPC_LOG_OP_MASK
) >> IPC_LOG_OP_SHIFT
;
835 struct sst_hsw_log_stream
*stream
= &hsw
->log_stream
;
838 if (operation
!= IPC_DEBUG_REQUEST_LOG_DUMP
) {
840 "error: log msg not implemented 0x%8.8x\n", header
);
844 mutex_lock(&stream
->rw_mutex
);
845 stream
->last_pos
= stream
->curr_pos
;
847 hsw
->dsp
, &stream
->curr_pos
, sizeof(stream
->curr_pos
));
848 mutex_unlock(&stream
->rw_mutex
);
850 schedule_work(&stream
->notify_work
);
855 static int hsw_process_notification(struct sst_hsw
*hsw
)
857 struct sst_dsp
*sst
= hsw
->dsp
;
861 header
= sst_dsp_shim_read_unlocked(sst
, SST_IPCD
);
862 type
= msg_get_global_type(header
);
864 trace_ipc_request("processing -->", header
);
866 /* FW Ready is a special case */
867 if (!hsw
->boot_complete
&& header
& IPC_FW_READY
) {
868 hsw_fw_ready(hsw
, header
);
873 case IPC_GLB_GET_FW_VERSION
:
874 case IPC_GLB_ALLOCATE_STREAM
:
875 case IPC_GLB_FREE_STREAM
:
876 case IPC_GLB_GET_FW_CAPABILITIES
:
877 case IPC_GLB_REQUEST_DUMP
:
878 case IPC_GLB_GET_DEVICE_FORMATS
:
879 case IPC_GLB_SET_DEVICE_FORMATS
:
880 case IPC_GLB_ENTER_DX_STATE
:
881 case IPC_GLB_GET_MIXER_STREAM_INFO
:
882 case IPC_GLB_MAX_IPC_MESSAGE_TYPE
:
883 case IPC_GLB_RESTORE_CONTEXT
:
884 case IPC_GLB_SHORT_REPLY
:
885 dev_err(hsw
->dev
, "error: message type %d header 0x%x\n",
888 case IPC_GLB_STREAM_MESSAGE
:
889 handled
= hsw_stream_message(hsw
, header
);
891 case IPC_GLB_DEBUG_LOG_MESSAGE
:
892 handled
= hsw_log_message(hsw
, header
);
895 dev_err(hsw
->dev
, "error: unexpected type %d hdr 0x%8.8x\n",
903 static irqreturn_t
hsw_irq_thread(int irq
, void *context
)
905 struct sst_dsp
*sst
= (struct sst_dsp
*) context
;
906 struct sst_hsw
*hsw
= sst_dsp_get_thread_context(sst
);
911 spin_lock_irqsave(&sst
->spinlock
, flags
);
913 ipcx
= sst_dsp_ipc_msg_rx(hsw
->dsp
);
914 ipcd
= sst_dsp_shim_read_unlocked(sst
, SST_IPCD
);
916 /* reply message from DSP */
917 if (ipcx
& SST_IPCX_DONE
) {
919 /* Handle Immediate reply from DSP Core */
920 handled
= hsw_process_reply(hsw
, ipcx
);
923 /* clear DONE bit - tell DSP we have completed */
924 sst_dsp_shim_update_bits_unlocked(sst
, SST_IPCX
,
927 /* unmask Done interrupt */
928 sst_dsp_shim_update_bits_unlocked(sst
, SST_IMRX
,
933 /* new message from DSP */
934 if (ipcd
& SST_IPCD_BUSY
) {
936 /* Handle Notification and Delayed reply from DSP Core */
937 handled
= hsw_process_notification(hsw
);
939 /* clear BUSY bit and set DONE bit - accept new messages */
941 sst_dsp_shim_update_bits_unlocked(sst
, SST_IPCD
,
942 SST_IPCD_BUSY
| SST_IPCD_DONE
, SST_IPCD_DONE
);
944 /* unmask busy interrupt */
945 sst_dsp_shim_update_bits_unlocked(sst
, SST_IMRX
,
950 spin_unlock_irqrestore(&sst
->spinlock
, flags
);
952 /* continue to send any remaining messages... */
953 queue_kthread_work(&hsw
->kworker
, &hsw
->kwork
);
958 int sst_hsw_fw_get_version(struct sst_hsw
*hsw
,
959 struct sst_hsw_ipc_fw_version
*version
)
963 ret
= ipc_tx_message_wait(hsw
, IPC_GLB_TYPE(IPC_GLB_GET_FW_VERSION
),
964 NULL
, 0, version
, sizeof(*version
));
966 dev_err(hsw
->dev
, "error: get version failed\n");
972 int sst_hsw_stream_mute(struct sst_hsw
*hsw
, struct sst_hsw_stream
*stream
,
973 u32 stage_id
, u32 channel
)
977 ret
= sst_hsw_stream_get_volume(hsw
, stream
, stage_id
, channel
,
978 &stream
->mute_volume
[channel
]);
982 ret
= sst_hsw_stream_set_volume(hsw
, stream
, stage_id
, channel
, 0);
984 dev_err(hsw
->dev
, "error: can't unmute stream %d channel %d\n",
985 stream
->reply
.stream_hw_id
, channel
);
989 stream
->mute
[channel
] = 1;
993 int sst_hsw_stream_unmute(struct sst_hsw
*hsw
, struct sst_hsw_stream
*stream
,
994 u32 stage_id
, u32 channel
)
999 stream
->mute
[channel
] = 0;
1000 ret
= sst_hsw_stream_set_volume(hsw
, stream
, stage_id
, channel
,
1001 stream
->mute_volume
[channel
]);
1003 dev_err(hsw
->dev
, "error: can't unmute stream %d channel %d\n",
1004 stream
->reply
.stream_hw_id
, channel
);
1011 int sst_hsw_stream_get_volume(struct sst_hsw
*hsw
, struct sst_hsw_stream
*stream
,
1012 u32 stage_id
, u32 channel
, u32
*volume
)
1017 sst_dsp_read(hsw
->dsp
, volume
,
1018 stream
->reply
.volume_register_address
[channel
],
1024 int sst_hsw_stream_set_volume_curve(struct sst_hsw
*hsw
,
1025 struct sst_hsw_stream
*stream
, u64 curve_duration
,
1026 enum sst_hsw_volume_curve curve
)
1028 /* curve duration in steps of 100ns */
1029 stream
->vol_req
.curve_duration
= curve_duration
;
1030 stream
->vol_req
.curve_type
= curve
;
1036 int sst_hsw_stream_set_volume(struct sst_hsw
*hsw
,
1037 struct sst_hsw_stream
*stream
, u32 stage_id
, u32 channel
, u32 volume
)
1039 struct sst_hsw_ipc_volume_req
*req
;
1043 trace_ipc_request("set stream volume", stream
->reply
.stream_hw_id
);
1045 if (channel
>= 2 && channel
!= SST_HSW_CHANNELS_ALL
)
1048 header
= IPC_GLB_TYPE(IPC_GLB_STREAM_MESSAGE
) |
1049 IPC_STR_TYPE(IPC_STR_STAGE_MESSAGE
);
1050 header
|= (stream
->reply
.stream_hw_id
<< IPC_STR_ID_SHIFT
);
1051 header
|= (IPC_STG_SET_VOLUME
<< IPC_STG_TYPE_SHIFT
);
1052 header
|= (stage_id
<< IPC_STG_ID_SHIFT
);
1054 req
= &stream
->vol_req
;
1055 req
->target_volume
= volume
;
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 ret
= ipc_tx_message_wait(hsw
, header
, req
, sizeof(*req
), NULL
, 0);
1079 dev_err(hsw
->dev
, "error: set stream volume failed\n");
1086 int sst_hsw_mixer_mute(struct sst_hsw
*hsw
, u32 stage_id
, u32 channel
)
1090 ret
= sst_hsw_mixer_get_volume(hsw
, stage_id
, channel
,
1091 &hsw
->mute_volume
[channel
]);
1095 ret
= sst_hsw_mixer_set_volume(hsw
, stage_id
, channel
, 0);
1097 dev_err(hsw
->dev
, "error: failed to unmute mixer channel %d\n",
1102 hsw
->mute
[channel
] = 1;
1106 int sst_hsw_mixer_unmute(struct sst_hsw
*hsw
, u32 stage_id
, u32 channel
)
1110 ret
= sst_hsw_mixer_set_volume(hsw
, stage_id
, channel
,
1111 hsw
->mixer_info
.volume_register_address
[channel
]);
1113 dev_err(hsw
->dev
, "error: failed to unmute mixer channel %d\n",
1118 hsw
->mute
[channel
] = 0;
1122 int sst_hsw_mixer_get_volume(struct sst_hsw
*hsw
, u32 stage_id
, u32 channel
,
1128 sst_dsp_read(hsw
->dsp
, volume
,
1129 hsw
->mixer_info
.volume_register_address
[channel
],
1135 int sst_hsw_mixer_set_volume_curve(struct sst_hsw
*hsw
,
1136 u64 curve_duration
, enum sst_hsw_volume_curve curve
)
1138 /* curve duration in steps of 100ns */
1139 hsw
->curve_duration
= curve_duration
;
1140 hsw
->curve_type
= curve
;
1145 /* global mixer volume */
1146 int sst_hsw_mixer_set_volume(struct sst_hsw
*hsw
, u32 stage_id
, u32 channel
,
1149 struct sst_hsw_ipc_volume_req req
;
1153 trace_ipc_request("set mixer volume", volume
);
1155 if (channel
>= 2 && channel
!= SST_HSW_CHANNELS_ALL
)
1158 /* set both at same time ? */
1159 if (channel
== SST_HSW_CHANNELS_ALL
) {
1160 if (hsw
->mute
[0] && hsw
->mute
[1]) {
1161 hsw
->mute_volume
[0] = hsw
->mute_volume
[1] = volume
;
1163 } else if (hsw
->mute
[0])
1165 else if (hsw
->mute
[1])
1168 req
.channel
= SST_HSW_CHANNELS_ALL
;
1170 /* set only 1 channel */
1171 if (hsw
->mute
[channel
]) {
1172 hsw
->mute_volume
[channel
] = volume
;
1175 req
.channel
= channel
;
1178 header
= IPC_GLB_TYPE(IPC_GLB_STREAM_MESSAGE
) |
1179 IPC_STR_TYPE(IPC_STR_STAGE_MESSAGE
);
1180 header
|= (hsw
->mixer_info
.mixer_hw_id
<< IPC_STR_ID_SHIFT
);
1181 header
|= (IPC_STG_SET_VOLUME
<< IPC_STG_TYPE_SHIFT
);
1182 header
|= (stage_id
<< IPC_STG_ID_SHIFT
);
1184 req
.curve_duration
= hsw
->curve_duration
;
1185 req
.curve_type
= hsw
->curve_type
;
1186 req
.target_volume
= volume
;
1188 ret
= ipc_tx_message_wait(hsw
, header
, &req
, sizeof(req
), NULL
, 0);
1190 dev_err(hsw
->dev
, "error: set mixer volume failed\n");
1198 struct sst_hsw_stream
*sst_hsw_stream_new(struct sst_hsw
*hsw
, int id
,
1199 u32 (*notify_position
)(struct sst_hsw_stream
*stream
, void *data
),
1202 struct sst_hsw_stream
*stream
;
1203 struct sst_dsp
*sst
= hsw
->dsp
;
1204 unsigned long flags
;
1206 stream
= kzalloc(sizeof(*stream
), GFP_KERNEL
);
1210 spin_lock_irqsave(&sst
->spinlock
, flags
);
1211 list_add(&stream
->node
, &hsw
->stream_list
);
1212 stream
->notify_position
= notify_position
;
1213 stream
->pdata
= data
;
1215 stream
->host_id
= id
;
1217 /* work to process notification messages */
1218 INIT_WORK(&stream
->notify_work
, hsw_notification_work
);
1219 spin_unlock_irqrestore(&sst
->spinlock
, flags
);
1224 int sst_hsw_stream_free(struct sst_hsw
*hsw
, struct sst_hsw_stream
*stream
)
1228 struct sst_dsp
*sst
= hsw
->dsp
;
1229 unsigned long flags
;
1231 /* dont free DSP streams that are not commited */
1232 if (!stream
->commited
)
1235 trace_ipc_request("stream free", stream
->host_id
);
1237 stream
->free_req
.stream_id
= stream
->reply
.stream_hw_id
;
1238 header
= IPC_GLB_TYPE(IPC_GLB_FREE_STREAM
);
1240 ret
= ipc_tx_message_wait(hsw
, header
, &stream
->free_req
,
1241 sizeof(stream
->free_req
), NULL
, 0);
1243 dev_err(hsw
->dev
, "error: free stream %d failed\n",
1244 stream
->free_req
.stream_id
);
1248 trace_hsw_stream_free_req(stream
, &stream
->free_req
);
1251 cancel_work_sync(&stream
->notify_work
);
1252 spin_lock_irqsave(&sst
->spinlock
, flags
);
1253 list_del(&stream
->node
);
1255 spin_unlock_irqrestore(&sst
->spinlock
, flags
);
1260 int sst_hsw_stream_set_bits(struct sst_hsw
*hsw
,
1261 struct sst_hsw_stream
*stream
, enum sst_hsw_bitdepth bits
)
1263 if (stream
->commited
) {
1264 dev_err(hsw
->dev
, "error: stream committed for set bits\n");
1268 stream
->request
.format
.bitdepth
= bits
;
1272 int sst_hsw_stream_set_channels(struct sst_hsw
*hsw
,
1273 struct sst_hsw_stream
*stream
, int channels
)
1275 if (stream
->commited
) {
1276 dev_err(hsw
->dev
, "error: stream committed for set channels\n");
1280 stream
->request
.format
.ch_num
= channels
;
1284 int sst_hsw_stream_set_rate(struct sst_hsw
*hsw
,
1285 struct sst_hsw_stream
*stream
, int rate
)
1287 if (stream
->commited
) {
1288 dev_err(hsw
->dev
, "error: stream committed for set rate\n");
1292 stream
->request
.format
.frequency
= rate
;
1296 int sst_hsw_stream_set_map_config(struct sst_hsw
*hsw
,
1297 struct sst_hsw_stream
*stream
, u32 map
,
1298 enum sst_hsw_channel_config config
)
1300 if (stream
->commited
) {
1301 dev_err(hsw
->dev
, "error: stream committed for set map\n");
1305 stream
->request
.format
.map
= map
;
1306 stream
->request
.format
.config
= config
;
1310 int sst_hsw_stream_set_style(struct sst_hsw
*hsw
,
1311 struct sst_hsw_stream
*stream
, enum sst_hsw_interleaving style
)
1313 if (stream
->commited
) {
1314 dev_err(hsw
->dev
, "error: stream committed for set style\n");
1318 stream
->request
.format
.style
= style
;
1322 int sst_hsw_stream_set_valid(struct sst_hsw
*hsw
,
1323 struct sst_hsw_stream
*stream
, u32 bits
)
1325 if (stream
->commited
) {
1326 dev_err(hsw
->dev
, "error: stream committed for set valid bits\n");
1330 stream
->request
.format
.valid_bit
= bits
;
1334 /* Stream Configuration */
1335 int sst_hsw_stream_format(struct sst_hsw
*hsw
, struct sst_hsw_stream
*stream
,
1336 enum sst_hsw_stream_path_id path_id
,
1337 enum sst_hsw_stream_type stream_type
,
1338 enum sst_hsw_stream_format format_id
)
1340 if (stream
->commited
) {
1341 dev_err(hsw
->dev
, "error: stream committed for set format\n");
1345 stream
->request
.path_id
= path_id
;
1346 stream
->request
.stream_type
= stream_type
;
1347 stream
->request
.format_id
= format_id
;
1349 trace_hsw_stream_alloc_request(stream
, &stream
->request
);
1354 int sst_hsw_stream_buffer(struct sst_hsw
*hsw
, struct sst_hsw_stream
*stream
,
1355 u32 ring_pt_address
, u32 num_pages
,
1356 u32 ring_size
, u32 ring_offset
, u32 ring_first_pfn
)
1358 if (stream
->commited
) {
1359 dev_err(hsw
->dev
, "error: stream committed for buffer\n");
1363 stream
->request
.ringinfo
.ring_pt_address
= ring_pt_address
;
1364 stream
->request
.ringinfo
.num_pages
= num_pages
;
1365 stream
->request
.ringinfo
.ring_size
= ring_size
;
1366 stream
->request
.ringinfo
.ring_offset
= ring_offset
;
1367 stream
->request
.ringinfo
.ring_first_pfn
= ring_first_pfn
;
1369 trace_hsw_stream_buffer(stream
);
1374 int sst_hsw_stream_set_module_info(struct sst_hsw
*hsw
,
1375 struct sst_hsw_stream
*stream
, struct sst_module_runtime
*runtime
)
1377 struct sst_hsw_module_map
*map
= &stream
->request
.map
;
1378 struct sst_dsp
*dsp
= sst_hsw_get_dsp(hsw
);
1379 struct sst_module
*module
= runtime
->module
;
1381 if (stream
->commited
) {
1382 dev_err(hsw
->dev
, "error: stream committed for set module\n");
1386 /* only support initial module atm */
1387 map
->module_entries_count
= 1;
1388 map
->module_entries
[0].module_id
= module
->id
;
1389 map
->module_entries
[0].entry_point
= module
->entry
;
1391 stream
->request
.persistent_mem
.offset
=
1392 sst_dsp_get_offset(dsp
, runtime
->persistent_offset
, SST_MEM_DRAM
);
1393 stream
->request
.persistent_mem
.size
= module
->persistent_size
;
1395 stream
->request
.scratch_mem
.offset
=
1396 sst_dsp_get_offset(dsp
, dsp
->scratch_offset
, SST_MEM_DRAM
);
1397 stream
->request
.scratch_mem
.size
= dsp
->scratch_size
;
1399 dev_dbg(hsw
->dev
, "module %d runtime %d using:\n", module
->id
,
1401 dev_dbg(hsw
->dev
, " persistent offset 0x%x bytes 0x%x\n",
1402 stream
->request
.persistent_mem
.offset
,
1403 stream
->request
.persistent_mem
.size
);
1404 dev_dbg(hsw
->dev
, " scratch offset 0x%x bytes 0x%x\n",
1405 stream
->request
.scratch_mem
.offset
,
1406 stream
->request
.scratch_mem
.size
);
1411 int sst_hsw_stream_commit(struct sst_hsw
*hsw
, struct sst_hsw_stream
*stream
)
1413 struct sst_hsw_ipc_stream_alloc_req
*str_req
= &stream
->request
;
1414 struct sst_hsw_ipc_stream_alloc_reply
*reply
= &stream
->reply
;
1418 trace_ipc_request("stream alloc", stream
->host_id
);
1420 header
= IPC_GLB_TYPE(IPC_GLB_ALLOCATE_STREAM
);
1422 ret
= ipc_tx_message_wait(hsw
, header
, str_req
, sizeof(*str_req
),
1423 reply
, sizeof(*reply
));
1425 dev_err(hsw
->dev
, "error: stream commit failed\n");
1429 stream
->commited
= 1;
1430 trace_hsw_stream_alloc_reply(stream
);
1435 /* Stream Information - these calls could be inline but we want the IPC
1436 ABI to be opaque to client PCM drivers to cope with any future ABI changes */
1437 int sst_hsw_stream_get_hw_id(struct sst_hsw
*hsw
,
1438 struct sst_hsw_stream
*stream
)
1440 return stream
->reply
.stream_hw_id
;
1443 int sst_hsw_stream_get_mixer_id(struct sst_hsw
*hsw
,
1444 struct sst_hsw_stream
*stream
)
1446 return stream
->reply
.mixer_hw_id
;
1449 u32
sst_hsw_stream_get_read_reg(struct sst_hsw
*hsw
,
1450 struct sst_hsw_stream
*stream
)
1452 return stream
->reply
.read_position_register_address
;
1455 u32
sst_hsw_stream_get_pointer_reg(struct sst_hsw
*hsw
,
1456 struct sst_hsw_stream
*stream
)
1458 return stream
->reply
.presentation_position_register_address
;
1461 u32
sst_hsw_stream_get_peak_reg(struct sst_hsw
*hsw
,
1462 struct sst_hsw_stream
*stream
, u32 channel
)
1467 return stream
->reply
.peak_meter_register_address
[channel
];
1470 u32
sst_hsw_stream_get_vol_reg(struct sst_hsw
*hsw
,
1471 struct sst_hsw_stream
*stream
, u32 channel
)
1476 return stream
->reply
.volume_register_address
[channel
];
1479 int sst_hsw_mixer_get_info(struct sst_hsw
*hsw
)
1481 struct sst_hsw_ipc_stream_info_reply
*reply
;
1485 reply
= &hsw
->mixer_info
;
1486 header
= IPC_GLB_TYPE(IPC_GLB_GET_MIXER_STREAM_INFO
);
1488 trace_ipc_request("get global mixer info", 0);
1490 ret
= ipc_tx_message_wait(hsw
, header
, NULL
, 0, reply
, sizeof(*reply
));
1492 dev_err(hsw
->dev
, "error: get stream info failed\n");
1496 trace_hsw_mixer_info_reply(reply
);
1501 /* Send stream command */
1502 static int sst_hsw_stream_operations(struct sst_hsw
*hsw
, int type
,
1503 int stream_id
, int wait
)
1507 header
= IPC_GLB_TYPE(IPC_GLB_STREAM_MESSAGE
) | IPC_STR_TYPE(type
);
1508 header
|= (stream_id
<< IPC_STR_ID_SHIFT
);
1511 return ipc_tx_message_wait(hsw
, header
, NULL
, 0, NULL
, 0);
1513 return ipc_tx_message_nowait(hsw
, header
, NULL
, 0);
1516 /* Stream ALSA trigger operations */
1517 int sst_hsw_stream_pause(struct sst_hsw
*hsw
, struct sst_hsw_stream
*stream
,
1522 trace_ipc_request("stream pause", stream
->reply
.stream_hw_id
);
1524 ret
= sst_hsw_stream_operations(hsw
, IPC_STR_PAUSE
,
1525 stream
->reply
.stream_hw_id
, wait
);
1527 dev_err(hsw
->dev
, "error: failed to pause stream %d\n",
1528 stream
->reply
.stream_hw_id
);
1533 int sst_hsw_stream_resume(struct sst_hsw
*hsw
, struct sst_hsw_stream
*stream
,
1538 trace_ipc_request("stream resume", stream
->reply
.stream_hw_id
);
1540 ret
= sst_hsw_stream_operations(hsw
, IPC_STR_RESUME
,
1541 stream
->reply
.stream_hw_id
, wait
);
1543 dev_err(hsw
->dev
, "error: failed to resume stream %d\n",
1544 stream
->reply
.stream_hw_id
);
1549 int sst_hsw_stream_reset(struct sst_hsw
*hsw
, struct sst_hsw_stream
*stream
)
1551 int ret
, tries
= 10;
1553 /* dont reset streams that are not commited */
1554 if (!stream
->commited
)
1557 /* wait for pause to complete before we reset the stream */
1558 while (stream
->running
&& tries
--)
1561 dev_err(hsw
->dev
, "error: reset stream %d still running\n",
1562 stream
->reply
.stream_hw_id
);
1566 trace_ipc_request("stream reset", stream
->reply
.stream_hw_id
);
1568 ret
= sst_hsw_stream_operations(hsw
, IPC_STR_RESET
,
1569 stream
->reply
.stream_hw_id
, 1);
1571 dev_err(hsw
->dev
, "error: failed to reset stream %d\n",
1572 stream
->reply
.stream_hw_id
);
1576 /* Stream pointer positions */
1577 u32
sst_hsw_get_dsp_position(struct sst_hsw
*hsw
,
1578 struct sst_hsw_stream
*stream
)
1582 sst_dsp_read(hsw
->dsp
, &rpos
,
1583 stream
->reply
.read_position_register_address
, sizeof(rpos
));
1588 /* Stream presentation (monotonic) positions */
1589 u64
sst_hsw_get_dsp_presentation_position(struct sst_hsw
*hsw
,
1590 struct sst_hsw_stream
*stream
)
1594 sst_dsp_read(hsw
->dsp
, &ppos
,
1595 stream
->reply
.presentation_position_register_address
,
1601 int sst_hsw_stream_set_write_position(struct sst_hsw
*hsw
,
1602 struct sst_hsw_stream
*stream
, u32 stage_id
, u32 position
)
1607 trace_stream_write_position(stream
->reply
.stream_hw_id
, position
);
1609 header
= IPC_GLB_TYPE(IPC_GLB_STREAM_MESSAGE
) |
1610 IPC_STR_TYPE(IPC_STR_STAGE_MESSAGE
);
1611 header
|= (stream
->reply
.stream_hw_id
<< IPC_STR_ID_SHIFT
);
1612 header
|= (IPC_STG_SET_WRITE_POSITION
<< IPC_STG_TYPE_SHIFT
);
1613 header
|= (stage_id
<< IPC_STG_ID_SHIFT
);
1614 stream
->wpos
.position
= position
;
1616 ret
= ipc_tx_message_nowait(hsw
, header
, &stream
->wpos
,
1617 sizeof(stream
->wpos
));
1619 dev_err(hsw
->dev
, "error: stream %d set position %d failed\n",
1620 stream
->reply
.stream_hw_id
, position
);
1625 /* physical BE config */
1626 int sst_hsw_device_set_config(struct sst_hsw
*hsw
,
1627 enum sst_hsw_device_id dev
, enum sst_hsw_device_mclk mclk
,
1628 enum sst_hsw_device_mode mode
, u32 clock_divider
)
1630 struct sst_hsw_ipc_device_config_req config
;
1634 trace_ipc_request("set device config", dev
);
1636 config
.ssp_interface
= dev
;
1637 config
.clock_frequency
= mclk
;
1639 config
.clock_divider
= clock_divider
;
1640 if (mode
== SST_HSW_DEVICE_TDM_CLOCK_MASTER
)
1641 config
.channels
= 4;
1643 config
.channels
= 2;
1645 trace_hsw_device_config_req(&config
);
1647 header
= IPC_GLB_TYPE(IPC_GLB_SET_DEVICE_FORMATS
);
1649 ret
= ipc_tx_message_wait(hsw
, header
, &config
, sizeof(config
),
1652 dev_err(hsw
->dev
, "error: set device formats failed\n");
1656 EXPORT_SYMBOL_GPL(sst_hsw_device_set_config
);
1659 int sst_hsw_dx_set_state(struct sst_hsw
*hsw
,
1660 enum sst_hsw_dx_state state
, struct sst_hsw_ipc_dx_reply
*dx
)
1665 header
= IPC_GLB_TYPE(IPC_GLB_ENTER_DX_STATE
);
1668 trace_ipc_request("PM enter Dx state", state
);
1670 ret
= ipc_tx_message_wait(hsw
, header
, &state_
, sizeof(state_
),
1673 dev_err(hsw
->dev
, "ipc: error set dx state %d failed\n", state
);
1677 for (item
= 0; item
< dx
->entries_no
; item
++) {
1679 "Item[%d] offset[%x] - size[%x] - source[%x]\n",
1680 item
, dx
->mem_info
[item
].offset
,
1681 dx
->mem_info
[item
].size
,
1682 dx
->mem_info
[item
].source
);
1684 dev_dbg(hsw
->dev
, "ipc: got %d entry numbers for state %d\n",
1685 dx
->entries_no
, state
);
1690 struct sst_module_runtime
*sst_hsw_runtime_module_create(struct sst_hsw
*hsw
,
1691 int mod_id
, int offset
)
1693 struct sst_dsp
*dsp
= hsw
->dsp
;
1694 struct sst_module
*module
;
1695 struct sst_module_runtime
*runtime
;
1698 module
= sst_module_get_from_id(dsp
, mod_id
);
1699 if (module
== NULL
) {
1700 dev_err(dsp
->dev
, "error: failed to get module %d for pcm\n",
1705 runtime
= sst_module_runtime_new(module
, mod_id
, NULL
);
1706 if (runtime
== NULL
) {
1707 dev_err(dsp
->dev
, "error: failed to create module %d runtime\n",
1712 err
= sst_module_runtime_alloc_blocks(runtime
, offset
);
1714 dev_err(dsp
->dev
, "error: failed to alloc blocks for module %d runtime\n",
1716 sst_module_runtime_free(runtime
);
1720 dev_dbg(dsp
->dev
, "runtime id %d created for module %d\n", runtime
->id
,
1725 void sst_hsw_runtime_module_free(struct sst_module_runtime
*runtime
)
1727 sst_module_runtime_free_blocks(runtime
);
1728 sst_module_runtime_free(runtime
);
1732 static int sst_hsw_dx_state_dump(struct sst_hsw
*hsw
)
1734 struct sst_dsp
*sst
= hsw
->dsp
;
1735 u32 item
, offset
, size
;
1738 trace_ipc_request("PM state dump. Items #", SST_HSW_MAX_DX_REGIONS
);
1740 if (hsw
->dx
.entries_no
> SST_HSW_MAX_DX_REGIONS
) {
1742 "error: number of FW context regions greater than %d\n",
1743 SST_HSW_MAX_DX_REGIONS
);
1744 memset(&hsw
->dx
, 0, sizeof(hsw
->dx
));
1748 ret
= sst_dsp_dma_get_channel(sst
, 0);
1750 dev_err(hsw
->dev
, "error: cant allocate dma channel %d\n", ret
);
1754 /* set on-demond mode on engine 0 channel 3 */
1755 sst_dsp_shim_update_bits(sst
, SST_HMDC
,
1756 SST_HMDC_HDDA_E0_ALLCH
| SST_HMDC_HDDA_E1_ALLCH
,
1757 SST_HMDC_HDDA_E0_ALLCH
| SST_HMDC_HDDA_E1_ALLCH
);
1759 for (item
= 0; item
< hsw
->dx
.entries_no
; item
++) {
1760 if (hsw
->dx
.mem_info
[item
].source
== SST_HSW_DX_TYPE_MEMORY_DUMP
1761 && hsw
->dx
.mem_info
[item
].offset
> DSP_DRAM_ADDR_OFFSET
1762 && hsw
->dx
.mem_info
[item
].offset
<
1763 DSP_DRAM_ADDR_OFFSET
+ SST_HSW_DX_CONTEXT_SIZE
) {
1765 offset
= hsw
->dx
.mem_info
[item
].offset
1766 - DSP_DRAM_ADDR_OFFSET
;
1767 size
= (hsw
->dx
.mem_info
[item
].size
+ 3) & (~3);
1769 ret
= sst_dsp_dma_copyfrom(sst
, hsw
->dx_context_paddr
+ offset
,
1770 sst
->addr
.lpe_base
+ offset
, size
);
1773 "error: FW context dump failed\n");
1774 memset(&hsw
->dx
, 0, sizeof(hsw
->dx
));
1781 sst_dsp_dma_put_channel(sst
);
1785 static int sst_hsw_dx_state_restore(struct sst_hsw
*hsw
)
1787 struct sst_dsp
*sst
= hsw
->dsp
;
1788 u32 item
, offset
, size
;
1791 for (item
= 0; item
< hsw
->dx
.entries_no
; item
++) {
1792 if (hsw
->dx
.mem_info
[item
].source
== SST_HSW_DX_TYPE_MEMORY_DUMP
1793 && hsw
->dx
.mem_info
[item
].offset
> DSP_DRAM_ADDR_OFFSET
1794 && hsw
->dx
.mem_info
[item
].offset
<
1795 DSP_DRAM_ADDR_OFFSET
+ SST_HSW_DX_CONTEXT_SIZE
) {
1797 offset
= hsw
->dx
.mem_info
[item
].offset
1798 - DSP_DRAM_ADDR_OFFSET
;
1799 size
= (hsw
->dx
.mem_info
[item
].size
+ 3) & (~3);
1801 ret
= sst_dsp_dma_copyto(sst
, sst
->addr
.lpe_base
+ offset
,
1802 hsw
->dx_context_paddr
+ offset
, size
);
1805 "error: FW context restore failed\n");
1814 static void sst_hsw_drop_all(struct sst_hsw
*hsw
)
1816 struct ipc_message
*msg
, *tmp
;
1817 unsigned long flags
;
1818 int tx_drop_cnt
= 0, rx_drop_cnt
= 0;
1820 /* drop all TX and Rx messages before we stall + reset DSP */
1821 spin_lock_irqsave(&hsw
->dsp
->spinlock
, flags
);
1823 list_for_each_entry_safe(msg
, tmp
, &hsw
->tx_list
, list
) {
1824 list_move(&msg
->list
, &hsw
->empty_list
);
1828 list_for_each_entry_safe(msg
, tmp
, &hsw
->rx_list
, list
) {
1829 list_move(&msg
->list
, &hsw
->empty_list
);
1833 spin_unlock_irqrestore(&hsw
->dsp
->spinlock
, flags
);
1835 if (tx_drop_cnt
|| rx_drop_cnt
)
1836 dev_err(hsw
->dev
, "dropped IPC msg RX=%d, TX=%d\n",
1837 tx_drop_cnt
, rx_drop_cnt
);
1840 int sst_hsw_dsp_load(struct sst_hsw
*hsw
)
1842 struct sst_dsp
*dsp
= hsw
->dsp
;
1845 dev_dbg(hsw
->dev
, "loading audio DSP....");
1847 ret
= sst_dsp_wake(dsp
);
1849 dev_err(hsw
->dev
, "error: failed to wake audio DSP\n");
1853 ret
= sst_dsp_dma_get_channel(dsp
, 0);
1855 dev_err(hsw
->dev
, "error: cant allocate dma channel %d\n", ret
);
1859 ret
= sst_fw_reload(hsw
->sst_fw
);
1861 dev_err(hsw
->dev
, "error: SST FW reload failed\n");
1862 sst_dsp_dma_put_channel(dsp
);
1866 sst_dsp_dma_put_channel(dsp
);
1870 static int sst_hsw_dsp_restore(struct sst_hsw
*hsw
)
1872 struct sst_dsp
*dsp
= hsw
->dsp
;
1875 dev_dbg(hsw
->dev
, "restoring audio DSP....");
1877 ret
= sst_dsp_dma_get_channel(dsp
, 0);
1879 dev_err(hsw
->dev
, "error: cant allocate dma channel %d\n", ret
);
1883 ret
= sst_hsw_dx_state_restore(hsw
);
1885 dev_err(hsw
->dev
, "error: SST FW context restore failed\n");
1886 sst_dsp_dma_put_channel(dsp
);
1889 sst_dsp_dma_put_channel(dsp
);
1891 /* wait for DSP boot completion */
1897 int sst_hsw_dsp_runtime_suspend(struct sst_hsw
*hsw
)
1901 dev_dbg(hsw
->dev
, "audio dsp runtime suspend\n");
1903 ret
= sst_hsw_dx_set_state(hsw
, SST_HSW_DX_STATE_D3
, &hsw
->dx
);
1907 sst_dsp_stall(hsw
->dsp
);
1909 ret
= sst_hsw_dx_state_dump(hsw
);
1913 sst_hsw_drop_all(hsw
);
1918 int sst_hsw_dsp_runtime_sleep(struct sst_hsw
*hsw
)
1920 sst_fw_unload(hsw
->sst_fw
);
1921 sst_block_free_scratch(hsw
->dsp
);
1923 hsw
->boot_complete
= false;
1925 sst_dsp_sleep(hsw
->dsp
);
1930 int sst_hsw_dsp_runtime_resume(struct sst_hsw
*hsw
)
1932 struct device
*dev
= hsw
->dev
;
1935 dev_dbg(dev
, "audio dsp runtime resume\n");
1937 if (hsw
->boot_complete
)
1938 return 1; /* tell caller no action is required */
1940 ret
= sst_hsw_dsp_restore(hsw
);
1942 dev_err(dev
, "error: audio DSP boot failure\n");
1944 ret
= wait_event_timeout(hsw
->boot_wait
, hsw
->boot_complete
,
1945 msecs_to_jiffies(IPC_BOOT_MSECS
));
1947 dev_err(hsw
->dev
, "error: audio DSP boot timeout IPCD 0x%x IPCX 0x%x\n",
1948 sst_dsp_shim_read_unlocked(hsw
->dsp
, SST_IPCD
),
1949 sst_dsp_shim_read_unlocked(hsw
->dsp
, SST_IPCX
));
1953 /* Set ADSP SSP port settings */
1954 ret
= sst_hsw_device_set_config(hsw
, SST_HSW_DEVICE_SSP_0
,
1955 SST_HSW_DEVICE_MCLK_FREQ_24_MHZ
,
1956 SST_HSW_DEVICE_CLOCK_MASTER
, 9);
1958 dev_err(dev
, "error: SSP re-initialization failed\n");
1964 static int msg_empty_list_init(struct sst_hsw
*hsw
)
1968 hsw
->msg
= kzalloc(sizeof(struct ipc_message
) *
1969 IPC_EMPTY_LIST_SIZE
, GFP_KERNEL
);
1970 if (hsw
->msg
== NULL
)
1973 for (i
= 0; i
< IPC_EMPTY_LIST_SIZE
; i
++) {
1974 init_waitqueue_head(&hsw
->msg
[i
].waitq
);
1975 list_add(&hsw
->msg
[i
].list
, &hsw
->empty_list
);
1981 struct sst_dsp
*sst_hsw_get_dsp(struct sst_hsw
*hsw
)
1986 static struct sst_dsp_device hsw_dev
= {
1987 .thread
= hsw_irq_thread
,
1988 .ops
= &haswell_ops
,
1991 int sst_hsw_dsp_init(struct device
*dev
, struct sst_pdata
*pdata
)
1993 struct sst_hsw_ipc_fw_version version
;
1994 struct sst_hsw
*hsw
;
1997 dev_dbg(dev
, "initialising Audio DSP IPC\n");
1999 hsw
= devm_kzalloc(dev
, sizeof(*hsw
), GFP_KERNEL
);
2004 INIT_LIST_HEAD(&hsw
->stream_list
);
2005 INIT_LIST_HEAD(&hsw
->tx_list
);
2006 INIT_LIST_HEAD(&hsw
->rx_list
);
2007 INIT_LIST_HEAD(&hsw
->empty_list
);
2008 init_waitqueue_head(&hsw
->boot_wait
);
2009 init_waitqueue_head(&hsw
->wait_txq
);
2011 ret
= msg_empty_list_init(hsw
);
2015 /* start the IPC message thread */
2016 init_kthread_worker(&hsw
->kworker
);
2017 hsw
->tx_thread
= kthread_run(kthread_worker_fn
,
2018 &hsw
->kworker
, "%s",
2019 dev_name(hsw
->dev
));
2020 if (IS_ERR(hsw
->tx_thread
)) {
2021 ret
= PTR_ERR(hsw
->tx_thread
);
2022 dev_err(hsw
->dev
, "error: failed to create message TX task\n");
2025 init_kthread_work(&hsw
->kwork
, ipc_tx_msgs
);
2027 hsw_dev
.thread_context
= hsw
;
2030 hsw
->dsp
= sst_dsp_new(dev
, &hsw_dev
, pdata
);
2031 if (hsw
->dsp
== NULL
) {
2036 /* allocate DMA buffer for context storage */
2037 hsw
->dx_context
= dma_alloc_coherent(hsw
->dsp
->dma_dev
,
2038 SST_HSW_DX_CONTEXT_SIZE
, &hsw
->dx_context_paddr
, GFP_KERNEL
);
2039 if (hsw
->dx_context
== NULL
) {
2044 /* keep the DSP in reset state for base FW loading */
2045 sst_dsp_reset(hsw
->dsp
);
2047 hsw
->sst_fw
= sst_fw_new(hsw
->dsp
, pdata
->fw
, hsw
);
2048 if (hsw
->sst_fw
== NULL
) {
2050 dev_err(dev
, "error: failed to load firmware\n");
2054 /* wait for DSP boot completion */
2055 sst_dsp_boot(hsw
->dsp
);
2056 ret
= wait_event_timeout(hsw
->boot_wait
, hsw
->boot_complete
,
2057 msecs_to_jiffies(IPC_BOOT_MSECS
));
2060 dev_err(hsw
->dev
, "error: audio DSP boot timeout IPCD 0x%x IPCX 0x%x\n",
2061 sst_dsp_shim_read_unlocked(hsw
->dsp
, SST_IPCD
),
2062 sst_dsp_shim_read_unlocked(hsw
->dsp
, SST_IPCX
));
2066 /* get the FW version */
2067 sst_hsw_fw_get_version(hsw
, &version
);
2069 /* get the globalmixer */
2070 ret
= sst_hsw_mixer_get_info(hsw
);
2072 dev_err(hsw
->dev
, "error: failed to get stream info\n");
2080 sst_dsp_reset(hsw
->dsp
);
2081 sst_fw_free(hsw
->sst_fw
);
2083 dma_free_coherent(hsw
->dsp
->dma_dev
, SST_HSW_DX_CONTEXT_SIZE
,
2084 hsw
->dx_context
, hsw
->dx_context_paddr
);
2086 sst_dsp_free(hsw
->dsp
);
2088 kthread_stop(hsw
->tx_thread
);
2094 EXPORT_SYMBOL_GPL(sst_hsw_dsp_init
);
2096 void sst_hsw_dsp_free(struct device
*dev
, struct sst_pdata
*pdata
)
2098 struct sst_hsw
*hsw
= pdata
->dsp
;
2100 sst_dsp_reset(hsw
->dsp
);
2101 sst_fw_free_all(hsw
->dsp
);
2102 dma_free_coherent(hsw
->dsp
->dma_dev
, SST_HSW_DX_CONTEXT_SIZE
,
2103 hsw
->dx_context
, hsw
->dx_context_paddr
);
2104 sst_dsp_free(hsw
->dsp
);
2105 kfree(hsw
->scratch
);
2106 kthread_stop(hsw
->tx_thread
);
2109 EXPORT_SYMBOL_GPL(sst_hsw_dsp_free
);