1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2016, NVIDIA CORPORATION.
4  */
5 
6 #include <common.h>
7 #include <dm.h>
8 #include <log.h>
9 #include <mailbox.h>
10 #include <mailbox-uclass.h>
11 #include <malloc.h>
12 #include <time.h>
13 
mbox_dev_ops(struct udevice * dev)14 static inline struct mbox_ops *mbox_dev_ops(struct udevice *dev)
15 {
16 	return (struct mbox_ops *)dev->driver->ops;
17 }
18 
mbox_of_xlate_default(struct mbox_chan * chan,struct ofnode_phandle_args * args)19 static int mbox_of_xlate_default(struct mbox_chan *chan,
20 				 struct ofnode_phandle_args *args)
21 {
22 	debug("%s(chan=%p)\n", __func__, chan);
23 
24 	if (args->args_count != 1) {
25 		debug("Invaild args_count: %d\n", args->args_count);
26 		return -EINVAL;
27 	}
28 
29 	chan->id = args->args[0];
30 
31 	return 0;
32 }
33 
mbox_get_by_index(struct udevice * dev,int index,struct mbox_chan * chan)34 int mbox_get_by_index(struct udevice *dev, int index, struct mbox_chan *chan)
35 {
36 	struct ofnode_phandle_args args;
37 	int ret;
38 	struct udevice *dev_mbox;
39 	struct mbox_ops *ops;
40 
41 	debug("%s(dev=%p, index=%d, chan=%p)\n", __func__, dev, index, chan);
42 
43 	ret = dev_read_phandle_with_args(dev, "mboxes", "#mbox-cells", 0, index,
44 					 &args);
45 	if (ret) {
46 		debug("%s: dev_read_phandle_with_args failed: %d\n", __func__,
47 		      ret);
48 		return ret;
49 	}
50 
51 	ret = uclass_get_device_by_ofnode(UCLASS_MAILBOX, args.node, &dev_mbox);
52 	if (ret) {
53 		debug("%s: uclass_get_device_by_of_offset failed: %d\n",
54 		      __func__, ret);
55 
56 		/* Test with parent node */
57 		ret = uclass_get_device_by_ofnode(UCLASS_MAILBOX,
58 						  ofnode_get_parent(args.node),
59 						  &dev_mbox);
60 		if (ret) {
61 			debug("%s: mbox node from parent failed: %d\n",
62 			      __func__, ret);
63 			return ret;
64 		};
65 	}
66 	ops = mbox_dev_ops(dev_mbox);
67 
68 	chan->dev = dev_mbox;
69 	if (ops->of_xlate)
70 		ret = ops->of_xlate(chan, &args);
71 	else
72 		ret = mbox_of_xlate_default(chan, &args);
73 	if (ret) {
74 		debug("of_xlate() failed: %d\n", ret);
75 		return ret;
76 	}
77 
78 	if (ops->request)
79 		ret = ops->request(chan);
80 	if (ret) {
81 		debug("ops->request() failed: %d\n", ret);
82 		return ret;
83 	}
84 
85 	return 0;
86 }
87 
mbox_get_by_name(struct udevice * dev,const char * name,struct mbox_chan * chan)88 int mbox_get_by_name(struct udevice *dev, const char *name,
89 		     struct mbox_chan *chan)
90 {
91 	int index;
92 
93 	debug("%s(dev=%p, name=%s, chan=%p)\n", __func__, dev, name, chan);
94 
95 	index = dev_read_stringlist_search(dev, "mbox-names", name);
96 	if (index < 0) {
97 		debug("fdt_stringlist_search() failed: %d\n", index);
98 		return index;
99 	}
100 
101 	return mbox_get_by_index(dev, index, chan);
102 }
103 
mbox_free(struct mbox_chan * chan)104 int mbox_free(struct mbox_chan *chan)
105 {
106 	struct mbox_ops *ops = mbox_dev_ops(chan->dev);
107 
108 	debug("%s(chan=%p)\n", __func__, chan);
109 
110 	if (ops->rfree)
111 		return ops->rfree(chan);
112 
113 	return 0;
114 }
115 
mbox_send(struct mbox_chan * chan,const void * data)116 int mbox_send(struct mbox_chan *chan, const void *data)
117 {
118 	struct mbox_ops *ops = mbox_dev_ops(chan->dev);
119 
120 	debug("%s(chan=%p, data=%p)\n", __func__, chan, data);
121 
122 	return ops->send(chan, data);
123 }
124 
mbox_recv(struct mbox_chan * chan,void * data,ulong timeout_us)125 int mbox_recv(struct mbox_chan *chan, void *data, ulong timeout_us)
126 {
127 	struct mbox_ops *ops = mbox_dev_ops(chan->dev);
128 	ulong start_time;
129 	int ret;
130 
131 	debug("%s(chan=%p, data=%p, timeout_us=%ld)\n", __func__, chan, data,
132 	      timeout_us);
133 
134 	start_time = timer_get_us();
135 	/*
136 	 * Account for partial us ticks, but if timeout_us is 0, ensure we
137 	 * still don't wait at all.
138 	 */
139 	if (timeout_us)
140 		timeout_us++;
141 
142 	for (;;) {
143 		ret = ops->recv(chan, data);
144 		if (ret != -ENODATA)
145 			return ret;
146 		if ((timer_get_us() - start_time) >= timeout_us)
147 			return -ETIMEDOUT;
148 	}
149 }
150 
151 UCLASS_DRIVER(mailbox) = {
152 	.id		= UCLASS_MAILBOX,
153 	.name		= "mailbox",
154 };
155