4 * DSP-BIOS Bridge driver support functions for TI OMAP processors.
6 * Node Dispatcher interface. Communicates with Resource Manager Server
7 * (RMS) on DSP. Access to RMS is synchronized in NODE.
9 * Copyright (C) 2005-2006 Texas Instruments, Inc.
11 * This package is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
15 * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
17 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
20 /* ----------------------------------- Host OS */
21 #include <dspbridge/host_os.h>
23 /* ----------------------------------- DSP/BIOS Bridge */
24 #include <dspbridge/std.h>
25 #include <dspbridge/dbdefs.h>
27 /* ----------------------------------- Trace & Debug */
28 #include <dspbridge/dbc.h>
30 /* ----------------------------------- OS Adaptation Layer */
31 #include <dspbridge/sync.h>
33 /* ----------------------------------- Link Driver */
34 #include <dspbridge/dspdefs.h>
36 /* ----------------------------------- Platform Manager */
37 #include <dspbridge/dev.h>
38 #include <dspbridge/chnldefs.h>
40 /* ----------------------------------- Resource Manager */
41 #include <dspbridge/nodedefs.h>
42 #include <dspbridge/nodepriv.h>
43 #include <dspbridge/rms_sh.h>
45 /* ----------------------------------- This */
46 #include <dspbridge/disp.h>
48 /* Size of a reply from RMS */
49 #define REPLYSIZE (3 * sizeof(rms_word))
51 /* Reserved channel offsets for communication with RMS */
52 #define CHNLTORMSOFFSET 0
53 #define CHNLFROMRMSOFFSET 1
57 #define SWAP_WORD(x) (((u32)(x) >> 16) | ((u32)(x) << 16))
60 * ======== disp_object ========
63 struct dev_object *hdev_obj; /* Device for this processor */
64 /* Function interface to Bridge driver */
65 struct bridge_drv_interface *intf_fxns;
66 struct chnl_mgr *hchnl_mgr; /* Channel manager */
67 struct chnl_object *chnl_to_dsp; /* Chnl for commands to RMS */
68 struct chnl_object *chnl_from_dsp; /* Chnl for replies from RMS */
69 u8 *pbuf; /* Buffer for commands, replies */
70 u32 ul_bufsize; /* pbuf size in bytes */
71 u32 ul_bufsize_rms; /* pbuf size in RMS words */
72 u32 char_size; /* Size of DSP character */
73 u32 word_size; /* Size of DSP word */
74 u32 data_mau_size; /* Size of DSP Data MAU */
79 static void delete_disp(struct disp_object *disp_obj);
80 static int fill_stream_def(rms_word *pdw_buf, u32 *ptotal, u32 offset,
81 struct node_strmdef strm_def, u32 max,
82 u32 chars_in_rms_word);
83 static int send_message(struct disp_object *disp_obj, u32 timeout,
84 u32 ul_bytes, OUT u32 *pdw_arg);
87 * ======== disp_create ========
88 * Create a NODE Dispatcher object.
90 int disp_create(OUT struct disp_object **dispatch_obj,
91 struct dev_object *hdev_obj,
92 IN CONST struct disp_attr *disp_attrs)
94 struct disp_object *disp_obj;
95 struct bridge_drv_interface *intf_fxns;
97 struct chnl_attr chnl_attr_obj;
101 DBC_REQUIRE(refs > 0);
102 DBC_REQUIRE(dispatch_obj != NULL);
103 DBC_REQUIRE(disp_attrs != NULL);
104 DBC_REQUIRE(hdev_obj != NULL);
106 *dispatch_obj = NULL;
108 /* Allocate Node Dispatcher object */
109 disp_obj = kzalloc(sizeof(struct disp_object), GFP_KERNEL);
110 if (disp_obj == NULL)
113 disp_obj->hdev_obj = hdev_obj;
115 /* Get Channel manager and Bridge function interface */
116 if (DSP_SUCCEEDED(status)) {
117 status = dev_get_chnl_mgr(hdev_obj, &(disp_obj->hchnl_mgr));
118 if (DSP_SUCCEEDED(status)) {
119 (void)dev_get_intf_fxns(hdev_obj, &intf_fxns);
120 disp_obj->intf_fxns = intf_fxns;
124 /* check device type and decide if streams or messag'ing is used for
126 if (DSP_FAILED(status))
129 status = dev_get_dev_type(hdev_obj, &dev_type);
131 if (DSP_FAILED(status))
134 if (dev_type != DSP_UNIT) {
139 disp_obj->char_size = DSPWORDSIZE;
140 disp_obj->word_size = DSPWORDSIZE;
141 disp_obj->data_mau_size = DSPWORDSIZE;
142 /* Open channels for communicating with the RMS */
143 chnl_attr_obj.uio_reqs = CHNLIOREQS;
144 chnl_attr_obj.event_obj = NULL;
145 ul_chnl_id = disp_attrs->ul_chnl_offset + CHNLTORMSOFFSET;
146 status = (*intf_fxns->pfn_chnl_open) (&(disp_obj->chnl_to_dsp),
148 CHNL_MODETODSP, ul_chnl_id,
151 if (DSP_SUCCEEDED(status)) {
152 ul_chnl_id = disp_attrs->ul_chnl_offset + CHNLFROMRMSOFFSET;
154 (*intf_fxns->pfn_chnl_open) (&(disp_obj->chnl_from_dsp),
156 CHNL_MODEFROMDSP, ul_chnl_id,
159 if (DSP_SUCCEEDED(status)) {
160 /* Allocate buffer for commands, replies */
161 disp_obj->ul_bufsize = disp_attrs->ul_chnl_buf_size;
162 disp_obj->ul_bufsize_rms = RMS_COMMANDBUFSIZE;
163 disp_obj->pbuf = kzalloc(disp_obj->ul_bufsize, GFP_KERNEL);
164 if (disp_obj->pbuf == NULL)
168 if (DSP_SUCCEEDED(status))
169 *dispatch_obj = disp_obj;
171 delete_disp(disp_obj);
173 DBC_ENSURE(((DSP_FAILED(status)) && ((*dispatch_obj == NULL))) ||
174 ((DSP_SUCCEEDED(status)) && *dispatch_obj));
179 * ======== disp_delete ========
180 * Delete the NODE Dispatcher.
182 void disp_delete(struct disp_object *disp_obj)
184 DBC_REQUIRE(refs > 0);
185 DBC_REQUIRE(disp_obj);
187 delete_disp(disp_obj);
191 * ======== disp_exit ========
192 * Discontinue usage of DISP module.
196 DBC_REQUIRE(refs > 0);
200 DBC_ENSURE(refs >= 0);
204 * ======== disp_init ========
205 * Initialize the DISP module.
211 DBC_REQUIRE(refs >= 0);
216 DBC_ENSURE((ret && (refs > 0)) || (!ret && (refs >= 0)));
221 * ======== disp_node_change_priority ========
222 * Change the priority of a node currently running on the target.
224 int disp_node_change_priority(struct disp_object *disp_obj,
225 struct node_object *hnode,
226 u32 ulRMSFxn, nodeenv node_env, s32 prio)
229 struct rms_command *rms_cmd;
232 DBC_REQUIRE(refs > 0);
233 DBC_REQUIRE(disp_obj);
234 DBC_REQUIRE(hnode != NULL);
236 /* Send message to RMS to change priority */
237 rms_cmd = (struct rms_command *)(disp_obj->pbuf);
238 rms_cmd->fxn = (rms_word) (ulRMSFxn);
239 rms_cmd->arg1 = (rms_word) node_env;
240 rms_cmd->arg2 = prio;
241 status = send_message(disp_obj, node_get_timeout(hnode),
242 sizeof(struct rms_command), &dw_arg);
248 * ======== disp_node_create ========
249 * Create a node on the DSP by remotely calling the node's create function.
251 int disp_node_create(struct disp_object *disp_obj,
252 struct node_object *hnode, u32 ulRMSFxn,
254 IN CONST struct node_createargs *pargs,
255 OUT nodeenv *node_env)
257 struct node_msgargs node_msg_args;
258 struct node_taskargs task_arg_obj;
259 struct rms_command *rms_cmd;
260 struct rms_msg_args *pmsg_args;
261 struct rms_more_task_args *more_task_args;
262 enum node_type node_type;
264 rms_word *pdw_buf = NULL;
268 u32 chars_in_rms_word;
269 s32 task_args_offset;
270 s32 sio_in_def_offset;
271 s32 sio_out_def_offset;
273 s32 args_offset = -1;
275 struct node_strmdef strm_def;
278 struct dsp_nodeinfo node_info;
281 DBC_REQUIRE(refs > 0);
282 DBC_REQUIRE(disp_obj);
283 DBC_REQUIRE(hnode != NULL);
284 DBC_REQUIRE(node_get_type(hnode) != NODE_DEVICE);
285 DBC_REQUIRE(node_env != NULL);
287 status = dev_get_dev_type(disp_obj->hdev_obj, &dev_type);
289 if (DSP_FAILED(status))
292 if (dev_type != DSP_UNIT) {
293 dev_dbg(bridge, "%s: unknown device type = 0x%x\n",
297 DBC_REQUIRE(pargs != NULL);
298 node_type = node_get_type(hnode);
299 node_msg_args = pargs->asa.node_msg_args;
300 max = disp_obj->ul_bufsize_rms; /*Max # of RMS words that can be sent */
301 DBC_ASSERT(max == RMS_COMMANDBUFSIZE);
302 chars_in_rms_word = sizeof(rms_word) / disp_obj->char_size;
303 /* Number of RMS words needed to hold arg data */
305 (node_msg_args.arg_length + chars_in_rms_word -
306 1) / chars_in_rms_word;
307 /* Make sure msg args and command fit in buffer */
308 total = sizeof(struct rms_command) / sizeof(rms_word) +
309 sizeof(struct rms_msg_args)
310 / sizeof(rms_word) - 1 + dw_length;
313 dev_dbg(bridge, "%s: Message args too large for buffer! size "
314 "= %d, max = %d\n", __func__, total, max);
317 * Fill in buffer to send to RMS.
318 * The buffer will have the following format:
321 * Address of RMS_CreateNode()
322 * Address of node's create function
327 * max number of messages
328 * segid for message buffer allocation
329 * notification type to use when message is received
330 * length of message arg data
333 * Task Args (if task or socket node):
339 * number of input streams
340 * pSTRMInDef[] - offsets of STRM definitions for input streams
341 * number of output streams
342 * pSTRMOutDef[] - offsets of STRM definitions for output
344 * STRMInDef[] - array of STRM definitions for input streams
345 * STRMOutDef[] - array of STRM definitions for output streams
347 * Socket Args (if DAIS socket node):
350 if (DSP_SUCCEEDED(status)) {
351 total = 0; /* Total number of words in buffer so far */
352 pdw_buf = (rms_word *) disp_obj->pbuf;
353 rms_cmd = (struct rms_command *)pdw_buf;
354 rms_cmd->fxn = (rms_word) (ulRMSFxn);
355 rms_cmd->arg1 = (rms_word) (ul_create_fxn);
356 if (node_get_load_type(hnode) == NLDR_DYNAMICLOAD) {
357 /* Flush ICACHE on Load */
358 rms_cmd->arg2 = 1; /* dummy argument */
360 /* Do not flush ICACHE */
361 rms_cmd->arg2 = 0; /* dummy argument */
363 rms_cmd->data = node_get_type(hnode);
365 * args_offset is the offset of the data field in struct
366 * rms_command structure. We need this to calculate stream
367 * definition offsets.
370 total += sizeof(struct rms_command) / sizeof(rms_word);
372 pmsg_args = (struct rms_msg_args *)(pdw_buf + total);
373 pmsg_args->max_msgs = node_msg_args.max_msgs;
374 pmsg_args->segid = node_msg_args.seg_id;
375 pmsg_args->notify_type = node_msg_args.notify_type;
376 pmsg_args->arg_length = node_msg_args.arg_length;
377 total += sizeof(struct rms_msg_args) / sizeof(rms_word) - 1;
378 memcpy(pdw_buf + total, node_msg_args.pdata,
379 node_msg_args.arg_length);
382 if (DSP_FAILED(status))
385 /* If node is a task node, copy task create arguments into buffer */
386 if (node_type == NODE_TASK || node_type == NODE_DAISSOCKET) {
387 task_arg_obj = pargs->asa.task_arg_obj;
388 task_args_offset = total;
389 total += sizeof(struct rms_more_task_args) / sizeof(rms_word) +
390 1 + task_arg_obj.num_inputs + task_arg_obj.num_outputs;
391 /* Copy task arguments */
393 total = task_args_offset;
394 more_task_args = (struct rms_more_task_args *)(pdw_buf +
397 * Get some important info about the node. Note that we
398 * don't just reach into the hnode struct because
399 * that would break the node object's abstraction.
401 get_node_info(hnode, &node_info);
402 more_task_args->priority = node_info.execution_priority;
403 more_task_args->stack_size = task_arg_obj.stack_size;
404 more_task_args->sysstack_size =
405 task_arg_obj.sys_stack_size;
406 more_task_args->stack_seg = task_arg_obj.stack_seg;
407 more_task_args->heap_addr = task_arg_obj.udsp_heap_addr;
408 more_task_args->heap_size = task_arg_obj.heap_size;
409 more_task_args->misc = task_arg_obj.ul_dais_arg;
410 more_task_args->num_input_streams =
411 task_arg_obj.num_inputs;
413 sizeof(struct rms_more_task_args) /
415 dev_dbg(bridge, "%s: udsp_heap_addr %x, heap_size %x\n",
416 __func__, task_arg_obj.udsp_heap_addr,
417 task_arg_obj.heap_size);
418 /* Keep track of pSIOInDef[] and pSIOOutDef[]
419 * positions in the buffer, since this needs to be
420 * filled in later. */
421 sio_in_def_offset = total;
422 total += task_arg_obj.num_inputs;
423 pdw_buf[total++] = task_arg_obj.num_outputs;
424 sio_out_def_offset = total;
425 total += task_arg_obj.num_outputs;
426 sio_defs_offset = total;
427 /* Fill SIO defs and offsets */
428 offset = sio_defs_offset;
429 for (i = 0; i < task_arg_obj.num_inputs; i++) {
430 if (DSP_FAILED(status))
433 pdw_buf[sio_in_def_offset + i] =
434 (offset - args_offset)
435 * (sizeof(rms_word) / DSPWORDSIZE);
436 strm_def = task_arg_obj.strm_in_def[i];
438 fill_stream_def(pdw_buf, &total, offset,
443 for (i = 0; (i < task_arg_obj.num_outputs) &&
444 (DSP_SUCCEEDED(status)); i++) {
445 pdw_buf[sio_out_def_offset + i] =
446 (offset - args_offset)
447 * (sizeof(rms_word) / DSPWORDSIZE);
448 strm_def = task_arg_obj.strm_out_def[i];
450 fill_stream_def(pdw_buf, &total, offset,
460 if (DSP_SUCCEEDED(status)) {
461 ul_bytes = total * sizeof(rms_word);
462 DBC_ASSERT(ul_bytes < (RMS_COMMANDBUFSIZE * sizeof(rms_word)));
463 status = send_message(disp_obj, node_get_timeout(hnode),
465 if (DSP_SUCCEEDED(status)) {
467 * Message successfully received from RMS.
468 * Return the status of the Node's create function
471 status = (((rms_word *) (disp_obj->pbuf))[0]);
472 if (DSP_FAILED(status))
473 dev_dbg(bridge, "%s: DSP-side failed: 0x%x\n",
482 * ======== disp_node_delete ========
484 * Delete a node on the DSP by remotely calling the node's delete function.
487 int disp_node_delete(struct disp_object *disp_obj,
488 struct node_object *hnode, u32 ulRMSFxn,
489 u32 ul_delete_fxn, nodeenv node_env)
492 struct rms_command *rms_cmd;
496 DBC_REQUIRE(refs > 0);
497 DBC_REQUIRE(disp_obj);
498 DBC_REQUIRE(hnode != NULL);
500 status = dev_get_dev_type(disp_obj->hdev_obj, &dev_type);
502 if (DSP_SUCCEEDED(status)) {
504 if (dev_type == DSP_UNIT) {
507 * Fill in buffer to send to RMS
509 rms_cmd = (struct rms_command *)disp_obj->pbuf;
510 rms_cmd->fxn = (rms_word) (ulRMSFxn);
511 rms_cmd->arg1 = (rms_word) node_env;
512 rms_cmd->arg2 = (rms_word) (ul_delete_fxn);
513 rms_cmd->data = node_get_type(hnode);
515 status = send_message(disp_obj, node_get_timeout(hnode),
516 sizeof(struct rms_command),
518 if (DSP_SUCCEEDED(status)) {
520 * Message successfully received from RMS.
521 * Return the status of the Node's delete
522 * function on the DSP-side
524 status = (((rms_word *) (disp_obj->pbuf))[0]);
525 if (DSP_FAILED(status))
526 dev_dbg(bridge, "%s: DSP-side failed: "
527 "0x%x\n", __func__, status);
536 * ======== disp_node_run ========
538 * Start execution of a node's execute phase, or resume execution of a node
539 * that has been suspended (via DISP_NodePause()) on the DSP.
541 int disp_node_run(struct disp_object *disp_obj,
542 struct node_object *hnode, u32 ulRMSFxn,
543 u32 ul_execute_fxn, nodeenv node_env)
546 struct rms_command *rms_cmd;
549 DBC_REQUIRE(refs > 0);
550 DBC_REQUIRE(disp_obj);
551 DBC_REQUIRE(hnode != NULL);
553 status = dev_get_dev_type(disp_obj->hdev_obj, &dev_type);
555 if (DSP_SUCCEEDED(status)) {
557 if (dev_type == DSP_UNIT) {
560 * Fill in buffer to send to RMS.
562 rms_cmd = (struct rms_command *)disp_obj->pbuf;
563 rms_cmd->fxn = (rms_word) (ulRMSFxn);
564 rms_cmd->arg1 = (rms_word) node_env;
565 rms_cmd->arg2 = (rms_word) (ul_execute_fxn);
566 rms_cmd->data = node_get_type(hnode);
568 status = send_message(disp_obj, node_get_timeout(hnode),
569 sizeof(struct rms_command),
571 if (DSP_SUCCEEDED(status)) {
573 * Message successfully received from RMS.
574 * Return the status of the Node's execute
575 * function on the DSP-side
577 status = (((rms_word *) (disp_obj->pbuf))[0]);
578 if (DSP_FAILED(status))
579 dev_dbg(bridge, "%s: DSP-side failed: "
580 "0x%x\n", __func__, status);
590 * ======== delete_disp ========
592 * Frees the resources allocated for the dispatcher.
594 static void delete_disp(struct disp_object *disp_obj)
597 struct bridge_drv_interface *intf_fxns;
600 intf_fxns = disp_obj->intf_fxns;
602 /* Free Node Dispatcher resources */
603 if (disp_obj->chnl_from_dsp) {
604 /* Channel close can fail only if the channel handle
606 status = (*intf_fxns->pfn_chnl_close)
607 (disp_obj->chnl_from_dsp);
608 if (DSP_FAILED(status)) {
609 dev_dbg(bridge, "%s: Failed to close channel "
610 "from RMS: 0x%x\n", __func__, status);
613 if (disp_obj->chnl_to_dsp) {
615 (*intf_fxns->pfn_chnl_close) (disp_obj->
617 if (DSP_FAILED(status)) {
618 dev_dbg(bridge, "%s: Failed to close channel to"
619 " RMS: 0x%x\n", __func__, status);
622 kfree(disp_obj->pbuf);
629 * ======== fill_stream_def ========
631 * Fills stream definitions.
633 static int fill_stream_def(rms_word *pdw_buf, u32 *ptotal, u32 offset,
634 struct node_strmdef strm_def, u32 max,
635 u32 chars_in_rms_word)
637 struct rms_strm_def *strm_def_obj;
643 if (total + sizeof(struct rms_strm_def) / sizeof(rms_word) >= max) {
646 strm_def_obj = (struct rms_strm_def *)(pdw_buf + total);
647 strm_def_obj->bufsize = strm_def.buf_size;
648 strm_def_obj->nbufs = strm_def.num_bufs;
649 strm_def_obj->segid = strm_def.seg_id;
650 strm_def_obj->align = strm_def.buf_alignment;
651 strm_def_obj->timeout = strm_def.utimeout;
654 if (DSP_SUCCEEDED(status)) {
656 * Since we haven't added the device name yet, subtract
659 total += sizeof(struct rms_strm_def) / sizeof(rms_word) - 1;
660 DBC_REQUIRE(strm_def.sz_device);
661 dw_length = strlen(strm_def.sz_device) + 1;
663 /* Number of RMS_WORDS needed to hold device name */
665 (dw_length + chars_in_rms_word - 1) / chars_in_rms_word;
667 if (total + name_len >= max) {
671 * Zero out last word, since the device name may not
672 * extend to completely fill this word.
674 pdw_buf[total + name_len - 1] = 0;
675 /** TODO USE SERVICES * */
676 memcpy(pdw_buf + total, strm_def.sz_device, dw_length);
686 * ======== send_message ======
687 * Send command message to RMS, get reply from RMS.
689 static int send_message(struct disp_object *disp_obj, u32 timeout,
690 u32 ul_bytes, u32 *pdw_arg)
692 struct bridge_drv_interface *intf_fxns;
693 struct chnl_object *chnl_obj;
696 struct chnl_ioc chnl_ioc_obj;
699 DBC_REQUIRE(pdw_arg != NULL);
701 *pdw_arg = (u32) NULL;
702 intf_fxns = disp_obj->intf_fxns;
703 chnl_obj = disp_obj->chnl_to_dsp;
704 pbuf = disp_obj->pbuf;
706 /* Send the command */
707 status = (*intf_fxns->pfn_chnl_add_io_req) (chnl_obj, pbuf, ul_bytes, 0,
709 if (DSP_FAILED(status))
713 (*intf_fxns->pfn_chnl_get_ioc) (chnl_obj, timeout, &chnl_ioc_obj);
714 if (DSP_SUCCEEDED(status)) {
715 if (!CHNL_IS_IO_COMPLETE(chnl_ioc_obj)) {
716 if (CHNL_IS_TIMED_OUT(chnl_ioc_obj))
723 if (DSP_FAILED(status))
726 chnl_obj = disp_obj->chnl_from_dsp;
727 ul_bytes = REPLYSIZE;
728 status = (*intf_fxns->pfn_chnl_add_io_req) (chnl_obj, pbuf, ul_bytes,
730 if (DSP_FAILED(status))
734 (*intf_fxns->pfn_chnl_get_ioc) (chnl_obj, timeout, &chnl_ioc_obj);
735 if (DSP_SUCCEEDED(status)) {
736 if (CHNL_IS_TIMED_OUT(chnl_ioc_obj)) {
738 } else if (chnl_ioc_obj.byte_size < ul_bytes) {
739 /* Did not get all of the reply from the RMS */
742 if (CHNL_IS_IO_COMPLETE(chnl_ioc_obj)) {
743 DBC_ASSERT(chnl_ioc_obj.pbuf == pbuf);
744 status = (*((rms_word *) chnl_ioc_obj.pbuf));
746 (((rms_word *) (chnl_ioc_obj.pbuf))[1]);