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
= visorchannel_read(channel
, 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
)
203 if (offset
+ nbytes
> channel
->memregion
.nbytes
)
206 memcpy_fromio(local
, channel
->memregion
.mapped
+ offset
, nbytes
);
210 EXPORT_SYMBOL_GPL(visorchannel_read
);
213 visorchannel_write(struct visorchannel
*channel
, ulong offset
,
214 void *local
, ulong nbytes
)
216 size_t chdr_size
= sizeof(struct channel_header
);
219 if (offset
+ nbytes
> channel
->memregion
.nbytes
)
222 if (offset
< chdr_size
) {
223 copy_size
= min(chdr_size
, nbytes
) - offset
;
224 memcpy(&channel
->chan_hdr
+ offset
, local
, copy_size
);
227 memcpy_toio(channel
->memregion
.mapped
+ offset
, local
, nbytes
);
231 EXPORT_SYMBOL_GPL(visorchannel_write
);
234 visorchannel_clear(struct visorchannel
*channel
, ulong offset
, u8 ch
,
238 int bufsize
= PAGE_SIZE
;
242 buf
= (u8
*) __get_free_page(GFP_KERNEL
);
246 memset(buf
, ch
, bufsize
);
249 int thisbytes
= bufsize
;
251 if (nbytes
< thisbytes
)
253 err
= visor_memregion_write(&channel
->memregion
,
254 offset
+ written
, buf
, thisbytes
);
258 written
+= thisbytes
;
264 free_page((unsigned long) buf
);
267 EXPORT_SYMBOL_GPL(visorchannel_clear
);
270 visorchannel_get_header(struct visorchannel
*channel
)
272 return (void __iomem
*)&channel
->chan_hdr
;
274 EXPORT_SYMBOL_GPL(visorchannel_get_header
);
276 /** Return offset of a specific SIGNAL_QUEUE_HEADER from the beginning of a
279 #define SIG_QUEUE_OFFSET(chan_hdr, q) \
280 ((chan_hdr)->ch_space_offset + \
281 ((q) * sizeof(struct signal_queue_header)))
283 /** Return offset of a specific queue entry (data) from the beginning of a
286 #define SIG_DATA_OFFSET(chan_hdr, q, sig_hdr, slot) \
287 (SIG_QUEUE_OFFSET(chan_hdr, q) + (sig_hdr)->sig_base_offset + \
288 ((slot) * (sig_hdr)->signal_size))
290 /** Write the contents of a specific field within a SIGNAL_QUEUE_HEADER back
293 #define SIG_WRITE_FIELD(channel, queue, sig_hdr, FIELD) \
294 (visor_memregion_write(&channel->memregion, \
295 SIG_QUEUE_OFFSET(&channel->chan_hdr, queue)+ \
296 offsetof(struct signal_queue_header, FIELD),\
297 &((sig_hdr)->FIELD), \
298 sizeof((sig_hdr)->FIELD)) >= 0)
301 sig_read_header(struct visorchannel
*channel
, u32 queue
,
302 struct signal_queue_header
*sig_hdr
)
306 if (channel
->chan_hdr
.ch_space_offset
< sizeof(struct channel_header
))
309 /* Read the appropriate SIGNAL_QUEUE_HEADER into local memory. */
310 err
= visor_memregion_read(&channel
->memregion
,
311 SIG_QUEUE_OFFSET(&channel
->chan_hdr
, queue
),
312 sig_hdr
, sizeof(struct signal_queue_header
));
320 sig_read_data(struct visorchannel
*channel
, u32 queue
,
321 struct signal_queue_header
*sig_hdr
, u32 slot
, void *data
)
324 int signal_data_offset
= SIG_DATA_OFFSET(&channel
->chan_hdr
, queue
,
327 err
= visor_memregion_read(&channel
->memregion
,
329 data
, sig_hdr
->signal_size
);
337 sig_write_data(struct visorchannel
*channel
, u32 queue
,
338 struct signal_queue_header
*sig_hdr
, u32 slot
, void *data
)
341 int signal_data_offset
= SIG_DATA_OFFSET(&channel
->chan_hdr
, queue
,
344 err
= visor_memregion_write(&channel
->memregion
,
346 data
, sig_hdr
->signal_size
);
354 signalremove_inner(struct visorchannel
*channel
, u32 queue
, void *msg
)
356 struct signal_queue_header sig_hdr
;
358 if (!sig_read_header(channel
, queue
, &sig_hdr
))
360 if (sig_hdr
.head
== sig_hdr
.tail
)
361 return FALSE
; /* no signals to remove */
363 sig_hdr
.tail
= (sig_hdr
.tail
+ 1) % sig_hdr
.max_slots
;
364 if (!sig_read_data(channel
, queue
, &sig_hdr
, sig_hdr
.tail
, msg
))
366 sig_hdr
.num_received
++;
368 /* For each data field in SIGNAL_QUEUE_HEADER that was modified,
369 * update host memory.
371 mb(); /* required for channel synch */
372 if (!SIG_WRITE_FIELD(channel
, queue
, &sig_hdr
, tail
))
374 if (!SIG_WRITE_FIELD(channel
, queue
, &sig_hdr
, num_received
))
380 visorchannel_signalremove(struct visorchannel
*channel
, u32 queue
, void *msg
)
384 if (channel
->needs_lock
) {
385 spin_lock(&channel
->remove_lock
);
386 rc
= signalremove_inner(channel
, queue
, msg
);
387 spin_unlock(&channel
->remove_lock
);
389 rc
= signalremove_inner(channel
, queue
, msg
);
394 EXPORT_SYMBOL_GPL(visorchannel_signalremove
);
397 signalinsert_inner(struct visorchannel
*channel
, u32 queue
, void *msg
)
399 struct signal_queue_header sig_hdr
;
401 if (!sig_read_header(channel
, queue
, &sig_hdr
))
404 sig_hdr
.head
= ((sig_hdr
.head
+ 1) % sig_hdr
.max_slots
);
405 if (sig_hdr
.head
== sig_hdr
.tail
) {
406 sig_hdr
.num_overflows
++;
407 visor_memregion_write(&channel
->memregion
,
408 SIG_QUEUE_OFFSET(&channel
->chan_hdr
,
410 offsetof(struct signal_queue_header
,
412 &(sig_hdr
.num_overflows
),
413 sizeof(sig_hdr
.num_overflows
));
417 if (!sig_write_data(channel
, queue
, &sig_hdr
, sig_hdr
.head
, msg
))
422 /* For each data field in SIGNAL_QUEUE_HEADER that was modified,
423 * update host memory.
425 mb(); /* required for channel synch */
426 if (!SIG_WRITE_FIELD(channel
, queue
, &sig_hdr
, head
))
428 if (!SIG_WRITE_FIELD(channel
, queue
, &sig_hdr
, num_sent
))
435 visorchannel_signalinsert(struct visorchannel
*channel
, u32 queue
, void *msg
)
439 if (channel
->needs_lock
) {
440 spin_lock(&channel
->insert_lock
);
441 rc
= signalinsert_inner(channel
, queue
, msg
);
442 spin_unlock(&channel
->insert_lock
);
444 rc
= signalinsert_inner(channel
, queue
, msg
);
449 EXPORT_SYMBOL_GPL(visorchannel_signalinsert
);
452 visorchannel_signalqueue_slots_avail(struct visorchannel
*channel
, u32 queue
)
454 struct signal_queue_header sig_hdr
;
455 u32 slots_avail
, slots_used
;
458 if (!sig_read_header(channel
, queue
, &sig_hdr
))
463 head
= head
+ sig_hdr
.max_slots
;
464 slots_used
= (head
- tail
);
465 slots_avail
= sig_hdr
.max_signals
- slots_used
;
466 return (int)slots_avail
;
468 EXPORT_SYMBOL_GPL(visorchannel_signalqueue_slots_avail
);
471 visorchannel_signalqueue_max_slots(struct visorchannel
*channel
, u32 queue
)
473 struct signal_queue_header sig_hdr
;
475 if (!sig_read_header(channel
, queue
, &sig_hdr
))
477 return (int)sig_hdr
.max_signals
;
479 EXPORT_SYMBOL_GPL(visorchannel_signalqueue_max_slots
);
482 sigqueue_debug(struct signal_queue_header
*q
, int which
, struct seq_file
*seq
)
484 seq_printf(seq
, "Signal Queue #%d\n", which
);
485 seq_printf(seq
, " VersionId = %lu\n", (ulong
)q
->version
);
486 seq_printf(seq
, " Type = %lu\n", (ulong
)q
->chtype
);
487 seq_printf(seq
, " oSignalBase = %llu\n",
488 (long long)q
->sig_base_offset
);
489 seq_printf(seq
, " SignalSize = %lu\n", (ulong
)q
->signal_size
);
490 seq_printf(seq
, " MaxSignalSlots = %lu\n",
491 (ulong
)q
->max_slots
);
492 seq_printf(seq
, " MaxSignals = %lu\n", (ulong
)q
->max_signals
);
493 seq_printf(seq
, " FeatureFlags = %-16.16Lx\n",
494 (long long)q
->features
);
495 seq_printf(seq
, " NumSignalsSent = %llu\n",
496 (long long)q
->num_sent
);
497 seq_printf(seq
, " NumSignalsReceived = %llu\n",
498 (long long)q
->num_received
);
499 seq_printf(seq
, " NumOverflows = %llu\n",
500 (long long)q
->num_overflows
);
501 seq_printf(seq
, " Head = %lu\n", (ulong
)q
->head
);
502 seq_printf(seq
, " Tail = %lu\n", (ulong
)q
->tail
);
506 visorchannel_debug(struct visorchannel
*channel
, int num_queues
,
507 struct seq_file
*seq
, u32 off
)
509 HOSTADDRESS addr
= 0;
510 ulong nbytes
= 0, nbytes_region
= 0;
511 struct channel_header hdr
;
512 struct channel_header
*phdr
= &hdr
;
519 addr
= visorchannel_get_physaddr(channel
);
520 nbytes_region
= visorchannel_get_nbytes(channel
);
521 errcode
= visorchannel_read(channel
, off
,
522 phdr
, sizeof(struct channel_header
));
525 "Read of channel header failed with errcode=%d)\n",
528 phdr
= &channel
->chan_hdr
;
529 seq_puts(seq
, "(following data may be stale)\n");
534 nbytes
= (ulong
)(phdr
->size
);
535 seq_printf(seq
, "--- Begin channel @0x%-16.16Lx for 0x%lx bytes (region=0x%lx bytes) ---\n",
536 addr
+ off
, nbytes
, nbytes_region
);
537 seq_printf(seq
, "Type = %pUL\n", &phdr
->chtype
);
538 seq_printf(seq
, "ZoneGuid = %pUL\n", &phdr
->zone_uuid
);
539 seq_printf(seq
, "Signature = 0x%-16.16Lx\n",
540 (long long)phdr
->signature
);
541 seq_printf(seq
, "LegacyState = %lu\n", (ulong
)phdr
->legacy_state
);
542 seq_printf(seq
, "SrvState = %lu\n", (ulong
)phdr
->srv_state
);
543 seq_printf(seq
, "CliStateBoot = %lu\n", (ulong
)phdr
->cli_state_boot
);
544 seq_printf(seq
, "CliStateOS = %lu\n", (ulong
)phdr
->cli_state_os
);
545 seq_printf(seq
, "HeaderSize = %lu\n", (ulong
)phdr
->header_size
);
546 seq_printf(seq
, "Size = %llu\n", (long long)phdr
->size
);
547 seq_printf(seq
, "Features = 0x%-16.16llx\n",
548 (long long)phdr
->features
);
549 seq_printf(seq
, "PartitionHandle = 0x%-16.16llx\n",
550 (long long)phdr
->partition_handle
);
551 seq_printf(seq
, "Handle = 0x%-16.16llx\n",
552 (long long)phdr
->handle
);
553 seq_printf(seq
, "VersionId = %lu\n", (ulong
)phdr
->version_id
);
554 seq_printf(seq
, "oChannelSpace = %llu\n",
555 (long long)phdr
->ch_space_offset
);
556 if ((phdr
->ch_space_offset
== 0) || (errcode
< 0))
559 for (i
= 0; i
< num_queues
; i
++) {
560 struct signal_queue_header q
;
562 errcode
= visorchannel_read(channel
,
564 phdr
->ch_space_offset
+
569 "failed to read signal queue #%d from channel @0x%-16.16Lx errcode=%d\n",
573 sigqueue_debug(&q
, i
, seq
);
575 seq_printf(seq
, "--- End channel @0x%-16.16Lx for 0x%lx bytes ---\n",
578 EXPORT_SYMBOL_GPL(visorchannel_debug
);