3 * Copyright (c) 2009, Microsoft Corporation.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307 USA.
19 * Haiyang Zhang <haiyangz@microsoft.com>
20 * Hank Janssen <hjanssen@microsoft.com>
24 #include <linux/kernel.h>
28 #include "ring_buffer.h"
34 /* Amount of space to write to */
35 #define BYTES_AVAIL_TO_WRITE(r, w, z) ((w) >= (r)) ? ((z) - ((w) - (r))) : ((r) - (w))
41 GetRingBufferAvailBytes()
44 Get number of bytes available to read and to write to
45 for the specified ring buffer
49 GetRingBufferAvailBytes(RING_BUFFER_INFO
*rbi
, u32
*read
, u32
*write
)
51 u32 read_loc
, write_loc
;
53 /* Capture the read/write indices before they changed */
54 read_loc
= rbi
->RingBuffer
->ReadIndex
;
55 write_loc
= rbi
->RingBuffer
->WriteIndex
;
57 *write
= BYTES_AVAIL_TO_WRITE(read_loc
, write_loc
, rbi
->RingDataSize
);
58 *read
= rbi
->RingDataSize
- *write
;
64 GetNextWriteLocation()
67 Get the next write location for the specified ring buffer
71 GetNextWriteLocation(RING_BUFFER_INFO
*RingInfo
)
73 u32 next
= RingInfo
->RingBuffer
->WriteIndex
;
75 /* ASSERT(next < RingInfo->RingDataSize); */
83 SetNextWriteLocation()
86 Set the next write location for the specified ring buffer
90 SetNextWriteLocation(RING_BUFFER_INFO
*RingInfo
, u32 NextWriteLocation
)
92 RingInfo
->RingBuffer
->WriteIndex
= NextWriteLocation
;
101 Get the next read location for the specified ring buffer
105 GetNextReadLocation(RING_BUFFER_INFO
*RingInfo
)
107 u32 next
= RingInfo
->RingBuffer
->ReadIndex
;
109 /* ASSERT(next < RingInfo->RingDataSize); */
117 GetNextReadLocationWithOffset()
120 Get the next read location + offset for the specified ring buffer.
121 This allows the caller to skip
125 GetNextReadLocationWithOffset(RING_BUFFER_INFO
*RingInfo
, u32 Offset
)
127 u32 next
= RingInfo
->RingBuffer
->ReadIndex
;
129 /* ASSERT(next < RingInfo->RingDataSize); */
131 next
%= RingInfo
->RingDataSize
;
139 SetNextReadLocation()
142 Set the next read location for the specified ring buffer
146 SetNextReadLocation(RING_BUFFER_INFO
*RingInfo
, u32 NextReadLocation
)
148 RingInfo
->RingBuffer
->ReadIndex
= NextReadLocation
;
158 Get the start of the ring buffer
162 GetRingBuffer(RING_BUFFER_INFO
*RingInfo
)
164 return (void *)RingInfo
->RingBuffer
->Buffer
;
174 Get the size of the ring buffer
178 GetRingBufferSize(RING_BUFFER_INFO
*RingInfo
)
180 return RingInfo
->RingDataSize
;
186 GetRingBufferIndices()
189 Get the read and write indices as u64 of the specified ring buffer
193 GetRingBufferIndices(RING_BUFFER_INFO
*RingInfo
)
195 return ((u64
)RingInfo
->RingBuffer
->WriteIndex
<< 32)
196 || RingInfo
->RingBuffer
->ReadIndex
;
206 Dump out to console the ring buffer info
209 void DumpRingInfo(RING_BUFFER_INFO
*RingInfo
, char *Prefix
)
211 u32 bytesAvailToWrite
;
212 u32 bytesAvailToRead
;
214 GetRingBufferAvailBytes(RingInfo
,
220 "%s <<ringinfo %p buffer %p avail write %u "
221 "avail read %u read idx %u write idx %u>>",
224 RingInfo
->RingBuffer
->Buffer
,
227 RingInfo
->RingBuffer
->ReadIndex
,
228 RingInfo
->RingBuffer
->WriteIndex
);
232 /* Internal routines */
236 RING_BUFFER_INFO
*RingInfo
,
237 u32 StartWriteOffset
,
243 RING_BUFFER_INFO
*RingInfo
,
246 u32 StartReadOffset
);
253 RingBufferGetDebugInfo()
256 Get various debug metrics for the specified ring buffer
259 void RingBufferGetDebugInfo(RING_BUFFER_INFO
*RingInfo
,
260 RING_BUFFER_DEBUG_INFO
*DebugInfo
)
262 u32 bytesAvailToWrite
;
263 u32 bytesAvailToRead
;
265 if (RingInfo
->RingBuffer
) {
266 GetRingBufferAvailBytes(RingInfo
,
270 DebugInfo
->BytesAvailToRead
= bytesAvailToRead
;
271 DebugInfo
->BytesAvailToWrite
= bytesAvailToWrite
;
272 DebugInfo
->CurrentReadIndex
= RingInfo
->RingBuffer
->ReadIndex
;
273 DebugInfo
->CurrentWriteIndex
= RingInfo
->RingBuffer
->WriteIndex
;
274 DebugInfo
->CurrentInterruptMask
= RingInfo
->RingBuffer
->InterruptMask
;
282 GetRingBufferInterruptMask()
285 Get the interrupt mask for the specified ring buffer
288 u32
GetRingBufferInterruptMask(RING_BUFFER_INFO
*rbi
)
290 return rbi
->RingBuffer
->InterruptMask
;
299 Initialize the ring buffer
302 int RingBufferInit(RING_BUFFER_INFO
*RingInfo
, void *Buffer
, u32 BufferLen
)
304 if (sizeof(RING_BUFFER
) != PAGE_SIZE
)
307 memset(RingInfo
, 0, sizeof(RING_BUFFER_INFO
));
309 RingInfo
->RingBuffer
= (RING_BUFFER
*)Buffer
;
310 RingInfo
->RingBuffer
->ReadIndex
= RingInfo
->RingBuffer
->WriteIndex
= 0;
312 RingInfo
->RingSize
= BufferLen
;
313 RingInfo
->RingDataSize
= BufferLen
- sizeof(RING_BUFFER
);
315 spin_lock_init(&RingInfo
->ring_lock
);
326 Cleanup the ring buffer
329 void RingBufferCleanup(RING_BUFFER_INFO
*RingInfo
)
339 Write to the ring buffer
342 int RingBufferWrite(RING_BUFFER_INFO
*OutRingInfo
,
343 struct scatterlist
*sglist
, u32 sgcount
)
346 u32 byteAvailToWrite
;
348 u32 totalBytesToWrite
= 0;
350 struct scatterlist
*sg
;
351 volatile u32 nextWriteLocation
;
357 for_each_sg(sglist
, sg
, sgcount
, i
)
359 totalBytesToWrite
+= sg
->length
;
362 totalBytesToWrite
+= sizeof(u64
);
364 spin_lock_irqsave(&OutRingInfo
->ring_lock
, flags
);
366 GetRingBufferAvailBytes(OutRingInfo
,
370 DPRINT_DBG(VMBUS
, "Writing %u bytes...", totalBytesToWrite
);
372 /* DumpRingInfo(OutRingInfo, "BEFORE "); */
374 /* If there is only room for the packet, assume it is full. */
375 /* Otherwise, the next time around, we think the ring buffer */
376 /* is empty since the read index == write index */
377 if (byteAvailToWrite
<= totalBytesToWrite
) {
379 "No more space left on outbound ring buffer "
380 "(needed %u, avail %u)",
384 spin_unlock_irqrestore(&OutRingInfo
->ring_lock
, flags
);
391 /* Write to the ring buffer */
392 nextWriteLocation
= GetNextWriteLocation(OutRingInfo
);
394 for_each_sg(sglist
, sg
, sgcount
, i
)
396 nextWriteLocation
= CopyToRingBuffer(OutRingInfo
,
402 /* Set previous packet start */
403 prevIndices
= GetRingBufferIndices(OutRingInfo
);
405 nextWriteLocation
= CopyToRingBuffer(OutRingInfo
,
410 /* Make sure we flush all writes before updating the writeIndex */
413 /* Now, update the write location */
414 SetNextWriteLocation(OutRingInfo
, nextWriteLocation
);
416 /* DumpRingInfo(OutRingInfo, "AFTER "); */
418 spin_unlock_irqrestore(&OutRingInfo
->ring_lock
, flags
);
432 Read without advancing the read index
435 int RingBufferPeek(RING_BUFFER_INFO
*InRingInfo
, void *Buffer
, u32 BufferLen
)
437 u32 bytesAvailToWrite
;
438 u32 bytesAvailToRead
;
439 u32 nextReadLocation
= 0;
442 spin_lock_irqsave(&InRingInfo
->ring_lock
, flags
);
444 GetRingBufferAvailBytes(InRingInfo
,
448 /* Make sure there is something to read */
449 if (bytesAvailToRead
< BufferLen
) {
451 "got callback but not enough to read "
452 "<avail to read %d read size %d>!!",
456 spin_unlock_irqrestore(&InRingInfo
->ring_lock
, flags
);
461 /* Convert to byte offset */
462 nextReadLocation
= GetNextReadLocation(InRingInfo
);
464 nextReadLocation
= CopyFromRingBuffer(InRingInfo
,
469 spin_unlock_irqrestore(&InRingInfo
->ring_lock
, flags
);
481 Read and advance the read index
484 int RingBufferRead(RING_BUFFER_INFO
*InRingInfo
, void *Buffer
,
485 u32 BufferLen
, u32 Offset
)
487 u32 bytesAvailToWrite
;
488 u32 bytesAvailToRead
;
489 u32 nextReadLocation
= 0;
496 spin_lock_irqsave(&InRingInfo
->ring_lock
, flags
);
498 GetRingBufferAvailBytes(InRingInfo
,
502 DPRINT_DBG(VMBUS
, "Reading %u bytes...", BufferLen
);
504 /* DumpRingInfo(InRingInfo, "BEFORE "); */
506 /* Make sure there is something to read */
507 if (bytesAvailToRead
< BufferLen
) {
509 "got callback but not enough to read "
510 "<avail to read %d read size %d>!!",
514 spin_unlock_irqrestore(&InRingInfo
->ring_lock
, flags
);
519 nextReadLocation
= GetNextReadLocationWithOffset(InRingInfo
, Offset
);
521 nextReadLocation
= CopyFromRingBuffer(InRingInfo
,
526 nextReadLocation
= CopyFromRingBuffer(InRingInfo
,
531 /* Make sure all reads are done before we update the read index since */
532 /* the writer may start writing to the read area once the read index */
536 /* Update the read index */
537 SetNextReadLocation(InRingInfo
, nextReadLocation
);
539 /* DumpRingInfo(InRingInfo, "AFTER "); */
541 spin_unlock_irqrestore(&InRingInfo
->ring_lock
, flags
);
553 Helper routine to copy from source to ring buffer.
554 Assume there is enough room. Handles wrap-around in dest case only!!
559 RING_BUFFER_INFO
*RingInfo
,
560 u32 StartWriteOffset
,
564 void *ringBuffer
= GetRingBuffer(RingInfo
);
565 u32 ringBufferSize
= GetRingBufferSize(RingInfo
);
568 /* wrap-around detected! */
569 if (SrcLen
> ringBufferSize
- StartWriteOffset
) {
570 DPRINT_DBG(VMBUS
, "wrap-around detected!");
572 fragLen
= ringBufferSize
- StartWriteOffset
;
573 memcpy(ringBuffer
+ StartWriteOffset
, Src
, fragLen
);
574 memcpy(ringBuffer
, Src
+ fragLen
, SrcLen
- fragLen
);
576 memcpy(ringBuffer
+ StartWriteOffset
, Src
, SrcLen
);
578 StartWriteOffset
+= SrcLen
;
579 StartWriteOffset
%= ringBufferSize
;
581 return StartWriteOffset
;
591 Helper routine to copy to source from ring buffer.
592 Assume there is enough room. Handles wrap-around in src case only!!
597 RING_BUFFER_INFO
*RingInfo
,
602 void *ringBuffer
= GetRingBuffer(RingInfo
);
603 u32 ringBufferSize
= GetRingBufferSize(RingInfo
);
607 /* wrap-around detected at the src */
608 if (DestLen
> ringBufferSize
- StartReadOffset
) {
609 DPRINT_DBG(VMBUS
, "src wrap-around detected!");
611 fragLen
= ringBufferSize
- StartReadOffset
;
613 memcpy(Dest
, ringBuffer
+ StartReadOffset
, fragLen
);
614 memcpy(Dest
+ fragLen
, ringBuffer
, DestLen
- fragLen
);
617 memcpy(Dest
, ringBuffer
+ StartReadOffset
, DestLen
);
620 StartReadOffset
+= DestLen
;
621 StartReadOffset
%= ringBufferSize
;
623 return StartReadOffset
;