| Hans Verkuil | 1c1e45d | 2008-04-28 20:24:33 -0300 | [diff] [blame] | 1 | /* |
| 2 | * cx18 mailbox functions |
| 3 | * |
| 4 | * Copyright (C) 2007 Hans Verkuil <hverkuil@xs4all.nl> |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
| 18 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 19 | * 02111-1307 USA |
| 20 | */ |
| 21 | |
| 22 | #ifndef _CX18_MAILBOX_H_ |
| 23 | #define _CX18_MAILBOX_H_ |
| 24 | |
| 25 | /* mailbox max args */ |
| 26 | #define MAX_MB_ARGUMENTS 6 |
| 27 | /* compatibility, should be same as the define in cx2341x.h */ |
| 28 | #define CX2341X_MBOX_MAX_DATA 16 |
| 29 | |
| 30 | #define MB_RESERVED_HANDLE_0 0 |
| 31 | #define MB_RESERVED_HANDLE_1 0xFFFFFFFF |
| 32 | |
| 33 | struct cx18; |
| 34 | |
| 35 | /* The cx18_mailbox struct is the mailbox structure which is used for passing |
| 36 | messages between processors */ |
| 37 | struct cx18_mailbox { |
| 38 | /* The sender sets a handle in 'request' after he fills the command. The |
| 39 | 'request' should be different than 'ack'. The sender, also, generates |
| 40 | an interrupt on XPU2YPU_irq where XPU is the sender and YPU is the |
| 41 | receiver. */ |
| 42 | u32 request; |
| 43 | /* The receiver detects a new command when 'req' is different than 'ack'. |
| 44 | He sets 'ack' to the same value as 'req' to clear the command. He, also, |
| 45 | generates an interrupt on YPU2XPU_irq where XPU is the sender and YPU |
| 46 | is the receiver. */ |
| 47 | u32 ack; |
| 48 | u32 reserved[6]; |
| 49 | /* 'cmd' identifies the command. The list of these commands are in |
| 50 | cx23418.h */ |
| 51 | u32 cmd; |
| 52 | /* Each command can have up to 6 arguments */ |
| 53 | u32 args[MAX_MB_ARGUMENTS]; |
| 54 | /* The return code can be one of the codes in the file cx23418.h. If the |
| 55 | command is completed successfuly, the error will be ERR_SYS_SUCCESS. |
| 56 | If it is pending, the code is ERR_SYS_PENDING. If it failed, the error |
| 57 | code would indicate the task from which the error originated and will |
| 58 | be one of the errors in cx23418.h. In that case, the following |
| 59 | applies ((error & 0xff) != 0). |
| 60 | If the command is pending, the return will be passed in a MB from the |
| 61 | receiver to the sender. 'req' will be returned in args[0] */ |
| 62 | u32 error; |
| 63 | }; |
| 64 | |
| 65 | int cx18_api(struct cx18 *cx, u32 cmd, int args, u32 data[]); |
| 66 | int cx18_vapi_result(struct cx18 *cx, u32 data[MAX_MB_ARGUMENTS], u32 cmd, |
| 67 | int args, ...); |
| 68 | int cx18_vapi(struct cx18 *cx, u32 cmd, int args, ...); |
| 69 | int cx18_api_func(void *priv, u32 cmd, int in, int out, |
| 70 | u32 data[CX2341X_MBOX_MAX_DATA]); |
| 71 | long cx18_mb_ack(struct cx18 *cx, const struct cx18_mailbox *mb); |
| 72 | |
| 73 | #endif |