blob: 2560a5547d225cb61778e279e16a5230bdc7aa44 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*/
#ifndef __MAILBOX_CONTROLLER_H
#define __MAILBOX_CONTROLLER_H
#include <linux/mailbox.h>
/**
* struct mbox_link - s/w representation of a communication link
* @link_name: Literal name assigned to the link. Physically
* identical channels may have the same name.
* @api_priv: Hook for the API to map its private data on the link
* Controller driver must not touch it.
*/
struct mbox_link {
char link_name[16];
void *api_priv;
};
/**
* struct mbox_link - s/w representation of a communication link
* @send_data: The API asks the MBOX controller driver, in atomic
* context try to transmit a message on the bus. Returns 0 if
* data is accepted for transmission, -EBUSY while rejecting
* if the remote hasn't yet read the last data sent. Actual
* transmission of data is reported by the controller via
* mbox_link_txdone (if it has some TX ACK irq). It must not
* block.
* @startup: Called when a client requests the link. The controller
* could ask clients for additional parameters of communication
* to be provided via client's link_data. This call may
* block. After this call the Controller must forward any
* data received on the link by calling mbox_link_received_data.
* @shutdown: Called when a client relinquishes control of a link.
* This call may block too. The controller must not forwared
* any received data anymore.
* @last_tx_done: If the controller sets 'txdone_poll', the API calls
* this to poll status of last TX. The controller must
* give priority to IRQ method over polling and never
* set both txdone_poll and txdone_irq. Only in polling
* mode 'send_data' is expected to return -EBUSY.
* Used only if txdone_poll:=true && txdone_irq:úlse
*/
struct mbox_link_ops {
int (*send_data)(struct mbox_link *link, void *data);
int (*startup)(struct mbox_link *link, void *params);
void (*shutdown)(struct mbox_link *link);
int (*last_tx_done)(struct mbox_link *link);
};
/**
* struct mbox_controller - Controller of a class of communication links
* @dev: Device backing this controller
* @controller_name: Literal name of the controller.
* @ops: Operators that work on each communication link
* @links: Null terminated array of links.
* @txdone_irq: Indicates if the controller can report to API when
* the last transmitted data was read by the remote.
* Eg, if it has some TX ACK irq.
* @txdone_poll: If the controller can read but not report the TX
* done. Ex, some register shows the TX status but
* no interrupt rises. Ignored if 'txdone_irq' is set.
* @txpoll_period: If 'txdone_poll' is in effect, the API polls for
* last TX's status after these many millisecs
*/
struct mbox_controller {
struct device *dev;
char controller_name[16];
struct mbox_link_ops *ops;
struct mbox_link **links;
bool txdone_irq;
bool txdone_poll;
unsigned txpoll_period;
};
int mbox_controller_register(struct mbox_controller *mbox);
void mbox_link_received_data(struct mbox_link *link, void *data);
void mbox_link_txdone(struct mbox_link *link, enum mbox_result r);
void mbox_controller_unregister(struct mbox_controller *mbox);
#endif /* __MAILBOX_CONTROLLER_H */
|