Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 1 | /* |
| 2 | * |
| 3 | * Copyright (c) 2009, Microsoft Corporation. |
| 4 | * |
| 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. |
| 8 | * |
| 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 |
| 12 | * more details. |
| 13 | * |
| 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. |
| 17 | * |
| 18 | * Authors: |
| 19 | * Haiyang Zhang <haiyangz@microsoft.com> |
| 20 | * Hank Janssen <hjanssen@microsoft.com> |
| 21 | * |
| 22 | */ |
| 23 | |
| 24 | |
| 25 | #ifndef _RING_BUFFER_H_ |
| 26 | #define _RING_BUFFER_H_ |
| 27 | |
Greg Kroah-Hartman | 09d50ff | 2009-07-13 17:09:34 -0700 | [diff] [blame] | 28 | #include "include/osd.h" |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 29 | |
| 30 | typedef struct _SG_BUFFER_LIST { |
Greg Kroah-Hartman | 8282c40 | 2009-07-14 15:06:28 -0700 | [diff] [blame] | 31 | void * Data; |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 32 | u32 Length; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 33 | } SG_BUFFER_LIST; |
| 34 | |
| 35 | typedef struct _RING_BUFFER { |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 36 | volatile u32 WriteIndex; // Offset in bytes from the start of ring data below |
| 37 | volatile u32 ReadIndex; // Offset in bytes from the start of ring data below |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 38 | |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 39 | volatile u32 InterruptMask; |
Greg Kroah-Hartman | 5654e93 | 2009-07-14 15:08:20 -0700 | [diff] [blame] | 40 | u8 Reserved[4084]; // Pad it to PAGE_SIZE so that data starts on page boundary |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 41 | // NOTE: The InterruptMask field is used only for channels but since our vmbus connection |
| 42 | // also uses this data structure and its data starts here, we commented out this field. |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 43 | // volatile u32 InterruptMask; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 44 | // Ring data starts here + RingDataStartOffset !!! DO NOT place any fields below this !!! |
Greg Kroah-Hartman | 5654e93 | 2009-07-14 15:08:20 -0700 | [diff] [blame] | 45 | u8 Buffer[0]; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 46 | } STRUCT_PACKED RING_BUFFER; |
| 47 | |
| 48 | typedef struct _RING_BUFFER_INFO { |
| 49 | RING_BUFFER* RingBuffer; |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 50 | u32 RingSize; // Include the shared header |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 51 | HANDLE RingLock; |
| 52 | |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 53 | u32 RingDataSize; // < ringSize |
| 54 | u32 RingDataStartOffset; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 55 | |
| 56 | } RING_BUFFER_INFO; |
| 57 | |
| 58 | |
| 59 | typedef struct _RING_BUFFER_DEBUG_INFO { |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 60 | u32 CurrentInterruptMask; |
| 61 | u32 CurrentReadIndex; |
| 62 | u32 CurrentWriteIndex; |
| 63 | u32 BytesAvailToRead; |
| 64 | u32 BytesAvailToWrite; |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 65 | }RING_BUFFER_DEBUG_INFO; |
| 66 | |
| 67 | |
| 68 | // |
| 69 | // Interface |
| 70 | // |
| 71 | |
Greg Kroah-Hartman | 2be1301 | 2009-07-14 15:05:36 -0700 | [diff] [blame] | 72 | static int |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 73 | RingBufferInit( |
| 74 | RING_BUFFER_INFO *RingInfo, |
Greg Kroah-Hartman | 8282c40 | 2009-07-14 15:06:28 -0700 | [diff] [blame] | 75 | void * Buffer, |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 76 | u32 BufferLen |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 77 | ); |
| 78 | |
Greg Kroah-Hartman | 2be1301 | 2009-07-14 15:05:36 -0700 | [diff] [blame] | 79 | static void |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 80 | RingBufferCleanup( |
| 81 | RING_BUFFER_INFO *RingInfo |
| 82 | ); |
| 83 | |
Greg Kroah-Hartman | 2be1301 | 2009-07-14 15:05:36 -0700 | [diff] [blame] | 84 | static int |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 85 | RingBufferWrite( |
| 86 | RING_BUFFER_INFO *RingInfo, |
| 87 | SG_BUFFER_LIST SgBuffers[], |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 88 | u32 SgBufferCount |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 89 | ); |
| 90 | |
Greg Kroah-Hartman | 2be1301 | 2009-07-14 15:05:36 -0700 | [diff] [blame] | 91 | static int |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 92 | RingBufferPeek( |
| 93 | RING_BUFFER_INFO *RingInfo, |
Greg Kroah-Hartman | 8282c40 | 2009-07-14 15:06:28 -0700 | [diff] [blame] | 94 | void * Buffer, |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 95 | u32 BufferLen |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 96 | ); |
| 97 | |
Greg Kroah-Hartman | 2be1301 | 2009-07-14 15:05:36 -0700 | [diff] [blame] | 98 | static int |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 99 | RingBufferRead( |
| 100 | RING_BUFFER_INFO *RingInfo, |
Greg Kroah-Hartman | 8282c40 | 2009-07-14 15:06:28 -0700 | [diff] [blame] | 101 | void * Buffer, |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 102 | u32 BufferLen, |
| 103 | u32 Offset |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 104 | ); |
| 105 | |
Greg Kroah-Hartman | 4d64311 | 2009-07-14 15:09:36 -0700 | [diff] [blame] | 106 | static u32 |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 107 | GetRingBufferInterruptMask( |
| 108 | RING_BUFFER_INFO *RingInfo |
| 109 | ); |
| 110 | |
Greg Kroah-Hartman | 2be1301 | 2009-07-14 15:05:36 -0700 | [diff] [blame] | 111 | static void |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 112 | DumpRingInfo( |
| 113 | RING_BUFFER_INFO* RingInfo, |
| 114 | char *Prefix |
| 115 | ); |
| 116 | |
Greg Kroah-Hartman | 2be1301 | 2009-07-14 15:05:36 -0700 | [diff] [blame] | 117 | static void |
Hank Janssen | 3e7ee49 | 2009-07-13 16:02:34 -0700 | [diff] [blame] | 118 | RingBufferGetDebugInfo( |
| 119 | RING_BUFFER_INFO *RingInfo, |
| 120 | RING_BUFFER_DEBUG_INFO *DebugInfo |
| 121 | ); |
| 122 | |
| 123 | #endif // _RING_BUFFER_H_ |