EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Functions

MdeModulePkg/Universal/Network/SnpDxe/Nvdata.c File Reference

#include "Snp.h"

Go to the source code of this file.

Functions

EFI_STATUS PxeNvDataRead (IN SNP_DRIVER *Snp, IN UINTN Offset, IN UINTN BufferSize, IN OUT VOID *Buffer)
EFI_STATUS EFIAPI SnpUndi32NvData (IN EFI_SIMPLE_NETWORK_PROTOCOL *This, IN BOOLEAN ReadWrite, IN UINTN Offset, IN UINTN BufferSize, IN OUT VOID *Buffer)

Detailed Description

Implementation of reading and writing operations on the NVRAM device attached to a network interface.

Copyright (c) 2004 - 2009, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file Nvdata.c.


Function Documentation

EFI_STATUS PxeNvDataRead ( IN SNP_DRIVER Snp,
IN UINTN  Offset,
IN UINTN  BufferSize,
IN OUT VOID *  Buffer 
)

This routine calls Undi to read the desired number of eeprom bytes.

Parameters:
Snppointer to the snp driver structure
Offseteeprom register value relative to the base address
BufferSizenumber of bytes to read
Bufferpointer where to read into
Return values:
EFI_SUCCESSThe NVRAM access was performed.
EFI_INVALID_PARAMETERInvalid UNDI command.
EFI_UNSUPPORTEDCommand is not supported by UNDI.
EFI_DEVICE_ERRORFail to execute UNDI command.

Definition at line 34 of file Nvdata.c.

EFI_STATUS EFIAPI SnpUndi32NvData ( IN EFI_SIMPLE_NETWORK_PROTOCOL This,
IN BOOLEAN  ReadWrite,
IN UINTN  Offset,
IN UINTN  BufferSize,
IN OUT VOID *  Buffer 
)

Performs read and write operations on the NVRAM device attached to a network interface.

This function performs read and write operations on the NVRAM device attached to a network interface. If ReadWrite is TRUE, a read operation is performed. If ReadWrite is FALSE, a write operation is performed. Offset specifies the byte offset at which to start either operation. Offset must be a multiple of NvRamAccessSize , and it must have a value between zero and NvRamSize. BufferSize specifies the length of the read or write operation. BufferSize must also be a multiple of NvRamAccessSize, and Offset + BufferSize must not exceed NvRamSize. If any of the above conditions is not met, then EFI_INVALID_PARAMETER will be returned. If all the conditions are met and the operation is "read," the NVRAM device attached to the network interface will be read into Buffer and EFI_SUCCESS will be returned. If this is a write operation, the contents of Buffer will be used to update the contents of the NVRAM device attached to the network interface and EFI_SUCCESS will be returned.

It does the basic checking on the input parameters and retrieves snp structure and then calls the read_nvdata() call which does the actual reading

Parameters:
ThisA pointer to the EFI_SIMPLE_NETWORK_PROTOCOL instance.
ReadWriteTRUE for read operations, FALSE for write operations.
OffsetByte offset in the NVRAM device at which to start the read or write operation. This must be a multiple of NvRamAccessSize and less than NvRamSize. (See EFI_SIMPLE_NETWORK_MODE)
BufferSizeThe number of bytes to read or write from the NVRAM device. This must also be a multiple of NvramAccessSize.
BufferA pointer to the data buffer.
Return values:
EFI_SUCCESSThe NVRAM access was performed.
EFI_NOT_STARTEDThe network interface has not been started.
EFI_INVALID_PARAMETEROne or more of the following conditions is TRUE: The This parameter is NULL The This parameter does not point to a valid EFI_SIMPLE_NETWORK_PROTOCOL structure The Offset parameter is not a multiple of EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize The Offset parameter is not less than EFI_SIMPLE_NETWORK_MODE.NvRamSize The BufferSize parameter is not a multiple of EFI_SIMPLE_NETWORK_MODE.NvRamAccessSize The Buffer parameter is NULL
EFI_DEVICE_ERRORThe command could not be sent to the network interface.
EFI_UNSUPPORTEDThis function is not supported by the network interface.

Definition at line 152 of file Nvdata.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines