aboutsummaryrefslogtreecommitdiffstats
blob: 99fd5ce8b9570f584cc8bc5422e85c70529759a8 (plain) (blame)
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
 * Copyright (C) 2016 Texas Instruments Incorporated - http://www.ti.com/
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *	* Redistributions of source code must retain the above copyright
 *	  notice, this list of conditions and the following disclaimer.
 *
 *	* Redistributions in binary form must reproduce the above copyright
 *	  notice, this list of conditions and the following disclaimer in the
 *	  documentation and/or other materials provided with the
 *	  distribution.
 *
 *	* Neither the name of Texas Instruments Incorporated nor the names of
 *	  its contributors may be used to endorse or promote products derived
 *	  from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 *  File	:	pru_rpmsg.c
 *
 *  Summary	:	An RPMsg implementation for the PRU to use while communicating
 *			with the ARM host.
 *
 *  Notes	:
 *  - Implementaion of the interface described in "pru_rpmsg.h"
 */

#include <pru_rpmsg.h>

struct pru_rpmsg_hdr {
	uint32_t	src;
	uint32_t	dst;
	uint32_t	reserved;
	uint16_t	len;
	uint16_t	flags;
	uint8_t		data[0];
};

struct pru_rpmsg_ns_msg {
	char		name[RPMSG_NAME_SIZE];
	char		desc[RPMSG_NAME_SIZE];
	uint32_t	addr;
	uint32_t	flags;
};

int16_t pru_rpmsg_init(
	struct pru_rpmsg_transport	*transport,
	struct fw_rsc_vdev_vring 	*vring0,
	struct fw_rsc_vdev_vring 	*vring1,
	uint32_t 			to_arm_event,
	uint32_t 			from_arm_event
)
{
	if (to_arm_event > MAX_VALID_EVENT || to_arm_event < MIN_VALID_EVENT)
		return PRU_RPMSG_INVALID_EVENT;

	if (from_arm_event > MAX_VALID_EVENT || from_arm_event < MIN_VALID_EVENT)
		return PRU_RPMSG_INVALID_EVENT;

	pru_virtqueue_init(&transport->virtqueue0, vring0, to_arm_event, from_arm_event);
	pru_virtqueue_init(&transport->virtqueue1, vring1, to_arm_event, from_arm_event);

	return PRU_RPMSG_SUCCESS;
}

int16_t pru_rpmsg_send(
    struct pru_rpmsg_transport	*transport,
    uint32_t			src,
    uint32_t			dst,
    void			*data,
    uint16_t			len
)
{
	struct pru_rpmsg_hdr	*msg;
	uint32_t		msg_len;
	int16_t			head;
	struct pru_virtqueue	*virtqueue;

	/*
	 * The length of our payload is larger than the maximum RPMsg buffer size
	 * allowed
	 */
	if (len > (RPMSG_BUF_SIZE - sizeof(struct pru_rpmsg_hdr)))
		return PRU_RPMSG_BUF_TOO_SMALL;

	virtqueue = &transport->virtqueue0;

	/* Get an available buffer */
	head = pru_virtqueue_get_avail_buf(virtqueue, (void **)&msg, &msg_len);

	if (head < 0)
		return PRU_RPMSG_NO_BUF_AVAILABLE;

	/* Copy local data buffer to the descriptor buffer address */
	memcpy(msg->data, data, len);
	msg->len = len;
	msg->dst = dst;
	msg->src = src;
	msg->flags = 0;
	msg->reserved = 0;

	/* Add the used buffer */
	if (pru_virtqueue_add_used_buf(virtqueue, head, msg_len) < 0)
		return PRU_RPMSG_INVALID_HEAD;

	/* Kick the ARM host */
	pru_virtqueue_kick(virtqueue);

	return PRU_RPMSG_SUCCESS;
}

int16_t pru_rpmsg_receive(
    struct pru_rpmsg_transport	*transport,
    uint16_t			*src,
    uint16_t			*dst,
    void			*data,
    uint16_t			*len
)
{
	int16_t			head;
	struct pru_rpmsg_hdr	*msg;
	uint32_t		msg_len;
	struct pru_virtqueue	*virtqueue;

	virtqueue = &transport->virtqueue1;

	/* Get an available buffer */
	head = pru_virtqueue_get_avail_buf(virtqueue, (void **)&msg, &msg_len);

	if (head < 0)
		return PRU_RPMSG_NO_BUF_AVAILABLE;


	/* Copy the message payload to the local data buffer provided */
	memcpy(data, msg->data, msg->len);
	*src = msg->src;
	*dst = msg->dst;
	*len = msg->len;

	/* Add the used buffer */
	if (pru_virtqueue_add_used_buf(virtqueue, head, msg_len) < 0)
		return PRU_RPMSG_INVALID_HEAD;

	/* Kick the ARM host */
	pru_virtqueue_kick(virtqueue);

	return PRU_RPMSG_SUCCESS;
}

int16_t pru_rpmsg_channel(
    enum pru_rpmsg_ns_flags	flags,
    struct pru_rpmsg_transport	*transport,
    char			*name,
    char			*desc,
    int32_t			port
)
{
	struct pru_rpmsg_ns_msg	ns_msg;
	uint8_t			i;

	for (i = 0; i < RPMSG_NAME_SIZE; i++) {
		ns_msg.name[i] = name[i];
		ns_msg.desc[i] = desc[i];
	}
	ns_msg.addr = port;
	ns_msg.flags = flags;

	return pru_rpmsg_send(transport, port, 53, &ns_msg, sizeof(ns_msg));
}