[mirror_edk2.git] / OvmfPkg / Library / VirtioMmioDeviceLib / VirtioMmioDeviceFunctions.c

/** @file\r
\r
  This driver produces Virtio Device Protocol instances for Virtio MMIO devices.\r
\r
  Copyright (C) 2012, Red Hat, Inc.\r
  Copyright (c) 2012, Intel Corporation. All rights reserved.<BR>\r
  Copyright (C) 2013, ARM Ltd.\r
\r
  This program and the accompanying materials are licensed and made available\r
  under the terms and conditions of the BSD License which accompanies this\r
  distribution. The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
  WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "VirtioMmioDevice.h"\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioGetDeviceFeatures (\r
  IN VIRTIO_DEVICE_PROTOCOL *This,\r
  OUT UINT64                *DeviceFeatures\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  if (DeviceFeatures == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  *DeviceFeatures = VIRTIO_CFG_READ (Device, VIRTIO_MMIO_OFFSET_HOST_FEATURES);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioGetQueueSize (\r
  IN  VIRTIO_DEVICE_PROTOCOL  *This,\r
  OUT UINT16                  *QueueNumMax\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  if (QueueNumMax == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  *QueueNumMax = VIRTIO_CFG_READ (Device, VIRTIO_MMIO_OFFSET_QUEUE_NUM_MAX) & 0xFFFF;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioGetDeviceStatus (\r
  IN  VIRTIO_DEVICE_PROTOCOL  *This,\r
  OUT UINT8                   *DeviceStatus\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  if (DeviceStatus == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  *DeviceStatus = VIRTIO_CFG_READ (Device, VIRTIO_MMIO_OFFSET_STATUS) & 0xFF;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetQueueSize (\r
  VIRTIO_DEVICE_PROTOCOL *This,\r
  UINT16                  QueueSize\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_NUM, QueueSize);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetDeviceStatus (\r
  VIRTIO_DEVICE_PROTOCOL *This,\r
  UINT8                   DeviceStatus\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_STATUS, DeviceStatus);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetQueueNotify (\r
  VIRTIO_DEVICE_PROTOCOL *This,\r
  UINT16                  QueueNotify\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_NOTIFY, QueueNotify);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetQueueAlignment (\r
  VIRTIO_DEVICE_PROTOCOL *This,\r
  UINT32                  Alignment\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_ALIGN, Alignment);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetPageSize (\r
  VIRTIO_DEVICE_PROTOCOL *This,\r
  UINT32                  PageSize\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  if (PageSize != EFI_PAGE_SIZE) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_GUEST_PAGE_SIZE, PageSize);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetQueueSel (\r
  VIRTIO_DEVICE_PROTOCOL *This,\r
  UINT16                  Sel\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_SEL, Sel);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
VirtioMmioSetQueueAddress (\r
  VIRTIO_DEVICE_PROTOCOL *This,\r
  UINT32                  Address\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_PFN, Address);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioSetGuestFeatures (\r
  VIRTIO_DEVICE_PROTOCOL *This,\r
  UINT64                  Features\r
  )\r
{\r
  VIRTIO_MMIO_DEVICE *Device;\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  if (Features > MAX_UINT32) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_GUEST_FEATURES,\r
    (UINT32)Features);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioDeviceWrite (\r
  IN VIRTIO_DEVICE_PROTOCOL *This,\r
  IN UINTN                  FieldOffset,\r
  IN UINTN                  FieldSize,\r
  IN UINT64                 Value\r
  )\r
{\r
  UINTN                     DstBaseAddress;\r
  VIRTIO_MMIO_DEVICE       *Device;\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  //\r
  // Double-check fieldsize\r
  //\r
  if ((FieldSize != 1) && (FieldSize != 2) &&\r
      (FieldSize != 4) && (FieldSize != 8)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Compute base address\r
  //\r
  DstBaseAddress = Device->BaseAddress +\r
      VIRTIO_DEVICE_SPECIFIC_CONFIGURATION_OFFSET_MMIO + FieldOffset;\r
\r
  //\r
  // The device-specific memory area of Virtio-MMIO can only be written in\r
  // byte accesses. This is not currently in the Virtio spec.\r
  //\r
  MmioWriteBuffer8 (DstBaseAddress, FieldSize, (UINT8*)&Value);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
EFIAPI\r
VirtioMmioDeviceRead (\r
  IN  VIRTIO_DEVICE_PROTOCOL    *This,\r
  IN  UINTN                     FieldOffset,\r
  IN  UINTN                     FieldSize,\r
  IN  UINTN                     BufferSize,\r
  OUT VOID                      *Buffer\r
  )\r
{\r
  UINTN                     SrcBaseAddress;\r
  VIRTIO_MMIO_DEVICE       *Device;\r
\r
  Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
\r
  //\r
  // Parameter validation\r
  //\r
  ASSERT (FieldSize == BufferSize);\r
\r
  //\r
  // Double-check fieldsize\r
  //\r
  if ((FieldSize != 1) && (FieldSize != 2) &&\r
      (FieldSize != 4) && (FieldSize != 8)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Compute base address\r
  //\r
  SrcBaseAddress = Device->BaseAddress +\r
      VIRTIO_DEVICE_SPECIFIC_CONFIGURATION_OFFSET_MMIO + FieldOffset;\r
\r
  //\r
  // The device-specific memory area of Virtio-MMIO can only be read in\r
  // byte reads. This is not currently in the Virtio spec.\r
  //\r
  MmioReadBuffer8 (SrcBaseAddress, BufferSize, Buffer);\r
\r
  return EFI_SUCCESS;\r
}\r
Commit	Line	Data
6fb4e772 OM	1	/** @file\r
	2	\r
	3	This driver produces Virtio Device Protocol instances for Virtio MMIO devices.\r
	4	\r
	5	Copyright (C) 2012, Red Hat, Inc.\r
	6	Copyright (c) 2012, Intel Corporation. All rights reserved.<BR>\r
	7	Copyright (C) 2013, ARM Ltd.\r
	8	\r
	9	This program and the accompanying materials are licensed and made available\r
	10	under the terms and conditions of the BSD License which accompanies this\r
	11	distribution. The full text of the license may be found at\r
	12	http://opensource.org/licenses/bsd-license.php\r
	13	\r
	14	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r
	15	WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	16	\r
	17	**/\r
	18	\r
	19	#include "VirtioMmioDevice.h"\r
	20	\r
	21	EFI_STATUS\r
	22	EFIAPI\r
	23	VirtioMmioGetDeviceFeatures (\r
	24	IN VIRTIO_DEVICE_PROTOCOL *This,\r
bc8fde6f	25	OUT UINT64 *DeviceFeatures\r
6fb4e772 OM	26	)\r
	27	{\r
	28	VIRTIO_MMIO_DEVICE *Device;\r
	29	\r
	30	if (DeviceFeatures == NULL) {\r
	31	return EFI_INVALID_PARAMETER;\r
	32	}\r
	33	\r
	34	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
	35	\r
	36	*DeviceFeatures = VIRTIO_CFG_READ (Device, VIRTIO_MMIO_OFFSET_HOST_FEATURES);\r
	37	\r
	38	return EFI_SUCCESS;\r
	39	}\r
	40	\r
