2 * Driver for Digigram miXart soundcards
4 * low level interface with interrupt handling and mail box implementation
6 * Copyright (c) 2003 by Digigram <alsa@digigram.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <sound/driver.h>
24 #include <linux/interrupt.h>
26 #include <sound/core.h>
28 #include "mixart_hwdep.h"
29 #include "mixart_core.h"
32 #define MSG_TIMEOUT_JIFFIES (400 * HZ) / 1000 /* 400 ms */
34 #define MSG_DESCRIPTOR_SIZE 0x24
35 #define MSG_HEADER_SIZE (MSG_DESCRIPTOR_SIZE + 4)
37 #define MSG_DEFAULT_SIZE 512
39 #define MSG_TYPE_MASK 0x00000003 /* mask for following types */
40 #define MSG_TYPE_NOTIFY 0 /* embedded -> driver (only notification, do not get_msg() !) */
41 #define MSG_TYPE_COMMAND 1 /* driver <-> embedded (a command has no answer) */
42 #define MSG_TYPE_REQUEST 2 /* driver -> embedded (request will get an answer back) */
43 #define MSG_TYPE_ANSWER 3 /* embedded -> driver */
44 #define MSG_CANCEL_NOTIFY_MASK 0x80000000 /* this bit is set for a notification that has been canceled */
47 static int retrieve_msg_frame(mixart_mgr_t *mgr, u32 *msg_frame)
49 /* read the message frame fifo */
52 tailptr = readl_be(MIXART_MEM(mgr, MSG_OUTBOUND_POST_TAIL));
53 headptr = readl_be(MIXART_MEM(mgr, MSG_OUTBOUND_POST_HEAD));
55 if (tailptr == headptr)
56 return 0; /* no message posted */
58 snd_assert( tailptr >= MSG_OUTBOUND_POST_STACK, return 0); /* error */
59 snd_assert( tailptr < (MSG_OUTBOUND_POST_STACK+MSG_BOUND_STACK_SIZE), return 0); /* error */
61 *msg_frame = readl_be(MIXART_MEM(mgr, tailptr));
63 /* increment the tail index */
65 if( tailptr >= (MSG_OUTBOUND_POST_STACK+MSG_BOUND_STACK_SIZE) )
66 tailptr = MSG_OUTBOUND_POST_STACK;
67 writel_be(tailptr, MIXART_MEM(mgr, MSG_OUTBOUND_POST_TAIL));
72 static int get_msg(mixart_mgr_t *mgr, mixart_msg_t *resp, u32 msg_frame_address )
79 spin_lock_irqsave(&mgr->msg_lock, flags);
82 /* copy message descriptor from miXart to driver */
83 size = readl_be(MIXART_MEM(mgr, msg_frame_address)); /* size of descriptor + response */
84 resp->message_id = readl_be(MIXART_MEM(mgr, msg_frame_address + 4)); /* dwMessageID */
85 resp->uid.object_id = readl_be(MIXART_MEM(mgr, msg_frame_address + 8)); /* uidDest */
86 resp->uid.desc = readl_be(MIXART_MEM(mgr, msg_frame_address + 12)); /* */
88 if( (size < MSG_DESCRIPTOR_SIZE) || (resp->size < (size - MSG_DESCRIPTOR_SIZE))) {
90 snd_printk(KERN_ERR "problem with response size = %d\n", size);
93 size -= MSG_DESCRIPTOR_SIZE;
95 memcpy_fromio(resp->data, (void *)MIXART_MEM(mgr, msg_frame_address + MSG_HEADER_SIZE ), size);
98 /* swap if necessary */
100 size /= 4; /* u32 size */
101 for(i=0; i < size; i++) {
102 ((u32*)resp->data)[i] = be32_to_cpu(((u32*)resp->data)[i]);
107 * free message frame address
109 headptr = readl_be(MIXART_MEM(mgr, MSG_OUTBOUND_FREE_HEAD));
111 if( (headptr < MSG_OUTBOUND_FREE_STACK) || ( headptr >= (MSG_OUTBOUND_FREE_STACK+MSG_BOUND_STACK_SIZE))) {
116 /* give address back to outbound fifo */
117 writel_be(msg_frame_address, MIXART_MEM(mgr, headptr));
119 /* increment the outbound free head */
121 if( headptr >= (MSG_OUTBOUND_FREE_STACK+MSG_BOUND_STACK_SIZE) )
122 headptr = MSG_OUTBOUND_FREE_STACK;
124 writel_be(headptr, MIXART_MEM(mgr, MSG_OUTBOUND_FREE_HEAD));
127 spin_unlock_irqrestore(&mgr->msg_lock, flags);
134 * send a message to miXart. return: the msg_frame used for this message
136 /* call with mgr->msg_lock held! */
137 static int send_msg( mixart_mgr_t *mgr,
143 u32 headptr, tailptr;
144 u32 msg_frame_address;
147 snd_assert(msg->size % 4 == 0, return -EINVAL);
151 /* get message frame address */
152 tailptr = readl_be(MIXART_MEM(mgr, MSG_INBOUND_FREE_TAIL));
153 headptr = readl_be(MIXART_MEM(mgr, MSG_INBOUND_FREE_HEAD));
155 if (tailptr == headptr) {
156 snd_printk(KERN_ERR "error: no message frame available\n");
160 if( (tailptr < MSG_INBOUND_FREE_STACK) || (tailptr >= (MSG_INBOUND_FREE_STACK+MSG_BOUND_STACK_SIZE))) {
164 msg_frame_address = readl_be(MIXART_MEM(mgr, tailptr));
165 writel(0, MIXART_MEM(mgr, tailptr)); /* set address to zero on this fifo position */
167 /* increment the inbound free tail */
169 if( tailptr >= (MSG_INBOUND_FREE_STACK+MSG_BOUND_STACK_SIZE) )
170 tailptr = MSG_INBOUND_FREE_STACK;
172 writel_be(tailptr, MIXART_MEM(mgr, MSG_INBOUND_FREE_TAIL));
174 /* TODO : use memcpy_toio() with intermediate buffer to copy the message */
176 /* copy message descriptor to card memory */
177 writel_be( msg->size + MSG_DESCRIPTOR_SIZE, MIXART_MEM(mgr, msg_frame_address) ); /* size of descriptor + request */
178 writel_be( msg->message_id , MIXART_MEM(mgr, msg_frame_address + 4) ); /* dwMessageID */
179 writel_be( msg->uid.object_id, MIXART_MEM(mgr, msg_frame_address + 8) ); /* uidDest */
180 writel_be( msg->uid.desc, MIXART_MEM(mgr, msg_frame_address + 12) ); /* */
181 writel_be( MSG_DESCRIPTOR_SIZE, MIXART_MEM(mgr, msg_frame_address + 16) ); /* SizeHeader */
182 writel_be( MSG_DESCRIPTOR_SIZE, MIXART_MEM(mgr, msg_frame_address + 20) ); /* OffsetDLL_T16 */
183 writel_be( msg->size, MIXART_MEM(mgr, msg_frame_address + 24) ); /* SizeDLL_T16 */
184 writel_be( MSG_DESCRIPTOR_SIZE, MIXART_MEM(mgr, msg_frame_address + 28) ); /* OffsetDLL_DRV */
185 writel_be( 0, MIXART_MEM(mgr, msg_frame_address + 32) ); /* SizeDLL_DRV */
186 writel_be( MSG_DESCRIPTOR_SIZE + max_answersize, MIXART_MEM(mgr, msg_frame_address + 36) ); /* dwExpectedAnswerSize */
188 /* copy message data to card memory */
189 for( i=0; i < msg->size; i+=4 ) {
190 writel_be( *(u32*)(msg->data + i), MIXART_MEM(mgr, MSG_HEADER_SIZE + msg_frame_address + i) );
195 /* the pending event is the notification we wait for ! */
196 mgr->pending_event = *msg_event;
199 /* the pending event is the answer we wait for (same address than the request)! */
200 mgr->pending_event = msg_frame_address;
202 /* copy address back to caller */
203 *msg_event = msg_frame_address;
207 /* mark the frame as a request (will have an answer) */
208 msg_frame_address |= MSG_TYPE_REQUEST;
211 headptr = readl_be(MIXART_MEM(mgr, MSG_INBOUND_POST_HEAD));
213 if( (headptr < MSG_INBOUND_POST_STACK) || (headptr >= (MSG_INBOUND_POST_STACK+MSG_BOUND_STACK_SIZE))) {
217 writel_be(msg_frame_address, MIXART_MEM(mgr, headptr));
219 /* increment the inbound post head */
221 if( headptr >= (MSG_INBOUND_POST_STACK+MSG_BOUND_STACK_SIZE) )
222 headptr = MSG_INBOUND_POST_STACK;
224 writel_be(headptr, MIXART_MEM(mgr, MSG_INBOUND_POST_HEAD));
230 int snd_mixart_send_msg(mixart_mgr_t *mgr, mixart_msg_t *request, int max_resp_size, void *resp_data)
233 u32 msg_frame = 0; /* set to 0, so it's no notification to wait for, but the answer */
238 down(&mgr->msg_mutex);
240 init_waitqueue_entry(&wait, current);
242 spin_lock_irq(&mgr->msg_lock);
243 /* send the message */
244 err = send_msg(mgr, request, max_resp_size, 1, &msg_frame); /* send and mark the answer pending */
246 spin_unlock_irq(&mgr->msg_lock);
251 set_current_state(TASK_UNINTERRUPTIBLE);
252 add_wait_queue(&mgr->msg_sleep, &wait);
253 spin_unlock_irq(&mgr->msg_lock);
254 timeout = schedule_timeout(MSG_TIMEOUT_JIFFIES);
255 remove_wait_queue(&mgr->msg_sleep, &wait);
260 snd_printk(KERN_ERR "error: no reponse on msg %x\n", msg_frame);
264 /* retrieve the answer into the same mixart_msg_t */
266 resp.uid = (mixart_uid_t){0,0};
267 resp.data = resp_data;
268 resp.size = max_resp_size;
270 err = get_msg(mgr, &resp, msg_frame);
272 if( request->message_id != resp.message_id )
273 snd_printk(KERN_ERR "REPONSE ERROR!\n");
280 int snd_mixart_send_msg_wait_notif(mixart_mgr_t *mgr, mixart_msg_t *request, u32 notif_event)
286 snd_assert(notif_event != 0, return -EINVAL);
287 snd_assert((notif_event & MSG_TYPE_MASK) == MSG_TYPE_NOTIFY, return -EINVAL);
288 snd_assert((notif_event & MSG_CANCEL_NOTIFY_MASK) == 0, return -EINVAL);
290 down(&mgr->msg_mutex);
292 init_waitqueue_entry(&wait, current);
294 spin_lock_irq(&mgr->msg_lock);
295 /* send the message */
296 err = send_msg(mgr, request, MSG_DEFAULT_SIZE, 1, ¬if_event); /* send and mark the notification event pending */
298 spin_unlock_irq(&mgr->msg_lock);
303 set_current_state(TASK_UNINTERRUPTIBLE);
304 add_wait_queue(&mgr->msg_sleep, &wait);
305 spin_unlock_irq(&mgr->msg_lock);
306 timeout = schedule_timeout(MSG_TIMEOUT_JIFFIES);
307 remove_wait_queue(&mgr->msg_sleep, &wait);
312 snd_printk(KERN_ERR "error: notification %x not received\n", notif_event);
321 int snd_mixart_send_msg_nonblock(mixart_mgr_t *mgr, mixart_msg_t *request)
327 /* just send the message (do not mark it as a pending one) */
328 spin_lock_irqsave(&mgr->msg_lock, flags);
329 err = send_msg(mgr, request, MSG_DEFAULT_SIZE, 0, &message_frame);
330 spin_unlock_irqrestore(&mgr->msg_lock, flags);
332 /* the answer will be handled by snd_mixart_msg_tasklet() */
333 atomic_inc(&mgr->msg_processed);
339 /* common buffer of tasklet and interrupt to send/receive messages */
340 static u32 mixart_msg_data[MSG_DEFAULT_SIZE / 4];
343 void snd_mixart_msg_tasklet( unsigned long arg)
345 mixart_mgr_t *mgr = ( mixart_mgr_t*)(arg);
350 spin_lock(&mgr->lock);
352 while (mgr->msg_fifo_readptr != mgr->msg_fifo_writeptr) {
353 msg = mgr->msg_fifo[mgr->msg_fifo_readptr];
354 mgr->msg_fifo_readptr++;
355 mgr->msg_fifo_readptr %= MSG_FIFO_SIZE;
357 /* process the message ... */
358 addr = msg & ~MSG_TYPE_MASK;
359 type = msg & MSG_TYPE_MASK;
362 case MSG_TYPE_ANSWER:
363 /* answer to a message on that we did not wait for (send_msg_nonblock) */
365 resp.data = mixart_msg_data;
366 resp.size = sizeof(mixart_msg_data);
367 err = get_msg(mgr, &resp, addr);
369 snd_printk(KERN_ERR "tasklet: error(%d) reading mf %x\n", err, msg);
373 switch(resp.message_id) {
374 case MSG_STREAM_START_INPUT_STAGE_PACKET:
375 case MSG_STREAM_START_OUTPUT_STAGE_PACKET:
376 case MSG_STREAM_STOP_INPUT_STAGE_PACKET:
377 case MSG_STREAM_STOP_OUTPUT_STAGE_PACKET:
378 if(mixart_msg_data[0])
379 snd_printk(KERN_ERR "tasklet : error MSG_STREAM_ST***_***PUT_STAGE_PACKET status=%x\n", mixart_msg_data[0]);
382 snd_printdd("tasklet received mf(%x) : msg_id(%x) uid(%x, %x) size(%d)\n",
383 msg, resp.message_id, resp.uid.object_id, resp.uid.desc, resp.size);
387 case MSG_TYPE_NOTIFY:
388 /* msg contains no address ! do not get_msg() ! */
389 case MSG_TYPE_COMMAND:
390 /* get_msg() necessary */
392 snd_printk(KERN_ERR "tasklet doesn't know what to do with message %x\n", msg);
395 /* decrement counter */
396 atomic_dec(&mgr->msg_processed);
398 } /* while there is a msg in fifo */
400 spin_unlock(&mgr->lock);
404 irqreturn_t snd_mixart_interrupt(int irq, void *dev_id, struct pt_regs *regs)
406 mixart_mgr_t *mgr = snd_magic_cast(mixart_mgr_t, dev_id, return IRQ_NONE);
413 spin_lock(&mgr->lock);
415 it_reg = readl_le(MIXART_REG(mgr, MIXART_PCI_OMISR_OFFSET));
416 if( !(it_reg & MIXART_OIDI) ) {
417 /* this device did not cause the interrupt */
418 spin_unlock(&mgr->lock);
422 /* mask all interrupts */
423 writel_le(MIXART_HOST_ALL_INTERRUPT_MASKED, MIXART_REG(mgr, MIXART_PCI_OMIMR_OFFSET));
425 /* outdoorbell register clear */
426 it_reg = readl(MIXART_REG(mgr, MIXART_PCI_ODBR_OFFSET));
427 writel(it_reg, MIXART_REG(mgr, MIXART_PCI_ODBR_OFFSET));
429 /* clear interrupt */
430 writel_le( MIXART_OIDI, MIXART_REG(mgr, MIXART_PCI_OMISR_OFFSET) );
432 /* process interrupt */
433 while (retrieve_msg_frame(mgr, &msg)) {
435 switch (msg & MSG_TYPE_MASK) {
436 case MSG_TYPE_COMMAND:
438 resp.data = mixart_msg_data;
439 resp.size = sizeof(mixart_msg_data);
440 err = get_msg(mgr, &resp, msg & ~MSG_TYPE_MASK);
442 snd_printk(KERN_ERR "interrupt: error(%d) reading mf %x\n", err, msg);
446 if(resp.message_id == MSG_SERVICES_TIMER_NOTIFY) {
448 mixart_timer_notify_t *notify = (mixart_timer_notify_t*)mixart_msg_data;
450 for(i=0; i<notify->stream_count; i++) {
452 u32 buffer_id = notify->streams[i].buffer_id;
453 unsigned int chip_number = (buffer_id & MIXART_NOTIFY_CARD_MASK) >> MIXART_NOTIFY_CARD_OFFSET; /* card0 to 3 */
454 unsigned int pcm_number = (buffer_id & MIXART_NOTIFY_PCM_MASK ) >> MIXART_NOTIFY_PCM_OFFSET; /* pcm0 to 3 */
455 unsigned int sub_number = buffer_id & MIXART_NOTIFY_SUBS_MASK; /* 0 to MIXART_PLAYBACK_STREAMS */
456 unsigned int is_capture = ((buffer_id & MIXART_NOTIFY_CAPT_MASK) != 0); /* playback == 0 / capture == 1 */
458 mixart_t *chip = mgr->chip[chip_number];
459 mixart_stream_t *stream;
461 if ((chip_number >= mgr->num_cards) || (pcm_number >= MIXART_PCM_TOTAL) || (sub_number >= MIXART_PLAYBACK_STREAMS)) {
462 snd_printk(KERN_ERR "error MSG_SERVICES_TIMER_NOTIFY buffer_id (%x) pos(%d)\n",
463 buffer_id, notify->streams[i].sample_pos_low_part);
468 stream = &chip->capture_stream[pcm_number];
470 stream = &chip->playback_stream[pcm_number][sub_number];
472 if (stream->substream && (stream->status == MIXART_STREAM_STATUS_RUNNING)) {
473 snd_pcm_runtime_t *runtime = stream->substream->runtime;
475 u64 sample_count = ((u64)notify->streams[i].sample_pos_high_part) << 32;
476 sample_count |= notify->streams[i].sample_pos_low_part;
479 u64 new_elapse_pos = stream->abs_period_elapsed + runtime->period_size;
481 if (new_elapse_pos > sample_count) {
486 stream->buf_periods++;
487 if (stream->buf_periods >= runtime->periods)
488 stream->buf_periods = 0;
490 stream->abs_period_elapsed = new_elapse_pos;
493 stream->buf_period_frag = (u32)( sample_count - stream->abs_period_elapsed );
496 spin_unlock(&mgr->lock);
497 snd_pcm_period_elapsed(stream->substream);
498 spin_lock(&mgr->lock);
504 if(resp.message_id == MSG_SERVICES_REPORT_TRACES) {
507 /* Traces are text: the swapped msg_data has to be swapped back ! */
509 for(i=0; i<(resp.size/4); i++) {
510 (mixart_msg_data)[i] = cpu_to_be32((mixart_msg_data)[i]);
513 ((char*)mixart_msg_data)[resp.size - 1] = 0;
514 snd_printdd("MIXART TRACE : %s\n", (char*)mixart_msg_data);
519 snd_printdd("command %x not handled\n", resp.message_id);
522 case MSG_TYPE_NOTIFY:
523 if(msg & MSG_CANCEL_NOTIFY_MASK) {
524 msg &= ~MSG_CANCEL_NOTIFY_MASK;
525 snd_printk(KERN_ERR "canceled notification %x !\n", msg);
527 /* no break, continue ! */
528 case MSG_TYPE_ANSWER:
529 /* answer or notification to a message we are waiting for*/
530 spin_lock(&mgr->msg_lock);
531 if( (msg & ~MSG_TYPE_MASK) == mgr->pending_event ) {
532 wake_up(&mgr->msg_sleep);
533 mgr->pending_event = 0;
535 /* answer to a message we did't want to wait for */
537 mgr->msg_fifo[mgr->msg_fifo_writeptr] = msg;
538 mgr->msg_fifo_writeptr++;
539 mgr->msg_fifo_writeptr %= MSG_FIFO_SIZE;
540 tasklet_hi_schedule(&mgr->msg_taskq);
542 spin_unlock(&mgr->msg_lock);
544 case MSG_TYPE_REQUEST:
546 snd_printdd("interrupt received request %x\n", msg);
547 /* TODO : are there things to do here ? */
549 } /* switch on msg type */
550 } /* while there are msgs */
552 /* allow interrupt again */
553 writel_le( MIXART_ALLOW_OUTBOUND_DOORBELL, MIXART_REG( mgr, MIXART_PCI_OMIMR_OFFSET));
555 spin_unlock(&mgr->lock);
561 void snd_mixart_init_mailbox(mixart_mgr_t *mgr)
563 writel( 0, MIXART_MEM( mgr, MSG_HOST_RSC_PROTECTION ) );
564 writel( 0, MIXART_MEM( mgr, MSG_AGENT_RSC_PROTECTION ) );
566 /* allow outbound messagebox to generate interrupts */
568 writel_le( MIXART_ALLOW_OUTBOUND_DOORBELL, MIXART_REG( mgr, MIXART_PCI_OMIMR_OFFSET));
573 void snd_mixart_exit_mailbox(mixart_mgr_t *mgr)
575 /* no more interrupts on outbound messagebox */
576 writel_le( MIXART_HOST_ALL_INTERRUPT_MASKED, MIXART_REG( mgr, MIXART_PCI_OMIMR_OFFSET));
580 void snd_mixart_reset_board(mixart_mgr_t *mgr)
583 writel_be( 1, MIXART_REG(mgr, MIXART_BA1_BRUTAL_RESET_OFFSET) );