1 /* visorchannel_funcs.c
3 * Copyright (C) 2010 - 2013 UNISYS CORPORATION
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 (at
9 * your option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, GOOD TITLE or
14 * NON INFRINGEMENT. See the GNU General Public License for more
19 * This provides Supervisor channel communication primitives, which are
20 * independent of the mechanism used to access the channel data. All channel
21 * data is accessed using the memregion abstraction. (memregion has both
22 * a CM2 implementation and a direct memory implementation.)
25 #include "memregion.h"
28 #include <linux/uuid.h>
30 #define MYDRVNAME "visorchannel"
33 struct memregion memregion; /* from visor_memregion_create() */
34 struct channel_header chan_hdr;
37 BOOL needs_lock; /* channel creator knows if more than one
38 * thread will be inserting or removing */
39 spinlock_t insert_lock; /* protect head writes in chan_hdr */
40 spinlock_t remove_lock; /* protect tail writes in chan_hdr */
43 struct signal_queue_header req_queue;
44 struct signal_queue_header rsp_queue;
45 struct signal_queue_header event_queue;
46 struct signal_queue_header ack_queue;
50 /* Creates the struct visorchannel abstraction for a data area in memory,
51 * but does NOT modify this data area.
53 static struct visorchannel *
54 visorchannel_create_guts(HOSTADDRESS physaddr, ulong channel_bytes,
55 ulong off, uuid_le guid, BOOL needs_lock)
57 struct visorchannel *channel;
59 size_t size = sizeof(struct channel_header);
61 channel = kzalloc(sizeof(*channel), GFP_KERNEL|__GFP_NORETRY);
65 channel->needs_lock = needs_lock;
66 spin_lock_init(&channel->insert_lock);
67 spin_lock_init(&channel->remove_lock);
69 if (!request_mem_region(physaddr, size, MYDRVNAME))
72 channel->memregion.mapped = ioremap_cache(physaddr, size);
73 if (!channel->memregion.mapped) {
74 release_mem_region(physaddr, size);
78 channel->memregion.physaddr = physaddr;
79 channel->memregion.nbytes = size;
81 err = visor_memregion_read(&channel->memregion, 0, &channel->chan_hdr,
82 sizeof(struct channel_header));
86 /* we had better be a CLIENT of this channel */
87 if (channel_bytes == 0)
88 channel_bytes = (ulong)channel->chan_hdr.size;
89 if (uuid_le_cmp(guid, NULL_UUID_LE) == 0)
90 guid = channel->chan_hdr.chtype;
92 iounmap(channel->memregion.mapped);
93 release_mem_region(channel->memregion.physaddr,
94 channel->memregion.nbytes);
95 channel->memregion.mapped = NULL;
96 if (!request_mem_region(channel->memregion.physaddr, channel_bytes,
100 channel->memregion.mapped = ioremap_cache(channel->memregion.physaddr,
102 if (!channel->memregion.mapped) {
103 release_mem_region(channel->memregion.physaddr, channel_bytes);
107 channel->memregion.nbytes = channel_bytes;
109 channel->size = channel_bytes;
110 channel->guid = guid;
114 visorchannel_destroy(channel);
118 struct visorchannel *
119 visorchannel_create(HOSTADDRESS physaddr, ulong channel_bytes, uuid_le guid)
121 return visorchannel_create_guts(physaddr, channel_bytes, 0, guid,
124 EXPORT_SYMBOL_GPL(visorchannel_create);
126 struct visorchannel *
127 visorchannel_create_with_lock(HOSTADDRESS physaddr, ulong channel_bytes,
130 return visorchannel_create_guts(physaddr, channel_bytes, 0, guid,
133 EXPORT_SYMBOL_GPL(visorchannel_create_with_lock);
136 visorchannel_destroy(struct visorchannel *channel)
140 if (channel->memregion.mapped) {
141 iounmap(channel->memregion.mapped);
142 release_mem_region(channel->memregion.physaddr,
143 channel->memregion.nbytes);
147 EXPORT_SYMBOL_GPL(visorchannel_destroy);
150 visorchannel_get_physaddr(struct visorchannel *channel)
152 return channel->memregion.physaddr;
154 EXPORT_SYMBOL_GPL(visorchannel_get_physaddr);
157 visorchannel_get_nbytes(struct visorchannel *channel)
159 return channel->size;
161 EXPORT_SYMBOL_GPL(visorchannel_get_nbytes);
164 visorchannel_uuid_id(uuid_le *guid, char *s)
166 sprintf(s, "%pUL", guid);
169 EXPORT_SYMBOL_GPL(visorchannel_uuid_id);
172 visorchannel_id(struct visorchannel *channel, char *s)
174 return visorchannel_uuid_id(&channel->guid, s);
176 EXPORT_SYMBOL_GPL(visorchannel_id);
179 visorchannel_zoneid(struct visorchannel *channel, char *s)
181 return visorchannel_uuid_id(&channel->chan_hdr.zone_uuid, s);
183 EXPORT_SYMBOL_GPL(visorchannel_zoneid);
186 visorchannel_get_clientpartition(struct visorchannel *channel)
188 return channel->chan_hdr.partition_handle;
190 EXPORT_SYMBOL_GPL(visorchannel_get_clientpartition);
193 visorchannel_get_uuid(struct visorchannel *channel)
195 return channel->guid;
197 EXPORT_SYMBOL_GPL(visorchannel_get_uuid);
200 visorchannel_read(struct visorchannel *channel, ulong offset,
201 void *local, ulong nbytes)
204 size_t size = sizeof(struct channel_header);
206 rc = visor_memregion_read(&channel->memregion, offset, local, nbytes);
207 if (rc && !offset && (nbytes >= size))
208 memcpy(&channel->chan_hdr, local, size);
211 EXPORT_SYMBOL_GPL(visorchannel_read);
214 visorchannel_write(struct visorchannel *channel, ulong offset,
215 void *local, ulong nbytes)
217 size_t size = sizeof(struct channel_header);
219 if (!offset && nbytes >= size)
220 memcpy(&channel->chan_hdr, local, size);
221 return visor_memregion_write(&channel->memregion,
222 offset, local, nbytes);
224 EXPORT_SYMBOL_GPL(visorchannel_write);
227 visorchannel_clear(struct visorchannel *channel, ulong offset, u8 ch,
231 int bufsize = PAGE_SIZE;
235 buf = (u8 *) __get_free_page(GFP_KERNEL);
239 memset(buf, ch, bufsize);
242 int thisbytes = bufsize;
244 if (nbytes < thisbytes)
246 err = visor_memregion_write(&channel->memregion,
247 offset + written, buf, thisbytes);
251 written += thisbytes;
257 free_page((unsigned long) buf);
260 EXPORT_SYMBOL_GPL(visorchannel_clear);
263 visorchannel_get_header(struct visorchannel *channel)
265 return (void __iomem *)&channel->chan_hdr;
267 EXPORT_SYMBOL_GPL(visorchannel_get_header);
269 /** Return offset of a specific SIGNAL_QUEUE_HEADER from the beginning of a
272 #define SIG_QUEUE_OFFSET(chan_hdr, q) \
273 ((chan_hdr)->ch_space_offset + \
274 ((q) * sizeof(struct signal_queue_header)))
276 /** Return offset of a specific queue entry (data) from the beginning of a
279 #define SIG_DATA_OFFSET(chan_hdr, q, sig_hdr, slot) \
280 (SIG_QUEUE_OFFSET(chan_hdr, q) + (sig_hdr)->sig_base_offset + \
281 ((slot) * (sig_hdr)->signal_size))
283 /** Write the contents of a specific field within a SIGNAL_QUEUE_HEADER back
286 #define SIG_WRITE_FIELD(channel, queue, sig_hdr, FIELD) \
287 (visor_memregion_write(&channel->memregion, \
288 SIG_QUEUE_OFFSET(&channel->chan_hdr, queue)+ \
289 offsetof(struct signal_queue_header, FIELD),\
290 &((sig_hdr)->FIELD), \
291 sizeof((sig_hdr)->FIELD)) >= 0)
294 sig_read_header(struct visorchannel *channel, u32 queue,
295 struct signal_queue_header *sig_hdr)
299 if (channel->chan_hdr.ch_space_offset < sizeof(struct channel_header))
302 /* Read the appropriate SIGNAL_QUEUE_HEADER into local memory. */
303 err = visor_memregion_read(&channel->memregion,
304 SIG_QUEUE_OFFSET(&channel->chan_hdr, queue),
305 sig_hdr, sizeof(struct signal_queue_header));
313 sig_read_data(struct visorchannel *channel, u32 queue,
314 struct signal_queue_header *sig_hdr, u32 slot, void *data)
317 int signal_data_offset = SIG_DATA_OFFSET(&channel->chan_hdr, queue,
320 err = visor_memregion_read(&channel->memregion,
322 data, sig_hdr->signal_size);
330 sig_write_data(struct visorchannel *channel, u32 queue,
331 struct signal_queue_header *sig_hdr, u32 slot, void *data)
334 int signal_data_offset = SIG_DATA_OFFSET(&channel->chan_hdr, queue,
337 err = visor_memregion_write(&channel->memregion,
339 data, sig_hdr->signal_size);
347 signalremove_inner(struct visorchannel *channel, u32 queue, void *msg)
349 struct signal_queue_header sig_hdr;
351 if (!sig_read_header(channel, queue, &sig_hdr))
353 if (sig_hdr.head == sig_hdr.tail)
354 return FALSE; /* no signals to remove */
356 sig_hdr.tail = (sig_hdr.tail + 1) % sig_hdr.max_slots;
357 if (!sig_read_data(channel, queue, &sig_hdr, sig_hdr.tail, msg))
359 sig_hdr.num_received++;
361 /* For each data field in SIGNAL_QUEUE_HEADER that was modified,
362 * update host memory.
364 mb(); /* required for channel synch */
365 if (!SIG_WRITE_FIELD(channel, queue, &sig_hdr, tail))
367 if (!SIG_WRITE_FIELD(channel, queue, &sig_hdr, num_received))
373 visorchannel_signalremove(struct visorchannel *channel, u32 queue, void *msg)
377 if (channel->needs_lock) {
378 spin_lock(&channel->remove_lock);
379 rc = signalremove_inner(channel, queue, msg);
380 spin_unlock(&channel->remove_lock);
382 rc = signalremove_inner(channel, queue, msg);
387 EXPORT_SYMBOL_GPL(visorchannel_signalremove);
390 signalinsert_inner(struct visorchannel *channel, u32 queue, void *msg)
392 struct signal_queue_header sig_hdr;
394 if (!sig_read_header(channel, queue, &sig_hdr))
397 sig_hdr.head = ((sig_hdr.head + 1) % sig_hdr.max_slots);
398 if (sig_hdr.head == sig_hdr.tail) {
399 sig_hdr.num_overflows++;
400 visor_memregion_write(&channel->memregion,
401 SIG_QUEUE_OFFSET(&channel->chan_hdr,
403 offsetof(struct signal_queue_header,
405 &(sig_hdr.num_overflows),
406 sizeof(sig_hdr.num_overflows));
410 if (!sig_write_data(channel, queue, &sig_hdr, sig_hdr.head, msg))
415 /* For each data field in SIGNAL_QUEUE_HEADER that was modified,
416 * update host memory.
418 mb(); /* required for channel synch */
419 if (!SIG_WRITE_FIELD(channel, queue, &sig_hdr, head))
421 if (!SIG_WRITE_FIELD(channel, queue, &sig_hdr, num_sent))
428 visorchannel_signalinsert(struct visorchannel *channel, u32 queue, void *msg)
432 if (channel->needs_lock) {
433 spin_lock(&channel->insert_lock);
434 rc = signalinsert_inner(channel, queue, msg);
435 spin_unlock(&channel->insert_lock);
437 rc = signalinsert_inner(channel, queue, msg);
442 EXPORT_SYMBOL_GPL(visorchannel_signalinsert);
445 visorchannel_signalqueue_slots_avail(struct visorchannel *channel, u32 queue)
447 struct signal_queue_header sig_hdr;
448 u32 slots_avail, slots_used;
451 if (!sig_read_header(channel, queue, &sig_hdr))
456 head = head + sig_hdr.max_slots;
457 slots_used = (head - tail);
458 slots_avail = sig_hdr.max_signals - slots_used;
459 return (int)slots_avail;
461 EXPORT_SYMBOL_GPL(visorchannel_signalqueue_slots_avail);
464 visorchannel_signalqueue_max_slots(struct visorchannel *channel, u32 queue)
466 struct signal_queue_header sig_hdr;
468 if (!sig_read_header(channel, queue, &sig_hdr))
470 return (int)sig_hdr.max_signals;
472 EXPORT_SYMBOL_GPL(visorchannel_signalqueue_max_slots);
475 sigqueue_debug(struct signal_queue_header *q, int which, struct seq_file *seq)
477 seq_printf(seq, "Signal Queue #%d\n", which);
478 seq_printf(seq, " VersionId = %lu\n", (ulong)q->version);
479 seq_printf(seq, " Type = %lu\n", (ulong)q->chtype);
480 seq_printf(seq, " oSignalBase = %llu\n",
481 (long long)q->sig_base_offset);
482 seq_printf(seq, " SignalSize = %lu\n", (ulong)q->signal_size);
483 seq_printf(seq, " MaxSignalSlots = %lu\n",
484 (ulong)q->max_slots);
485 seq_printf(seq, " MaxSignals = %lu\n", (ulong)q->max_signals);
486 seq_printf(seq, " FeatureFlags = %-16.16Lx\n",
487 (long long)q->features);
488 seq_printf(seq, " NumSignalsSent = %llu\n",
489 (long long)q->num_sent);
490 seq_printf(seq, " NumSignalsReceived = %llu\n",
491 (long long)q->num_received);
492 seq_printf(seq, " NumOverflows = %llu\n",
493 (long long)q->num_overflows);
494 seq_printf(seq, " Head = %lu\n", (ulong)q->head);
495 seq_printf(seq, " Tail = %lu\n", (ulong)q->tail);
499 visorchannel_debug(struct visorchannel *channel, int num_queues,
500 struct seq_file *seq, u32 off)
502 HOSTADDRESS addr = 0;
503 ulong nbytes = 0, nbytes_region = 0;
504 struct channel_header hdr;
505 struct channel_header *phdr = &hdr;
512 addr = visorchannel_get_physaddr(channel);
513 nbytes_region = visorchannel_get_nbytes(channel);
514 errcode = visorchannel_read(channel, off,
515 phdr, sizeof(struct channel_header));
518 "Read of channel header failed with errcode=%d)\n",
521 phdr = &channel->chan_hdr;
522 seq_puts(seq, "(following data may be stale)\n");
527 nbytes = (ulong)(phdr->size);
528 seq_printf(seq, "--- Begin channel @0x%-16.16Lx for 0x%lx bytes (region=0x%lx bytes) ---\n",
529 addr + off, nbytes, nbytes_region);
530 seq_printf(seq, "Type = %pUL\n", &phdr->chtype);
531 seq_printf(seq, "ZoneGuid = %pUL\n", &phdr->zone_uuid);
532 seq_printf(seq, "Signature = 0x%-16.16Lx\n",
533 (long long)phdr->signature);
534 seq_printf(seq, "LegacyState = %lu\n", (ulong)phdr->legacy_state);
535 seq_printf(seq, "SrvState = %lu\n", (ulong)phdr->srv_state);
536 seq_printf(seq, "CliStateBoot = %lu\n", (ulong)phdr->cli_state_boot);
537 seq_printf(seq, "CliStateOS = %lu\n", (ulong)phdr->cli_state_os);
538 seq_printf(seq, "HeaderSize = %lu\n", (ulong)phdr->header_size);
539 seq_printf(seq, "Size = %llu\n", (long long)phdr->size);
540 seq_printf(seq, "Features = 0x%-16.16llx\n",
541 (long long)phdr->features);
542 seq_printf(seq, "PartitionHandle = 0x%-16.16llx\n",
543 (long long)phdr->partition_handle);
544 seq_printf(seq, "Handle = 0x%-16.16llx\n",
545 (long long)phdr->handle);
546 seq_printf(seq, "VersionId = %lu\n", (ulong)phdr->version_id);
547 seq_printf(seq, "oChannelSpace = %llu\n",
548 (long long)phdr->ch_space_offset);
549 if ((phdr->ch_space_offset == 0) || (errcode < 0))
552 for (i = 0; i < num_queues; i++) {
553 struct signal_queue_header q;
555 errcode = visorchannel_read(channel,
557 phdr->ch_space_offset +
562 "failed to read signal queue #%d from channel @0x%-16.16Lx errcode=%d\n",
566 sigqueue_debug(&q, i, seq);
568 seq_printf(seq, "--- End channel @0x%-16.16Lx for 0x%lx bytes ---\n",
571 EXPORT_SYMBOL_GPL(visorchannel_debug);