6fb4e772 OM	41	EFI_STATUS\r
	42	EFIAPI\r
	43	VirtioMmioGetQueueSize (\r
	44	IN VIRTIO_DEVICE_PROTOCOL *This,\r
	45	OUT UINT16 *QueueNumMax\r
	46	)\r
	47	{\r
	48	VIRTIO_MMIO_DEVICE *Device;\r
	49	\r
	50	if (QueueNumMax == NULL) {\r
	51	return EFI_INVALID_PARAMETER;\r
	52	}\r
	53	\r
	54	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
	55	\r
	56	*QueueNumMax = VIRTIO_CFG_READ (Device, VIRTIO_MMIO_OFFSET_QUEUE_NUM_MAX) & 0xFFFF;\r
	57	\r
	58	return EFI_SUCCESS;\r
	59	}\r
	60	\r
	61	EFI_STATUS\r
	62	EFIAPI\r
	63	VirtioMmioGetDeviceStatus (\r
	64	IN VIRTIO_DEVICE_PROTOCOL *This,\r
	65	OUT UINT8 *DeviceStatus\r
	66	)\r
	67	{\r
	68	VIRTIO_MMIO_DEVICE *Device;\r
	69	\r
	70	if (DeviceStatus == NULL) {\r
	71	return EFI_INVALID_PARAMETER;\r
	72	}\r
	73	\r
	74	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
	75	\r
	76	*DeviceStatus = VIRTIO_CFG_READ (Device, VIRTIO_MMIO_OFFSET_STATUS) & 0xFF;\r
	77	\r
	78	return EFI_SUCCESS;\r
	79	}\r
	80	\r
	81	EFI_STATUS\r
	82	EFIAPI\r
	83	VirtioMmioSetQueueSize (\r
	84	VIRTIO_DEVICE_PROTOCOL *This,\r
	85	UINT16 QueueSize\r
	86	)\r
	87	{\r
	88	VIRTIO_MMIO_DEVICE *Device;\r
	89	\r
	90	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
	91	\r
	92	VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_NUM, QueueSize);\r
	93	\r
	94	return EFI_SUCCESS;\r
	95	}\r
	96	\r
	97	EFI_STATUS\r
	98	EFIAPI\r
	99	VirtioMmioSetDeviceStatus (\r
	100	VIRTIO_DEVICE_PROTOCOL *This,\r
	101	UINT8 DeviceStatus\r
	102	)\r
	103	{\r
	104	VIRTIO_MMIO_DEVICE *Device;\r
105	\r
106	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
107	\r
108	VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_STATUS, DeviceStatus);\r
109	\r
110	return EFI_SUCCESS;\r
111	}\r
112	\r
113	EFI_STATUS\r
114	EFIAPI\r
115	VirtioMmioSetQueueNotify (\r
116	VIRTIO_DEVICE_PROTOCOL *This,\r
117	UINT16 QueueNotify\r
118	)\r
119	{\r
120	VIRTIO_MMIO_DEVICE *Device;\r
121	\r
122	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
123	\r
124	VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_NOTIFY, QueueNotify);\r
125	\r
126	return EFI_SUCCESS;\r
127	}\r
128	\r
129	EFI_STATUS\r
130	EFIAPI\r
131	VirtioMmioSetQueueAlignment (\r
132	VIRTIO_DEVICE_PROTOCOL *This,\r
133	UINT32 Alignment\r
134	)\r
135	{\r
136	VIRTIO_MMIO_DEVICE *Device;\r
137	\r
138	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
139	\r
140	VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_ALIGN, Alignment);\r
141	\r
142	return EFI_SUCCESS;\r
143	}\r
144	\r
145	EFI_STATUS\r
146	EFIAPI\r
147	VirtioMmioSetPageSize (\r
148	VIRTIO_DEVICE_PROTOCOL *This,\r
149	UINT32 PageSize\r
150	)\r
151	{\r
152	VIRTIO_MMIO_DEVICE *Device;\r
153	\r
154	if (PageSize != EFI_PAGE_SIZE) {\r
155	return EFI_UNSUPPORTED;\r
156	}\r
157	\r
158	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
159	\r
160	VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_GUEST_PAGE_SIZE, PageSize);\r
161	\r
162	return EFI_SUCCESS;\r
163	}\r
164	\r
165	EFI_STATUS\r
166	EFIAPI\r
167	VirtioMmioSetQueueSel (\r
168	VIRTIO_DEVICE_PROTOCOL *This,\r
169	UINT16 Sel\r
170	)\r
171	{\r
172	VIRTIO_MMIO_DEVICE *Device;\r
173	\r
174	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
175	\r
176	VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_SEL, Sel);\r
177	\r
178	return EFI_SUCCESS;\r
179	}\r
180	\r
181	EFI_STATUS\r
182	VirtioMmioSetQueueAddress (\r
183	VIRTIO_DEVICE_PROTOCOL *This,\r
184	UINT32 Address\r
185	)\r
186	{\r
187	VIRTIO_MMIO_DEVICE *Device;\r
188	\r
189	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
190	\r
191	VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_QUEUE_PFN, Address);\r
192	\r
193	return EFI_SUCCESS;\r
194	}\r
195	\r
196	EFI_STATUS\r
197	EFIAPI\r
198	VirtioMmioSetGuestFeatures (\r
199	VIRTIO_DEVICE_PROTOCOL *This,\r
bc8fde6f	200	UINT64 Features\r
6fb4e772 OM	201	)\r
	202	{\r
	203	VIRTIO_MMIO_DEVICE *Device;\r
	204	\r
	205	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
	206	\r
bc8fde6f LE	207	if (Features > MAX_UINT32) {\r
	208	return EFI_UNSUPPORTED;\r
	209	}\r
	210	VIRTIO_CFG_WRITE (Device, VIRTIO_MMIO_OFFSET_GUEST_FEATURES,\r
	211	(UINT32)Features);\r
6fb4e772 OM	212	\r
	213	return EFI_SUCCESS;\r
	214	}\r
	215	\r
	216	EFI_STATUS\r
	217	EFIAPI\r
	218	VirtioMmioDeviceWrite (\r
	219	IN VIRTIO_DEVICE_PROTOCOL *This,\r
	220	IN UINTN FieldOffset,\r
	221	IN UINTN FieldSize,\r
	222	IN UINT64 Value\r
	223	)\r
	224	{\r
	225	UINTN DstBaseAddress;\r
	226	VIRTIO_MMIO_DEVICE *Device;\r
	227	\r
	228	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
	229	\r
	230	//\r
	231	// Double-check fieldsize\r
	232	//\r
	233	if ((FieldSize != 1) && (FieldSize != 2) &&\r
	234	(FieldSize != 4) && (FieldSize != 8)) {\r
	235	return EFI_INVALID_PARAMETER;\r
	236	}\r
	237	\r
	238	//\r
	239	// Compute base address\r
	240	//\r
	241	DstBaseAddress = Device->BaseAddress +\r
	242	VIRTIO_DEVICE_SPECIFIC_CONFIGURATION_OFFSET_MMIO + FieldOffset;\r
	243	\r
	244	//\r
	245	// The device-specific memory area of Virtio-MMIO can only be written in\r
	246	// byte accesses. This is not currently in the Virtio spec.\r
	247	//\r
	248	MmioWriteBuffer8 (DstBaseAddress, FieldSize, (UINT8*)&Value);\r
	249	\r
	250	return EFI_SUCCESS;\r
	251	}\r
	252	\r
	253	EFI_STATUS\r
	254	EFIAPI\r
	255	VirtioMmioDeviceRead (\r
	256	IN VIRTIO_DEVICE_PROTOCOL *This,\r
	257	IN UINTN FieldOffset,\r
	258	IN UINTN FieldSize,\r
	259	IN UINTN BufferSize,\r
	260	OUT VOID *Buffer\r
	261	)\r
	262	{\r
	263	UINTN SrcBaseAddress;\r
	264	VIRTIO_MMIO_DEVICE *Device;\r
	265	\r
	266	Device = VIRTIO_MMIO_DEVICE_FROM_VIRTIO_DEVICE (This);\r
	267	\r
	268	//\r
	269	// Parameter validation\r
	270	//\r
	271	ASSERT (FieldSize == BufferSize);\r
	272	\r
	273	//\r
	274	// Double-check fieldsize\r
	275	//\r
276	if ((FieldSize != 1) && (FieldSize != 2) &&\r
277	(FieldSize != 4) && (FieldSize != 8)) {\r
278	return EFI_INVALID_PARAMETER;\r
279	}\r
280	\r
281	//\r
282	// Compute base address\r
283	//\r
284	SrcBaseAddress = Device->BaseAddress +\r
285	VIRTIO_DEVICE_SPECIFIC_CONFIGURATION_OFFSET_MMIO + FieldOffset;\r
286	\r
287	//\r
288	// The device-specific memory area of Virtio-MMIO can only be read in\r
289	// byte reads. This is not currently in the Virtio spec.\r
290	//\r
291	MmioReadBuffer8 (SrcBaseAddress, BufferSize, Buffer);\r
292	\r
293	return EFI_SUCCESS;\r
294	}\r