From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received-SPF: Pass (sender SPF authorized) identity=mailfrom; client-ip=134.134.136.65; helo=mga03.intel.com; envelope-from=eric.dong@intel.com; receiver=edk2-devel@lists.01.org Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ml01.01.org (Postfix) with ESMTPS id 87A27202E5364 for ; Sun, 17 Feb 2019 17:44:56 -0800 (PST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 17 Feb 2019 17:44:56 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,382,1544515200"; d="scan'208";a="115714755" Received: from fmsmsx108.amr.corp.intel.com ([10.18.124.206]) by orsmga007.jf.intel.com with ESMTP; 17 Feb 2019 17:44:55 -0800 Received: from fmsmsx161.amr.corp.intel.com (10.18.125.9) by FMSMSX108.amr.corp.intel.com (10.18.124.206) with Microsoft SMTP Server (TLS) id 14.3.408.0; Sun, 17 Feb 2019 17:44:55 -0800 Received: from shsmsx153.ccr.corp.intel.com (10.239.6.53) by FMSMSX161.amr.corp.intel.com (10.18.125.9) with Microsoft SMTP Server (TLS) id 14.3.408.0; Sun, 17 Feb 2019 17:44:55 -0800 Received: from shsmsx102.ccr.corp.intel.com ([169.254.2.207]) by SHSMSX153.ccr.corp.intel.com ([169.254.12.190]) with mapi id 14.03.0415.000; Mon, 18 Feb 2019 09:44:53 +0800 From: "Dong, Eric" To: "Wu, Hao A" , "edk2-devel@lists.01.org" Thread-Topic: [PATCH v5 02/13] MdeModulePkg: Add definitions for EDKII PEI ATA PassThru PPI Thread-Index: AQHUxPcG7gPx2s/UFEeOTN/epSILGaXkzSQA Date: Mon, 18 Feb 2019 01:44:52 +0000 Message-ID: References: <20190215062338.19412-1-hao.a.wu@intel.com> <20190215062338.19412-3-hao.a.wu@intel.com> In-Reply-To: <20190215062338.19412-3-hao.a.wu@intel.com> Accept-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-originating-ip: [10.239.127.40] MIME-Version: 1.0 Subject: Re: [PATCH v5 02/13] MdeModulePkg: Add definitions for EDKII PEI ATA PassThru PPI X-BeenThere: edk2-devel@lists.01.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: EDK II Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 18 Feb 2019 01:44:56 -0000 Content-Language: en-US Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Reviewed-by: Eric Dong > -----Original Message----- > From: Wu, Hao A > Sent: Friday, February 15, 2019 2:23 PM > To: edk2-devel@lists.01.org > Cc: Wu, Hao A ; Wang, Jian J ; > Dong, Eric > Subject: [PATCH v5 02/13] MdeModulePkg: Add definitions for EDKII PEI ATA > PassThru PPI >=20 > REF:https://bugzilla.tianocore.org/show_bug.cgi?id=3D1409 >=20 > This commit will add the definitions for EDKII PEI ATA PassThru PPI. This= PPI > will provide services that allow ATA commands to be sent to ATA devices > attached to an ATA controller in the PEI phase. >=20 > More specifically, the PPI will provide services to: >=20 > * Send ATA commands to an ATA device (by service 'PassThru'); > * Get the list of the attached ATA device on a controller (by services > 'GetNextPort' and 'GetNextDevice'); > * Get the identification information (DevicePath) of the underlying ATA > host controller (by service 'GetDevicePath'). >=20 > Cc: Jian J Wang > Cc: Eric Dong > Contributed-under: TianoCore Contribution Agreement 1.1 > Signed-off-by: Hao Wu > Reviewed-by: Ray Ni > --- > MdeModulePkg/MdeModulePkg.dec | 3 + > MdeModulePkg/Include/Ppi/AtaPassThru.h | 219 ++++++++++++++++++++ > 2 files changed, 222 insertions(+) >=20 > diff --git a/MdeModulePkg/MdeModulePkg.dec > b/MdeModulePkg/MdeModulePkg.dec index 4411185073..8efb19e626 > 100644 > --- a/MdeModulePkg/MdeModulePkg.dec > +++ b/MdeModulePkg/MdeModulePkg.dec > @@ -483,6 +483,9 @@ > ## Include/Ppi/AtaAhciController.h > gEdkiiPeiAtaAhciHostControllerPpiGuid =3D { 0x61dd33ea, 0x421f, 0x= 4cc0, > { 0x89, 0x29, 0xff, 0xee, 0xa9, 0xa1, 0xa2, 0x61 } } >=20 > + ## Include/Ppi/AtaPassThru.h > + gEdkiiPeiAtaPassThruPpiGuid =3D { 0xa16473fd, 0xd474, 0x= 4c89, { 0xae, > 0xc7, 0x90, 0xb8, 0x3c, 0x73, 0x86, 0x9 } } > + > [Protocols] > ## Load File protocol provides capability to load and unload EFI image= into > memory and execute it. > # Include/Protocol/LoadPe32Image.h > diff --git a/MdeModulePkg/Include/Ppi/AtaPassThru.h > b/MdeModulePkg/Include/Ppi/AtaPassThru.h > new file mode 100644 > index 0000000000..78bdaef9e2 > --- /dev/null > +++ b/MdeModulePkg/Include/Ppi/AtaPassThru.h > @@ -0,0 +1,219 @@ > +/** @file > + > + Copyright (c) 2019, 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. > + > +**/ > + > +#ifndef _EDKII_ATA_PASS_THRU_PPI_H_ > +#define _EDKII_ATA_PASS_THRU_PPI_H_ > + > +#include > +#include > + > +/// > +/// Global ID for the EDKII_PEI_ATA_PASS_THRU_PPI. > +/// > +#define EDKII_PEI_ATA_PASS_THRU_PPI_GUID \ > + { \ > + 0xa16473fd, 0xd474, 0x4c89, { 0xae, 0xc7, 0x90, 0xb8, 0x3c, 0x73, > +0x86, 0x9 } \ > + } > + > +// > +// Forward declaration for the EDKII_PEI_ATA_PASS_THRU_PPI. > +// > +typedef struct _EDKII_PEI_ATA_PASS_THRU_PPI > +EDKII_PEI_ATA_PASS_THRU_PPI; > + > +// > +// Revision The revision to which the ATA Pass Thru PPI interface adhere= s. > +// All future revisions must be backwards compatible. > +// If a future version is not back wards compatible it is not t= he same > GUID. > +// > +#define EDKII_PEI_ATA_PASS_THRU_PPI_REVISION 0x00010000 > + > + > +/** > + Sends an ATA command to an ATA device that is attached to the ATA > controller. > + > + @param[in] This The PPI instance pointer. > + @param[in] Port The port number of the ATA device= to send > + the command. > + @param[in] PortMultiplierPort The port multiplier port number o= f the > ATA > + device to send the command. > + If there is no port multiplier, t= hen specify > + 0xFFFF. > + @param[in,out] Packet A pointer to the ATA command to s= end to > + the ATA device specified by Port = and > + PortMultiplierPort. > + > + @retval EFI_SUCCESS The ATA command was sent by the host.= For > + bi-directional commands, InTransferLe= ngth bytes > + were transferred from InDataBuffer. F= or write > + and bi-directional commands, OutTrans= ferLength > + bytes were transferred by OutDataBuff= er. > + @retval EFI_NOT_FOUND The specified ATA device is not found= . > + @retval EFI_INVALID_PARAMETER The contents of Acb are invalid. The > ATA command > + was not sent, so no additional status= information > + is available. > + @retval EFI_BAD_BUFFER_SIZE The ATA command was not executed. > The number > + of bytes that could be transferred is= returned > + in InTransferLength. For write and bi= -directional > + commands, OutTransferLength bytes wer= e transferred > + by OutDataBuffer. > + @retval EFI_NOT_READY The ATA command could not be sent > because there > + are too many ATA commands already que= ued. The > + caller may retry again later. > + @retval EFI_DEVICE_ERROR A device error occurred while attempt= ing > to > + send the ATA command. > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EDKII_PEI_ATA_PASS_THRU_PASSTHRU) ( > + IN EDKII_PEI_ATA_PASS_THRU_PPI *This, > + IN UINT16 Port, > + IN UINT16 PortMultiplierPort, > + IN OUT EFI_ATA_PASS_THRU_COMMAND_PACKET *Packet > + ); > + > +/** > + Used to retrieve the list of legal port numbers for ATA devices on an = ATA > controller. > + These can either be the list of ports where ATA devices are actually > +present or the > + list of legal port numbers for the ATA controller. Regardless, the > +caller of this > + function must probe the port number returned to see if an ATA device > +is actually > + present at that location on the ATA controller. > + > + The GetNextPort() function retrieves the port number on an ATA > + controller. If on input Port is 0xFFFF, then the port number of the > + first port on the ATA controller is returned in Port and EFI_SUCCESS i= s > returned. > + > + If Port is a port number that was returned on a previous call to > + GetNextPort(), then the port number of the next port on the ATA > + controller is returned in Port, and EFI_SUCCESS is returned. If Port > + is not 0xFFFF and Port was not returned on a previous call to > GetNextPort(), then EFI_INVALID_PARAMETER is returned. > + > + If Port is the port number of the last port on the ATA controller, > + then EFI_NOT_FOUND is returned. > + > + @param[in] This The PPI instance pointer. > + @param[in,out] Port On input, a pointer to the port number on the A= TA > controller. > + On output, a pointer to the next port number on= the ATA > + controller. An input value of 0xFFFF retrieves = the first > + port number on the ATA controller. > + > + @retval EFI_SUCCESS The next port number on the ATA contr= oller > was > + returned in Port. > + @retval EFI_NOT_FOUND There are no more ports on this ATA > controller. > + @retval EFI_INVALID_PARAMETER Port is not 0xFFFF and Port was not > returned > + on a previous call to GetNextPort(). > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EDKII_PEI_ATA_PASS_THRU_THRU_GET_NEXT_PORT) ( > + IN EDKII_PEI_ATA_PASS_THRU_PPI *This, > + IN OUT UINT16 *Port > + ); > + > +/** > + Used to retrieve the list of legal port multiplier port numbers for > +ATA devices > + on a port of an ATA controller. These can either be the list of port > +multiplier > + ports where ATA devices are actually present on port or the list of > +legal port > + multiplier ports on that port. Regardless, the caller of this > +function must probe > + the port number and port multiplier port number returned to see if an > +ATA device > + is actually present. > + > + The GetNextDevice() function retrieves the port multiplier port > + number of an ATA device present on a port of an ATA controller. > + > + If PortMultiplierPort points to a port multiplier port number value > + that was returned on a previous call to GetNextDevice(), then the > + port multiplier port number of the next ATA device on the port of the > + ATA controller is returned in PortMultiplierPort, and EFI_SUCCESS is > returned. > + > + If PortMultiplierPort points to 0xFFFF, then the port multiplier port > + number of the first ATA device on port of the ATA controller is > + returned in PortMultiplierPort and EFI_SUCCESS is returned. > + > + If PortMultiplierPort is not 0xFFFF and the value pointed to by > + PortMultiplierPort was not returned on a previous call to > + GetNextDevice(), then EFI_INVALID_PARAMETER is returned. > + > + If PortMultiplierPort is the port multiplier port number of the last > + ATA device on the port of the ATA controller, then EFI_NOT_FOUND is > returned. > + > + @param[in] This The PPI instance pointer. > + @param[in] Port The port number present on the AT= A controller. > + @param[in,out] PortMultiplierPort On input, a pointer to the port > multiplier > + port number of an ATA device pres= ent on the > + ATA controller. If on input a Por= tMultiplierPort > + of 0xFFFF is specified, then the = port multiplier > + port number of the first ATA devi= ce is returned. > + On output, a pointer to the port = multiplier port > + number of the next ATA device pre= sent on an ATA > + controller. > + > + @retval EFI_SUCCESS The port multiplier port number of th= e next > ATA > + device on the port of the ATA control= ler was > + returned in PortMultiplierPort. > + @retval EFI_NOT_FOUND There are no more ATA devices on this > port of > + the ATA controller. > + @retval EFI_INVALID_PARAMETER PortMultiplierPort is not 0xFFFF, and > PortMultiplierPort > + was not returned on a previous call t= o GetNextDevice(). > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EDKII_PEI_ATA_PASS_THRU_GET_NEXT_DEVICE) ( > + IN EDKII_PEI_ATA_PASS_THRU_PPI *This, > + IN UINT16 Port, > + IN OUT UINT16 *PortMultiplierPort > + ); > + > +/** > + Gets the device path information of the underlying ATA host controller= . > + > + @param[in] This The PPI instance pointer. > + @param[out] DevicePathLength The length of the device path in bytes > specified > + by DevicePath. > + @param[out] DevicePath The device path of the underlying ATA = host > controller. > + This field re-uses EFI Device Path Pro= tocol as > + defined by Section 10.2 EFI Device Pat= h Protocol > + of UEFI 2.7 Specification. > + > + @retval EFI_SUCCESS The device path of the ATA host contr= oller has > + been successfully returned. > + @retval EFI_INVALID_PARAMETER DevicePathLength or DevicePath is > NULL. > + @retval EFI_OUT_OF_RESOURCES Not enough resource to return the > device path. > + > +**/ > +typedef > +EFI_STATUS > +(EFIAPI *EDKII_PEI_ATA_PASS_THRU_GET_DEVICE_PATH) ( > + IN EDKII_PEI_ATA_PASS_THRU_PPI *This, > + OUT UINTN *DevicePathLength, > + OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath > + ); > + > +// > +// EDKII_PEI_ATA_PASS_THRU_PPI provides the services that are required > +to send // ATA commands to an ATA device during PEI. > +// > +struct _EDKII_PEI_ATA_PASS_THRU_PPI { > + UINT64 Revision; > + EFI_ATA_PASS_THRU_MODE *Mode; > + EDKII_PEI_ATA_PASS_THRU_PASSTHRU PassThru; > + EDKII_PEI_ATA_PASS_THRU_THRU_GET_NEXT_PORT GetNextPort; > + EDKII_PEI_ATA_PASS_THRU_GET_NEXT_DEVICE GetNextDevice; > + EDKII_PEI_ATA_PASS_THRU_GET_DEVICE_PATH GetDevicePath; > +}; > + > +extern EFI_GUID gEdkiiPeiAtaPassThruPpiGuid; > + > +#endif > -- > 2.12.0.windows.1