[edk2,v3,1/5] MdeModulePkg: introduce non-discoverable device protocol

Message ID 1479315571-14953-2-git-send-email-ard.biesheuvel@linaro.org
State New
Headers show

Commit Message

Ard Biesheuvel Nov. 16, 2016, 4:59 p.m.
Introduce a protocol that can be exposed by a platform for devices that
are not discoverable, usually because they are wired straight to the
memory bus rather than to an enumerable bus like PCI or USB.

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

---
 MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90 ++++++++++++++++++++
 MdeModulePkg/MdeModulePkg.dec                         |  3 +
 2 files changed, 93 insertions(+)

-- 
2.7.4

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Comments

Leif Lindholm Nov. 16, 2016, 5:48 p.m. | #1
On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:
> Introduce a protocol that can be exposed by a platform for devices that

> are not discoverable, usually because they are wired straight to the

> memory bus rather than to an enumerable bus like PCI or USB.

> 

> Contributed-under: TianoCore Contribution Agreement 1.0

> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

> ---

>  MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90 ++++++++++++++++++++

>  MdeModulePkg/MdeModulePkg.dec                         |  3 +

>  2 files changed, 93 insertions(+)

> 

> diff --git a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

> new file mode 100644

> index 000000000000..47ed841b407b

> --- /dev/null

> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

> @@ -0,0 +1,90 @@

> +/** @file

> +  Protocol to describe devices that are not on a discoverable bus

> +

> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

> +

> +  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 __NON_DISCOVERABLE_DEVICE_H__

> +#define __NON_DISCOVERABLE_DEVICE_H__

> +

> +#include <IndustryStandard/Acpi.h>

> +

> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d, 0x51, 0x4a } }

> +

> +//

> +// Protocol interface structure

> +//

> +typedef struct _NON_DISCOVERABLE_DEVICE NON_DISCOVERABLE_DEVICE;

> +

> +//

> +// Data Types

> +//

> +typedef enum {

> +  NonDiscoverableDeviceTypeAmba,

> +  NonDiscoverableDeviceTypeOhci,

> +  NonDiscoverableDeviceTypeUhci,

> +  NonDiscoverableDeviceTypeEhci,

> +  NonDiscoverableDeviceTypeXhci,

> +  NonDiscoverableDeviceTypeAhci,

> +  NonDiscoverableDeviceTypeSdhci,

> +  NonDiscoverableDeviceTypeUfs,

> +  NonDiscoverableDeviceTypeNvme,


Just one OCD comment/question left:
Can we keep these sorted alphabetically?
(Also in switch statements in later patches?)

Other than that, I'm (very) happy with this series.

/
    Leif

> +  NonDiscoverableDeviceTypeMax,

> +} NON_DISCOVERABLE_DEVICE_TYPE;

> +

> +typedef enum {

> +  NonDiscoverableDeviceDmaTypeCoherent,

> +  NonDiscoverableDeviceDmaTypeNonCoherent,

> +  NonDiscoverableDeviceDmaTypeMax,

> +} NON_DISCOVERABLE_DEVICE_DMA_TYPE;

> +

> +//

> +// Function Prototypes

> +//

> +

> +/**

> +  Perform device specific initialization before the device is started

> +

> +  @param  This          The non-discoverable device protocol pointer

> +

> +  @retval EFI_SUCCESS   Initialization successful, the device may be used

> +  @retval Other         Initialization failed, device should not be started

> +**/

> +typedef

> +EFI_STATUS

> +(EFIAPI *NON_DISCOVERABLE_DEVICE_INIT) (

> +  IN  NON_DISCOVERABLE_DEVICE       *This

> +  );

> +

> +struct _NON_DISCOVERABLE_DEVICE {

> +  //

> +  // The type of device

> +  //

> +  NON_DISCOVERABLE_DEVICE_TYPE        Type;

> +  //

> +  // Whether this device is DMA coherent

> +  //

> +  NON_DISCOVERABLE_DEVICE_DMA_TYPE    DmaType;

> +  //

> +  // Initialization function for the device

> +  //

> +  NON_DISCOVERABLE_DEVICE_INIT        Initialize;

> +  //

> +  // The MMIO and I/O regions owned by the device

> +  //

> +  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR   *Resources;

> +};

> +

> +extern EFI_GUID gEdkiiNonDiscoverableDeviceProtocolGuid;

> +

> +#endif

> diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec

> index 74b870051c67..6b956fc80c93 100644

> --- a/MdeModulePkg/MdeModulePkg.dec

> +++ b/MdeModulePkg/MdeModulePkg.dec

> @@ -505,6 +505,9 @@ [Protocols]

>    #  Include/Protocol/Ps2Policy.h

>    gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE, 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 } }

>  

> +  ## Include/Protocol/NonDiscoverableDevice.h

> +  gEdkiiNonDiscoverableDeviceProtocolGuid = { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d, 0x51, 0x4a } }

> +

>  #

>  # [Error.gEfiMdeModulePkgTokenSpaceGuid]

>  #   0x80000001 | Invalid value provided.

> -- 

> 2.7.4

> 

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ni, Ruiyu Nov. 17, 2016, 2:53 a.m. | #2
Ard,
I have two comments in below.

Thanks/Ray

> -----Original Message-----

> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of

> Leif Lindholm

> Sent: Thursday, November 17, 2016 1:49 AM

> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org;

> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney, Michael D

> <michael.d.kinney@intel.com>

> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

> discoverable device protocol

> 

> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

> > Introduce a protocol that can be exposed by a platform for devices

> > that are not discoverable, usually because they are wired straight to

> > the memory bus rather than to an enumerable bus like PCI or USB.

> >

> > Contributed-under: TianoCore Contribution Agreement 1.0

> > Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

> > ---

> >  MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

> ++++++++++++++++++++

> >  MdeModulePkg/MdeModulePkg.dec                         |  3 +

> >  2 files changed, 93 insertions(+)

> >

> > diff --git a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

> > b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

> > new file mode 100644

> > index 000000000000..47ed841b407b

> > --- /dev/null

> > +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

> > @@ -0,0 +1,90 @@

> > +/** @file

> > +  Protocol to describe devices that are not on a discoverable bus

> > +

> > +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

> > +

> > +  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 __NON_DISCOVERABLE_DEVICE_H__ #define

> > +__NON_DISCOVERABLE_DEVICE_H__

> > +

> > +#include <IndustryStandard/Acpi.h>

> > +

> > +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

> > +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d,

> > +0x51, 0x4a } }


1. Can you add "PCI" keyword into the protocol name?
e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

> > +

> > +//

> > +// Protocol interface structure

> > +//

> > +typedef struct _NON_DISCOVERABLE_DEVICE

> NON_DISCOVERABLE_DEVICE;

> > +

> > +//

> > +// Data Types

> > +//

> > +typedef enum {

> > +  NonDiscoverableDeviceTypeAmba,

> > +  NonDiscoverableDeviceTypeOhci,

> > +  NonDiscoverableDeviceTypeUhci,

> > +  NonDiscoverableDeviceTypeEhci,

> > +  NonDiscoverableDeviceTypeXhci,

> > +  NonDiscoverableDeviceTypeAhci,

> > +  NonDiscoverableDeviceTypeSdhci,

> > +  NonDiscoverableDeviceTypeUfs,

> > +  NonDiscoverableDeviceTypeNvme,



> 

> Just one OCD comment/question left:

> Can we keep these sorted alphabetically?

> (Also in switch statements in later patches?)

> 

> Other than that, I'm (very) happy with this series.

> 

> /

>     Leif

> 

> > +  NonDiscoverableDeviceTypeMax,

> > +} NON_DISCOVERABLE_DEVICE_TYPE;

> > +

> > +typedef enum {

> > +  NonDiscoverableDeviceDmaTypeCoherent,

> > +  NonDiscoverableDeviceDmaTypeNonCoherent,

> > +  NonDiscoverableDeviceDmaTypeMax,

> > +} NON_DISCOVERABLE_DEVICE_DMA_TYPE;

> > +

> > +//

> > +// Function Prototypes

> > +//

> > +

> > +/**

> > +  Perform device specific initialization before the device is started

> > +

> > +  @param  This          The non-discoverable device protocol pointer

> > +

> > +  @retval EFI_SUCCESS   Initialization successful, the device may be used

> > +  @retval Other         Initialization failed, device should not be started

> > +**/

> > +typedef

> > +EFI_STATUS

> > +(EFIAPI *NON_DISCOVERABLE_DEVICE_INIT) (

> > +  IN  NON_DISCOVERABLE_DEVICE       *This

> > +  );

> > +

> > +struct _NON_DISCOVERABLE_DEVICE {

> > +  //

> > +  // The type of device

> > +  //

> > +  NON_DISCOVERABLE_DEVICE_TYPE        Type;

2. Can you use PCI class code to replace the enum type here?
e.g.: UINT8 Class; UINT8 SubClass; UINT8 Programming Interface;
The enum type can be defined in the helper library.
In this way, we make the protocol definition stable enough.

> > +  //

> > +  // Whether this device is DMA coherent

> > +  //

> > +  NON_DISCOVERABLE_DEVICE_DMA_TYPE    DmaType;

> > +  //

> > +  // Initialization function for the device

> > +  //

> > +  NON_DISCOVERABLE_DEVICE_INIT        Initialize;

> > +  //

> > +  // The MMIO and I/O regions owned by the device

> > +  //

> > +  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR   *Resources;

> > +};

> > +

> > +extern EFI_GUID gEdkiiNonDiscoverableDeviceProtocolGuid;

> > +

> > +#endif

> > diff --git a/MdeModulePkg/MdeModulePkg.dec

> > b/MdeModulePkg/MdeModulePkg.dec index 74b870051c67..6b956fc80c93

> > 100644

> > --- a/MdeModulePkg/MdeModulePkg.dec

> > +++ b/MdeModulePkg/MdeModulePkg.dec

> > @@ -505,6 +505,9 @@ [Protocols]

> >    #  Include/Protocol/Ps2Policy.h

> >    gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE,

> > 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 } }

> >

> > +  ## Include/Protocol/NonDiscoverableDevice.h

> > +  gEdkiiNonDiscoverableDeviceProtocolGuid = { 0x0d51905b, 0xb77e,

> > + 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d, 0x51, 0x4a } }

> > +

> >  #

> >  # [Error.gEfiMdeModulePkgTokenSpaceGuid]

> >  #   0x80000001 | Invalid value provided.

> > --

> > 2.7.4

> >

> _______________________________________________

> edk2-devel mailing list

> edk2-devel@lists.01.org

> https://lists.01.org/mailman/listinfo/edk2-devel

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Nov. 17, 2016, 6:07 a.m. | #3
> On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

> 

> Ard,

> I have two comments in below.

> 

> Thanks/Ray

> 

>> -----Original Message-----

>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of

>> Leif Lindholm

>> Sent: Thursday, November 17, 2016 1:49 AM

>> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org;

>> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney, Michael D

>> <michael.d.kinney@intel.com>

>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>> discoverable device protocol

>> 

>>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

>>> Introduce a protocol that can be exposed by a platform for devices

>>> that are not discoverable, usually because they are wired straight to

>>> the memory bus rather than to an enumerable bus like PCI or USB.

>>> 

>>> Contributed-under: TianoCore Contribution Agreement 1.0

>>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>> ---

>>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

>> ++++++++++++++++++++

>>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

>>> 2 files changed, 93 insertions(+)

>>> 

>>> diff --git a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>> new file mode 100644

>>> index 000000000000..47ed841b407b

>>> --- /dev/null

>>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>> @@ -0,0 +1,90 @@

>>> +/** @file

>>> +  Protocol to describe devices that are not on a discoverable bus

>>> +

>>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

>>> +

>>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define

>>> +__NON_DISCOVERABLE_DEVICE_H__

>>> +

>>> +#include <IndustryStandard/Acpi.h>

>>> +

>>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

>>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d,

>>> +0x51, 0x4a } }

> 

> 1. Can you add "PCI" keyword into the protocol name?

> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

> 


No. This protocol does not describe pci devices, and it is a peculiarity of the edk2 driver stack that some non-pci devices can only be driven by pci drivers.

in other words, pci is part of the /driver/ side, and it is perfectly possible for, e.g., a non-discoverable ahci device to be driven by a different non-pci driver in the future.

>>> +

>>> +//

>>> +// Protocol interface structure

>>> +//

>>> +typedef struct _NON_DISCOVERABLE_DEVICE

>> NON_DISCOVERABLE_DEVICE;

>>> +

>>> +//

>>> +// Data Types

>>> +//

>>> +typedef enum {

>>> +  NonDiscoverableDeviceTypeAmba,

>>> +  NonDiscoverableDeviceTypeOhci,

>>> +  NonDiscoverableDeviceTypeUhci,

>>> +  NonDiscoverableDeviceTypeEhci,

>>> +  NonDiscoverableDeviceTypeXhci,

>>> +  NonDiscoverableDeviceTypeAhci,

>>> +  NonDiscoverableDeviceTypeSdhci,

>>> +  NonDiscoverableDeviceTypeUfs,

>>> +  NonDiscoverableDeviceTypeNvme,

> 

> 

>> 

>> Just one OCD comment/question left:

>> Can we keep these sorted alphabetically?

>> (Also in switch statements in later patches?)

>> 

>> Other than that, I'm (very) happy with this series.

>> 

>> /

>>    Leif

>> 

>>> +  NonDiscoverableDeviceTypeMax,

>>> +} NON_DISCOVERABLE_DEVICE_TYPE;

>>> +

>>> +typedef enum {

>>> +  NonDiscoverableDeviceDmaTypeCoherent,

>>> +  NonDiscoverableDeviceDmaTypeNonCoherent,

>>> +  NonDiscoverableDeviceDmaTypeMax,

>>> +} NON_DISCOVERABLE_DEVICE_DMA_TYPE;

>>> +

>>> +//

>>> +// Function Prototypes

>>> +//

>>> +

>>> +/**

>>> +  Perform device specific initialization before the device is started

>>> +

>>> +  @param  This          The non-discoverable device protocol pointer

>>> +

>>> +  @retval EFI_SUCCESS   Initialization successful, the device may be used

>>> +  @retval Other         Initialization failed, device should not be started

>>> +**/

>>> +typedef

>>> +EFI_STATUS

>>> +(EFIAPI *NON_DISCOVERABLE_DEVICE_INIT) (

>>> +  IN  NON_DISCOVERABLE_DEVICE       *This

>>> +  );

>>> +

>>> +struct _NON_DISCOVERABLE_DEVICE {

>>> +  //

>>> +  // The type of device

>>> +  //

>>> +  NON_DISCOVERABLE_DEVICE_TYPE        Type;

> 2. Can you use PCI class code to replace the enum type here?

> e.g.: UINT8 Class; UINT8 SubClass; UINT8 Programming Interface;

> The enum type can be defined in the helper library.

> In this way, we make the protocol definition stable enough.

> 


Again, i think this is a bad idea. This is meant to describe the /device/, not the edk2 implementation detail that some standardized host controller interfaces were implemented in a way that requires pci. It would also make it impossible to describe AMBA devices

>>> +  //

>>> +  // Whether this device is DMA coherent

>>> +  //

>>> +  NON_DISCOVERABLE_DEVICE_DMA_TYPE    DmaType;

>>> +  //

>>> +  // Initialization function for the device

>>> +  //

>>> +  NON_DISCOVERABLE_DEVICE_INIT        Initialize;

>>> +  //

>>> +  // The MMIO and I/O regions owned by the device

>>> +  //

>>> +  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR   *Resources;

>>> +};

>>> +

>>> +extern EFI_GUID gEdkiiNonDiscoverableDeviceProtocolGuid;

>>> +

>>> +#endif

>>> diff --git a/MdeModulePkg/MdeModulePkg.dec

>>> b/MdeModulePkg/MdeModulePkg.dec index 74b870051c67..6b956fc80c93

>>> 100644

>>> --- a/MdeModulePkg/MdeModulePkg.dec

>>> +++ b/MdeModulePkg/MdeModulePkg.dec

>>> @@ -505,6 +505,9 @@ [Protocols]

>>>   #  Include/Protocol/Ps2Policy.h

>>>   gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE,

>>> 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 } }

>>> 

>>> +  ## Include/Protocol/NonDiscoverableDevice.h

>>> +  gEdkiiNonDiscoverableDeviceProtocolGuid = { 0x0d51905b, 0xb77e,

>>> + 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d, 0x51, 0x4a } }

>>> +

>>> #

>>> # [Error.gEfiMdeModulePkgTokenSpaceGuid]

>>> #   0x80000001 | Invalid value provided.

>>> --

>>> 2.7.4

>>> 

>> _______________________________________________

>> edk2-devel mailing list

>> edk2-devel@lists.01.org

>> https://lists.01.org/mailman/listinfo/edk2-devel

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ni, Ruiyu Nov. 17, 2016, 7:52 a.m. | #4
Thanks/Ray

> -----Original Message-----

> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of

> Ard Biesheuvel

> Sent: Thursday, November 17, 2016 2:07 PM

> To: Ni, Ruiyu <ruiyu.ni@intel.com>

> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-

> devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; afish@apple.com;

> Leif Lindholm <leif.lindholm@linaro.org>

> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

> discoverable device protocol

> 

> 

> 

> > On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

> >

> > Ard,

> > I have two comments in below.

> >

> > Thanks/Ray

> >

> >> -----Original Message-----

> >> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf

> >> Of Leif Lindholm

> >> Sent: Thursday, November 17, 2016 1:49 AM

> >> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

> >> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org;

> >> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney, Michael

> >> D <michael.d.kinney@intel.com>

> >> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

> >> discoverable device protocol

> >>

> >>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

> >>> Introduce a protocol that can be exposed by a platform for devices

> >>> that are not discoverable, usually because they are wired straight

> >>> to the memory bus rather than to an enumerable bus like PCI or USB.

> >>>

> >>> Contributed-under: TianoCore Contribution Agreement 1.0

> >>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

> >>> ---

> >>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

> >> ++++++++++++++++++++

> >>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

> >>> 2 files changed, 93 insertions(+)

> >>>

> >>> diff --git a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

> >>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

> >>> new file mode 100644

> >>> index 000000000000..47ed841b407b

> >>> --- /dev/null

> >>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

> >>> @@ -0,0 +1,90 @@

> >>> +/** @file

> >>> +  Protocol to describe devices that are not on a discoverable bus

> >>> +

> >>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

> >>> +

> >>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define

> >>> +__NON_DISCOVERABLE_DEVICE_H__

> >>> +

> >>> +#include <IndustryStandard/Acpi.h>

> >>> +

> >>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

> >>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc,

> >>> +0x8d, 0x51, 0x4a } }

> >

> > 1. Can you add "PCI" keyword into the protocol name?

> > e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

> >

> 

> No. This protocol does not describe pci devices, and it is a peculiarity of the

> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

> 

> in other words, pci is part of the /driver/ side, and it is perfectly possible for,

> e.g., a non-discoverable ahci device to be driven by a different non-pci driver

> in the future.

> 


I see. So some types of devices are handled by the current
NonDiscoveablePciDevice driver, and some other types of devices may be
handled by a future NonDiscoverableXXXDevice driver.
Now since the AHCI type is already handled by the NonDiscoverablePciDevice
driver, when there is a new NonDiscoverableXXXDevice driver, how can the two
know whether it should manage the AHCI type device or not?
Besides since now all the EDKII Host Controller drivers are based on
PciIo, it implicitly requires all the low layer needs to produce PciIo interface
in order to re-use the EDKII Host Controller drivers.

> >>> +

> >>> +//

> >>> +// Protocol interface structure

> >>> +//

> >>> +typedef struct _NON_DISCOVERABLE_DEVICE

> >> NON_DISCOVERABLE_DEVICE;

> >>> +

> >>> +//

> >>> +// Data Types

> >>> +//

> >>> +typedef enum {

> >>> +  NonDiscoverableDeviceTypeAmba,

> >>> +  NonDiscoverableDeviceTypeOhci,

> >>> +  NonDiscoverableDeviceTypeUhci,

> >>> +  NonDiscoverableDeviceTypeEhci,

> >>> +  NonDiscoverableDeviceTypeXhci,

> >>> +  NonDiscoverableDeviceTypeAhci,

> >>> +  NonDiscoverableDeviceTypeSdhci,

> >>> +  NonDiscoverableDeviceTypeUfs,

> >>> +  NonDiscoverableDeviceTypeNvme,

> >

> >

> >>

> >> Just one OCD comment/question left:

> >> Can we keep these sorted alphabetically?

> >> (Also in switch statements in later patches?)

> >>

> >> Other than that, I'm (very) happy with this series.

> >>

> >> /

> >>    Leif

> >>

> >>> +  NonDiscoverableDeviceTypeMax,

> >>> +} NON_DISCOVERABLE_DEVICE_TYPE;

> >>> +

> >>> +typedef enum {

> >>> +  NonDiscoverableDeviceDmaTypeCoherent,

> >>> +  NonDiscoverableDeviceDmaTypeNonCoherent,

> >>> +  NonDiscoverableDeviceDmaTypeMax,

> >>> +} NON_DISCOVERABLE_DEVICE_DMA_TYPE;

> >>> +

> >>> +//

> >>> +// Function Prototypes

> >>> +//

> >>> +

> >>> +/**

> >>> +  Perform device specific initialization before the device is

> >>> +started

> >>> +

> >>> +  @param  This          The non-discoverable device protocol pointer

> >>> +

> >>> +  @retval EFI_SUCCESS   Initialization successful, the device may be

> used

> >>> +  @retval Other         Initialization failed, device should not be started

> >>> +**/

> >>> +typedef

> >>> +EFI_STATUS

> >>> +(EFIAPI *NON_DISCOVERABLE_DEVICE_INIT) (

> >>> +  IN  NON_DISCOVERABLE_DEVICE       *This

> >>> +  );

> >>> +

> >>> +struct _NON_DISCOVERABLE_DEVICE {

> >>> +  //

> >>> +  // The type of device

> >>> +  //

> >>> +  NON_DISCOVERABLE_DEVICE_TYPE        Type;

> > 2. Can you use PCI class code to replace the enum type here?

> > e.g.: UINT8 Class; UINT8 SubClass; UINT8 Programming Interface; The

> > enum type can be defined in the helper library.

> > In this way, we make the protocol definition stable enough.

> >

> 

> Again, i think this is a bad idea. This is meant to describe the /device/, not the

> edk2 implementation detail that some standardized host controller

> interfaces were implemented in a way that requires pci. It would also make it

> impossible to describe AMBA devices

Does AMBA  stand for Advanced Microcontroller Bus Architecture?
I have no idea about the AMBA.
Can you explain more why it's impossible to describe AMBA devices?

> 

> >>> +  //

> >>> +  // Whether this device is DMA coherent

> >>> +  //

> >>> +  NON_DISCOVERABLE_DEVICE_DMA_TYPE    DmaType;

> >>> +  //

> >>> +  // Initialization function for the device

> >>> +  //

> >>> +  NON_DISCOVERABLE_DEVICE_INIT        Initialize;

> >>> +  //

> >>> +  // The MMIO and I/O regions owned by the device

> >>> +  //

> >>> +  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR   *Resources;

> >>> +};

> >>> +

> >>> +extern EFI_GUID gEdkiiNonDiscoverableDeviceProtocolGuid;

> >>> +

> >>> +#endif

> >>> diff --git a/MdeModulePkg/MdeModulePkg.dec

> >>> b/MdeModulePkg/MdeModulePkg.dec index

> 74b870051c67..6b956fc80c93

> >>> 100644

> >>> --- a/MdeModulePkg/MdeModulePkg.dec

> >>> +++ b/MdeModulePkg/MdeModulePkg.dec

> >>> @@ -505,6 +505,9 @@ [Protocols]

> >>>   #  Include/Protocol/Ps2Policy.h

> >>>   gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE,

> >>> 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 } }

> >>>

> >>> +  ## Include/Protocol/NonDiscoverableDevice.h

> >>> +  gEdkiiNonDiscoverableDeviceProtocolGuid = { 0x0d51905b, 0xb77e,

> >>> + 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d, 0x51, 0x4a } }

> >>> +

> >>> #

> >>> # [Error.gEfiMdeModulePkgTokenSpaceGuid]

> >>> #   0x80000001 | Invalid value provided.

> >>> --

> >>> 2.7.4

> >>>

> >> _______________________________________________

> >> edk2-devel mailing list

> >> edk2-devel@lists.01.org

> >> https://lists.01.org/mailman/listinfo/edk2-devel

> _______________________________________________

> edk2-devel mailing list

> edk2-devel@lists.01.org

> https://lists.01.org/mailman/listinfo/edk2-devel

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Nov. 17, 2016, 10:43 a.m. | #5
> On 17 Nov 2016, at 08:52, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

> 

> 

> 

> Thanks/Ray

> 

>> -----Original Message-----

>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of

>> Ard Biesheuvel

>> Sent: Thursday, November 17, 2016 2:07 PM

>> To: Ni, Ruiyu <ruiyu.ni@intel.com>

>> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-

>> devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; afish@apple.com;

>> Leif Lindholm <leif.lindholm@linaro.org>

>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>> discoverable device protocol

>> 

>> 

>> 

>>> On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>> 

>>> Ard,

>>> I have two comments in below.

>>> 

>>> Thanks/Ray

>>> 

>>>> -----Original Message-----

>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf

>>>> Of Leif Lindholm

>>>> Sent: Thursday, November 17, 2016 1:49 AM

>>>> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org;

>>>> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney, Michael

>>>> D <michael.d.kinney@intel.com>

>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>> discoverable device protocol

>>>> 

>>>>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

>>>>> Introduce a protocol that can be exposed by a platform for devices

>>>>> that are not discoverable, usually because they are wired straight

>>>>> to the memory bus rather than to an enumerable bus like PCI or USB.

>>>>> 

>>>>> Contributed-under: TianoCore Contribution Agreement 1.0

>>>>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>> ---

>>>>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

>>>> ++++++++++++++++++++

>>>>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

>>>>> 2 files changed, 93 insertions(+)

>>>>> 

>>>>> diff --git a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>> new file mode 100644

>>>>> index 000000000000..47ed841b407b

>>>>> --- /dev/null

>>>>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>> @@ -0,0 +1,90 @@

>>>>> +/** @file

>>>>> +  Protocol to describe devices that are not on a discoverable bus

>>>>> +

>>>>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

>>>>> +

>>>>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define

>>>>> +__NON_DISCOVERABLE_DEVICE_H__

>>>>> +

>>>>> +#include <IndustryStandard/Acpi.h>

>>>>> +

>>>>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

>>>>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc,

>>>>> +0x8d, 0x51, 0x4a } }

>>> 

>>> 1. Can you add "PCI" keyword into the protocol name?

>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>> 

>> 

>> No. This protocol does not describe pci devices, and it is a peculiarity of the

>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>> 

>> in other words, pci is part of the /driver/ side, and it is perfectly possible for,

>> e.g., a non-discoverable ahci device to be driven by a different non-pci driver

>> in the future.

>> 

> 

> I see. So some types of devices are handled by the current

> NonDiscoveablePciDevice driver, and some other types of devices may be

> handled by a future NonDiscoverableXXXDevice driver.

> Now since the AHCI type is already handled by the NonDiscoverablePciDevice

> driver, when there is a new NonDiscoverableXXXDevice driver, how can the two

> know whether it should manage the AHCI type device or not?


Good question. But how does the UEFI driver model deal with that? What happens if i have two drivers that both support the Ahci Pci class codes?

> Besides since now all the EDKII Host Controller drivers are based on

> PciIo, it implicitly requires all the low layer needs to produce PciIo interface

> in order to re-use the EDKII Host Controller drivers.

> 


Yes, that is the whole point of these patches. My preferred solution would be to split the ?hci drivers from pci i/o, by introducing intermediate protocols, but we both know that is unlikely to be accepted

>>>>> +

>>>>> +//

>>>>> +// Protocol interface structure

>>>>> +//

>>>>> +typedef struct _NON_DISCOVERABLE_DEVICE

>>>> NON_DISCOVERABLE_DEVICE;

>>>>> +

>>>>> +//

>>>>> +// Data Types

>>>>> +//

>>>>> +typedef enum {

>>>>> +  NonDiscoverableDeviceTypeAmba,

>>>>> +  NonDiscoverableDeviceTypeOhci,

>>>>> +  NonDiscoverableDeviceTypeUhci,

>>>>> +  NonDiscoverableDeviceTypeEhci,

>>>>> +  NonDiscoverableDeviceTypeXhci,

>>>>> +  NonDiscoverableDeviceTypeAhci,

>>>>> +  NonDiscoverableDeviceTypeSdhci,

>>>>> +  NonDiscoverableDeviceTypeUfs,

>>>>> +  NonDiscoverableDeviceTypeNvme,

>>> 

>>> 

>>>> 

>>>> Just one OCD comment/question left:

>>>> Can we keep these sorted alphabetically?

>>>> (Also in switch statements in later patches?)

>>>> 

>>>> Other than that, I'm (very) happy with this series.

>>>> 

>>>> /

>>>>   Leif

>>>> 

>>>>> +  NonDiscoverableDeviceTypeMax,

>>>>> +} NON_DISCOVERABLE_DEVICE_TYPE;

>>>>> +

>>>>> +typedef enum {

>>>>> +  NonDiscoverableDeviceDmaTypeCoherent,

>>>>> +  NonDiscoverableDeviceDmaTypeNonCoherent,

>>>>> +  NonDiscoverableDeviceDmaTypeMax,

>>>>> +} NON_DISCOVERABLE_DEVICE_DMA_TYPE;

>>>>> +

>>>>> +//

>>>>> +// Function Prototypes

>>>>> +//

>>>>> +

>>>>> +/**

>>>>> +  Perform device specific initialization before the device is

>>>>> +started

>>>>> +

>>>>> +  @param  This          The non-discoverable device protocol pointer

>>>>> +

>>>>> +  @retval EFI_SUCCESS   Initialization successful, the device may be

>> used

>>>>> +  @retval Other         Initialization failed, device should not be started

>>>>> +**/

>>>>> +typedef

>>>>> +EFI_STATUS

>>>>> +(EFIAPI *NON_DISCOVERABLE_DEVICE_INIT) (

>>>>> +  IN  NON_DISCOVERABLE_DEVICE       *This

>>>>> +  );

>>>>> +

>>>>> +struct _NON_DISCOVERABLE_DEVICE {

>>>>> +  //

>>>>> +  // The type of device

>>>>> +  //

>>>>> +  NON_DISCOVERABLE_DEVICE_TYPE        Type;

>>> 2. Can you use PCI class code to replace the enum type here?

>>> e.g.: UINT8 Class; UINT8 SubClass; UINT8 Programming Interface; The

>>> enum type can be defined in the helper library.

>>> In this way, we make the protocol definition stable enough.

>>> 

>> 

>> Again, i think this is a bad idea. This is meant to describe the /device/, not the

>> edk2 implementation detail that some standardized host controller

>> interfaces were implemented in a way that requires pci. It would also make it

>> impossible to describe AMBA devices

> Does AMBA  stand for Advanced Microcontroller Bus Architecture?

> I have no idea about the AMBA.

> Can you explain more why it's impossible to describe AMBA devices?

> 


Amba devices are identifiable but not discoverable. If you know the base address, you know where the id registers are because they are always at the same register offset

Thanks,
Ard.

>> 

>>>>> +  //

>>>>> +  // Whether this device is DMA coherent

>>>>> +  //

>>>>> +  NON_DISCOVERABLE_DEVICE_DMA_TYPE    DmaType;

>>>>> +  //

>>>>> +  // Initialization function for the device

>>>>> +  //

>>>>> +  NON_DISCOVERABLE_DEVICE_INIT        Initialize;

>>>>> +  //

>>>>> +  // The MMIO and I/O regions owned by the device

>>>>> +  //

>>>>> +  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR   *Resources;

>>>>> +};

>>>>> +

>>>>> +extern EFI_GUID gEdkiiNonDiscoverableDeviceProtocolGuid;

>>>>> +

>>>>> +#endif

>>>>> diff --git a/MdeModulePkg/MdeModulePkg.dec

>>>>> b/MdeModulePkg/MdeModulePkg.dec index

>> 74b870051c67..6b956fc80c93

>>>>> 100644

>>>>> --- a/MdeModulePkg/MdeModulePkg.dec

>>>>> +++ b/MdeModulePkg/MdeModulePkg.dec

>>>>> @@ -505,6 +505,9 @@ [Protocols]

>>>>>  #  Include/Protocol/Ps2Policy.h

>>>>>  gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE,

>>>>> 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 } }

>>>>> 

>>>>> +  ## Include/Protocol/NonDiscoverableDevice.h

>>>>> +  gEdkiiNonDiscoverableDeviceProtocolGuid = { 0x0d51905b, 0xb77e,

>>>>> + 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d, 0x51, 0x4a } }

>>>>> +

>>>>> #

>>>>> # [Error.gEfiMdeModulePkgTokenSpaceGuid]

>>>>> #   0x80000001 | Invalid value provided.

>>>>> --

>>>>> 2.7.4

>>>>> 

>>>> _______________________________________________

>>>> edk2-devel mailing list

>>>> edk2-devel@lists.01.org

>>>> https://lists.01.org/mailman/listinfo/edk2-devel

>> _______________________________________________

>> edk2-devel mailing list

>> edk2-devel@lists.01.org

>> https://lists.01.org/mailman/listinfo/edk2-devel

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ni, Ruiyu Nov. 18, 2016, 2:11 a.m. | #6
Regards,
Ray

>-----Original Message-----

>From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org]

>Sent: Thursday, November 17, 2016 6:43 PM

>To: Ni, Ruiyu <ruiyu.ni@intel.com>

>Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-discoverable device protocol

>

>

>> On 17 Nov 2016, at 08:52, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>

>>

>>

>> Thanks/Ray

>>

>>> -----Original Message-----

>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of

>>> Ard Biesheuvel

>>> Sent: Thursday, November 17, 2016 2:07 PM

>>> To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-

>>> devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; afish@apple.com;

>>> Leif Lindholm <leif.lindholm@linaro.org>

>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>> discoverable device protocol

>>>

>>>

>>>

>>>> On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>

>>>> Ard,

>>>> I have two comments in below.

>>>>

>>>> Thanks/Ray

>>>>

>>>>> -----Original Message-----

>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf

>>>>> Of Leif Lindholm

>>>>> Sent: Thursday, November 17, 2016 1:49 AM

>>>>> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org;

>>>>> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney, Michael

>>>>> D <michael.d.kinney@intel.com>

>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>>> discoverable device protocol

>>>>>

>>>>>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

>>>>>> Introduce a protocol that can be exposed by a platform for devices

>>>>>> that are not discoverable, usually because they are wired straight

>>>>>> to the memory bus rather than to an enumerable bus like PCI or USB.

>>>>>>

>>>>>> Contributed-under: TianoCore Contribution Agreement 1.0

>>>>>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>> ---

>>>>>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

>>>>> ++++++++++++++++++++

>>>>>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

>>>>>> 2 files changed, 93 insertions(+)

>>>>>>

>>>>>> diff --git a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>> new file mode 100644

>>>>>> index 000000000000..47ed841b407b

>>>>>> --- /dev/null

>>>>>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>> @@ -0,0 +1,90 @@

>>>>>> +/** @file

>>>>>> +  Protocol to describe devices that are not on a discoverable bus

>>>>>> +

>>>>>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

>>>>>> +

>>>>>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define

>>>>>> +__NON_DISCOVERABLE_DEVICE_H__

>>>>>> +

>>>>>> +#include <IndustryStandard/Acpi.h>

>>>>>> +

>>>>>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

>>>>>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc,

>>>>>> +0x8d, 0x51, 0x4a } }

>>>>

>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>

>>>

>>> No. This protocol does not describe pci devices, and it is a peculiarity of the

>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>

>>> in other words, pci is part of the /driver/ side, and it is perfectly possible for,

>>> e.g., a non-discoverable ahci device to be driven by a different non-pci driver

>>> in the future.

>>>

>>

>> I see. So some types of devices are handled by the current

>> NonDiscoveablePciDevice driver, and some other types of devices may be

>> handled by a future NonDiscoverableXXXDevice driver.

>> Now since the AHCI type is already handled by the NonDiscoverablePciDevice

>> driver, when there is a new NonDiscoverableXXXDevice driver, how can the two

>> know whether it should manage the AHCI type device or not?

>

>Good question. But how does the UEFI driver model deal with that? What happens if i have two drivers that both support the

>Ahci Pci class codes?

PCI CFG header contains VendorID/DeviceID fields which can be used to distinguish
them.

>

>> Besides since now all the EDKII Host Controller drivers are based on

>> PciIo, it implicitly requires all the low layer needs to produce PciIo interface

>> in order to re-use the EDKII Host Controller drivers.

>>

>

>Yes, that is the whole point of these patches. My preferred solution would be to split the ?hci drivers from pci i/o, by

>introducing intermediate protocols, but we both know that is unlikely to be accepted

>

>>>>>> +

>>>>>> +//

>>>>>> +// Protocol interface structure

>>>>>> +//

>>>>>> +typedef struct _NON_DISCOVERABLE_DEVICE

>>>>> NON_DISCOVERABLE_DEVICE;

>>>>>> +

>>>>>> +//

>>>>>> +// Data Types

>>>>>> +//

>>>>>> +typedef enum {

>>>>>> +  NonDiscoverableDeviceTypeAmba,

>>>>>> +  NonDiscoverableDeviceTypeOhci,

>>>>>> +  NonDiscoverableDeviceTypeUhci,

>>>>>> +  NonDiscoverableDeviceTypeEhci,

>>>>>> +  NonDiscoverableDeviceTypeXhci,

>>>>>> +  NonDiscoverableDeviceTypeAhci,

>>>>>> +  NonDiscoverableDeviceTypeSdhci,

>>>>>> +  NonDiscoverableDeviceTypeUfs,

>>>>>> +  NonDiscoverableDeviceTypeNvme,

>>>>

>>>>

>>>>>

>>>>> Just one OCD comment/question left:

>>>>> Can we keep these sorted alphabetically?

>>>>> (Also in switch statements in later patches?)

>>>>>

>>>>> Other than that, I'm (very) happy with this series.

>>>>>

>>>>> /

>>>>>   Leif

>>>>>

>>>>>> +  NonDiscoverableDeviceTypeMax,

>>>>>> +} NON_DISCOVERABLE_DEVICE_TYPE;

>>>>>> +

>>>>>> +typedef enum {

>>>>>> +  NonDiscoverableDeviceDmaTypeCoherent,

>>>>>> +  NonDiscoverableDeviceDmaTypeNonCoherent,

>>>>>> +  NonDiscoverableDeviceDmaTypeMax,

>>>>>> +} NON_DISCOVERABLE_DEVICE_DMA_TYPE;

>>>>>> +

>>>>>> +//

>>>>>> +// Function Prototypes

>>>>>> +//

>>>>>> +

>>>>>> +/**

>>>>>> +  Perform device specific initialization before the device is

>>>>>> +started

>>>>>> +

>>>>>> +  @param  This          The non-discoverable device protocol pointer

>>>>>> +

>>>>>> +  @retval EFI_SUCCESS   Initialization successful, the device may be

>>> used

>>>>>> +  @retval Other         Initialization failed, device should not be started

>>>>>> +**/

>>>>>> +typedef

>>>>>> +EFI_STATUS

>>>>>> +(EFIAPI *NON_DISCOVERABLE_DEVICE_INIT) (

>>>>>> +  IN  NON_DISCOVERABLE_DEVICE       *This

>>>>>> +  );

>>>>>> +

>>>>>> +struct _NON_DISCOVERABLE_DEVICE {

>>>>>> +  //

>>>>>> +  // The type of device

>>>>>> +  //

>>>>>> +  NON_DISCOVERABLE_DEVICE_TYPE        Type;

>>>> 2. Can you use PCI class code to replace the enum type here?

>>>> e.g.: UINT8 Class; UINT8 SubClass; UINT8 Programming Interface; The

>>>> enum type can be defined in the helper library.

>>>> In this way, we make the protocol definition stable enough.

>>>>

>>>

>>> Again, i think this is a bad idea. This is meant to describe the /device/, not the

>>> edk2 implementation detail that some standardized host controller

>>> interfaces were implemented in a way that requires pci. It would also make it

>>> impossible to describe AMBA devices

>> Does AMBA  stand for Advanced Microcontroller Bus Architecture?

>> I have no idea about the AMBA.

>> Can you explain more why it's impossible to describe AMBA devices?

>>

>

>Amba devices are identifiable but not discoverable. If you know the base address, you know where the id registers are

>because they are always at the same register offset

>

>Thanks,

>Ard.

>

>>>

>>>>>> +  //

>>>>>> +  // Whether this device is DMA coherent

>>>>>> +  //

>>>>>> +  NON_DISCOVERABLE_DEVICE_DMA_TYPE    DmaType;

>>>>>> +  //

>>>>>> +  // Initialization function for the device

>>>>>> +  //

>>>>>> +  NON_DISCOVERABLE_DEVICE_INIT        Initialize;

>>>>>> +  //

>>>>>> +  // The MMIO and I/O regions owned by the device

>>>>>> +  //

>>>>>> +  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR   *Resources;

>>>>>> +};

>>>>>> +

>>>>>> +extern EFI_GUID gEdkiiNonDiscoverableDeviceProtocolGuid;

>>>>>> +

>>>>>> +#endif

>>>>>> diff --git a/MdeModulePkg/MdeModulePkg.dec

>>>>>> b/MdeModulePkg/MdeModulePkg.dec index

>>> 74b870051c67..6b956fc80c93

>>>>>> 100644

>>>>>> --- a/MdeModulePkg/MdeModulePkg.dec

>>>>>> +++ b/MdeModulePkg/MdeModulePkg.dec

>>>>>> @@ -505,6 +505,9 @@ [Protocols]

>>>>>>  #  Include/Protocol/Ps2Policy.h

>>>>>>  gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE,

>>>>>> 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 } }

>>>>>>

>>>>>> +  ## Include/Protocol/NonDiscoverableDevice.h

>>>>>> +  gEdkiiNonDiscoverableDeviceProtocolGuid = { 0x0d51905b, 0xb77e,

>>>>>> + 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d, 0x51, 0x4a } }

>>>>>> +

>>>>>> #

>>>>>> # [Error.gEfiMdeModulePkgTokenSpaceGuid]

>>>>>> #   0x80000001 | Invalid value provided.

>>>>>> --

>>>>>> 2.7.4

>>>>>>

>>>>> _______________________________________________

>>>>> edk2-devel mailing list

>>>>> edk2-devel@lists.01.org

>>>>> https://lists.01.org/mailman/listinfo/edk2-devel

>>> _______________________________________________

>>> edk2-devel mailing list

>>> edk2-devel@lists.01.org

>>> https://lists.01.org/mailman/listinfo/edk2-devel

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Nov. 18, 2016, 4:59 a.m. | #7
On 18 November 2016 at 02:11, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:
>

>

> Regards,

> Ray

>

>>-----Original Message-----

>>From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org]

>>Sent: Thursday, November 17, 2016 6:43 PM

>>To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>>afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-discoverable device protocol

>>

>>

>>> On 17 Nov 2016, at 08:52, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>

>>>

>>>

>>> Thanks/Ray

>>>

>>>> -----Original Message-----

>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of

>>>> Ard Biesheuvel

>>>> Sent: Thursday, November 17, 2016 2:07 PM

>>>> To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-

>>>> devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; afish@apple.com;

>>>> Leif Lindholm <leif.lindholm@linaro.org>

>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>> discoverable device protocol

>>>>

>>>>

>>>>

>>>>> On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>>

>>>>> Ard,

>>>>> I have two comments in below.

>>>>>

>>>>> Thanks/Ray

>>>>>

>>>>>> -----Original Message-----

>>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf

>>>>>> Of Leif Lindholm

>>>>>> Sent: Thursday, November 17, 2016 1:49 AM

>>>>>> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org;

>>>>>> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney, Michael

>>>>>> D <michael.d.kinney@intel.com>

>>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>>>> discoverable device protocol

>>>>>>

>>>>>>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

>>>>>>> Introduce a protocol that can be exposed by a platform for devices

>>>>>>> that are not discoverable, usually because they are wired straight

>>>>>>> to the memory bus rather than to an enumerable bus like PCI or USB.

>>>>>>>

>>>>>>> Contributed-under: TianoCore Contribution Agreement 1.0

>>>>>>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>> ---

>>>>>>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

>>>>>> ++++++++++++++++++++

>>>>>>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

>>>>>>> 2 files changed, 93 insertions(+)

>>>>>>>

>>>>>>> diff --git a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>> new file mode 100644

>>>>>>> index 000000000000..47ed841b407b

>>>>>>> --- /dev/null

>>>>>>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>> @@ -0,0 +1,90 @@

>>>>>>> +/** @file

>>>>>>> +  Protocol to describe devices that are not on a discoverable bus

>>>>>>> +

>>>>>>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

>>>>>>> +

>>>>>>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define

>>>>>>> +__NON_DISCOVERABLE_DEVICE_H__

>>>>>>> +

>>>>>>> +#include <IndustryStandard/Acpi.h>

>>>>>>> +

>>>>>>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

>>>>>>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc,

>>>>>>> +0x8d, 0x51, 0x4a } }

>>>>>

>>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>>

>>>>

>>>> No. This protocol does not describe pci devices, and it is a peculiarity of the

>>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>>

>>>> in other words, pci is part of the /driver/ side, and it is perfectly possible for,

>>>> e.g., a non-discoverable ahci device to be driven by a different non-pci driver

>>>> in the future.

>>>>

>>>

>>> I see. So some types of devices are handled by the current

>>> NonDiscoveablePciDevice driver, and some other types of devices may be

>>> handled by a future NonDiscoverableXXXDevice driver.

>>> Now since the AHCI type is already handled by the NonDiscoverablePciDevice

>>> driver, when there is a new NonDiscoverableXXXDevice driver, how can the two

>>> know whether it should manage the AHCI type device or not?

>>

>>Good question. But how does the UEFI driver model deal with that? What happens if i have two drivers that both support the

>>Ahci Pci class codes?

> PCI CFG header contains VendorID/DeviceID fields which can be used to distinguish

> them.

>


No, that is not what I mean.

Your question is how we should deal with multiple drivers that
support, for instance, the AHCI non-discoverable device type. My
answer is that this is not any different from a platform configuration
that has more than one PCI I/O based driver that supports the AHCI PCI
class codes. The UEFI driver model has priority rules and protocols to
decide which driver gets precedence. I don't see how it should be any
different here.

Thanks,
Ard.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Tian, Feng Nov. 18, 2016, 5:24 a.m. | #8
Ard,

I have another question.

Is it the only way to specify device type in below enum? Looks like it will be changed often. Is it possible to make use of DevicePath node? Of course, I have no good idea to handle AMBA controller...

+//
+// Data Types
+//
+typedef enum {
+  NonDiscoverableDeviceTypeAmba,
+  NonDiscoverableDeviceTypeOhci,
+  NonDiscoverableDeviceTypeUhci,
+  NonDiscoverableDeviceTypeEhci,
+  NonDiscoverableDeviceTypeXhci,
+  NonDiscoverableDeviceTypeAhci,
+  NonDiscoverableDeviceTypeSdhci,
+  NonDiscoverableDeviceTypeUfs,
+  NonDiscoverableDeviceTypeNvme,
+  NonDiscoverableDeviceTypeMax,
+} NON_DISCOVERABLE_DEVICE_TYPE;

Thanks
Feng

-----Original Message-----
From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Ard Biesheuvel

Sent: Friday, November 18, 2016 12:59 PM
To: Ni, Ruiyu <ruiyu.ni@intel.com>
Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>
Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-discoverable device protocol

On 18 November 2016 at 02:11, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:
>

>

> Regards,

> Ray

>

>>-----Original Message-----

>>From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org]

>>Sent: Thursday, November 17, 2016 6:43 PM

>>To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 

>>edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; 

>>afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce 

>>non-discoverable device protocol

>>

>>

>>> On 17 Nov 2016, at 08:52, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>

>>>

>>>

>>> Thanks/Ray

>>>

>>>> -----Original Message-----

>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf 

>>>> Of Ard Biesheuvel

>>>> Sent: Thursday, November 17, 2016 2:07 PM

>>>> To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2- 

>>>> devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; 

>>>> afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non- 

>>>> discoverable device protocol

>>>>

>>>>

>>>>

>>>>> On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>>

>>>>> Ard,

>>>>> I have two comments in below.

>>>>>

>>>>> Thanks/Ray

>>>>>

>>>>>> -----Original Message-----

>>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On 

>>>>>> Behalf Of Leif Lindholm

>>>>>> Sent: Thursday, November 17, 2016 1:49 AM

>>>>>> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org; 

>>>>>> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney, 

>>>>>> Michael D <michael.d.kinney@intel.com>

>>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non- 

>>>>>> discoverable device protocol

>>>>>>

>>>>>>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

>>>>>>> Introduce a protocol that can be exposed by a platform for 

>>>>>>> devices that are not discoverable, usually because they are 

>>>>>>> wired straight to the memory bus rather than to an enumerable bus like PCI or USB.

>>>>>>>

>>>>>>> Contributed-under: TianoCore Contribution Agreement 1.0

>>>>>>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>> ---

>>>>>>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

>>>>>> ++++++++++++++++++++

>>>>>>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

>>>>>>> 2 files changed, 93 insertions(+)

>>>>>>>

>>>>>>> diff --git 

>>>>>>> a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>> new file mode 100644

>>>>>>> index 000000000000..47ed841b407b

>>>>>>> --- /dev/null

>>>>>>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>> @@ -0,0 +1,90 @@

>>>>>>> +/** @file

>>>>>>> +  Protocol to describe devices that are not on a discoverable 

>>>>>>> +bus

>>>>>>> +

>>>>>>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

>>>>>>> +

>>>>>>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define 

>>>>>>> +__NON_DISCOVERABLE_DEVICE_H__

>>>>>>> +

>>>>>>> +#include <IndustryStandard/Acpi.h>

>>>>>>> +

>>>>>>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

>>>>>>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 

>>>>>>> +0x8d, 0x51, 0x4a } }

>>>>>

>>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>>

>>>>

>>>> No. This protocol does not describe pci devices, and it is a 

>>>> peculiarity of the

>>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>>

>>>> in other words, pci is part of the /driver/ side, and it is 

>>>> perfectly possible for, e.g., a non-discoverable ahci device to be 

>>>> driven by a different non-pci driver in the future.

>>>>

>>>

>>> I see. So some types of devices are handled by the current 

>>> NonDiscoveablePciDevice driver, and some other types of devices may 

>>> be handled by a future NonDiscoverableXXXDevice driver.

>>> Now since the AHCI type is already handled by the 

>>> NonDiscoverablePciDevice driver, when there is a new 

>>> NonDiscoverableXXXDevice driver, how can the two know whether it should manage the AHCI type device or not?

>>

>>Good question. But how does the UEFI driver model deal with that? What 

>>happens if i have two drivers that both support the Ahci Pci class codes?

> PCI CFG header contains VendorID/DeviceID fields which can be used to 

> distinguish them.

>


No, that is not what I mean.

Your question is how we should deal with multiple drivers that support, for instance, the AHCI non-discoverable device type. My answer is that this is not any different from a platform configuration that has more than one PCI I/O based driver that supports the AHCI PCI class codes. The UEFI driver model has priority rules and protocols to decide which driver gets precedence. I don't see how it should be any different here.

Thanks,
Ard.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ni, Ruiyu Nov. 18, 2016, 6:13 a.m. | #9
Regards,
Ray

>-----Original Message-----

>From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Ard Biesheuvel

>Sent: Friday, November 18, 2016 12:59 PM

>To: Ni, Ruiyu <ruiyu.ni@intel.com>

>Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-discoverable device protocol

>

>On 18 November 2016 at 02:11, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>

>>

>> Regards,

>> Ray

>>

>>>-----Original Message-----

>>>From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org]

>>>Sent: Thursday, November 17, 2016 6:43 PM

>>>To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>>>afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>>Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-discoverable device protocol

>>>

>>>

>>>> On 17 Nov 2016, at 08:52, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>

>>>>

>>>>

>>>> Thanks/Ray

>>>>

>>>>> -----Original Message-----

>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of

>>>>> Ard Biesheuvel

>>>>> Sent: Thursday, November 17, 2016 2:07 PM

>>>>> To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>>> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-

>>>>> devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; afish@apple.com;

>>>>> Leif Lindholm <leif.lindholm@linaro.org>

>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>>> discoverable device protocol

>>>>>

>>>>>

>>>>>

>>>>>> On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>>>

>>>>>> Ard,

>>>>>> I have two comments in below.

>>>>>>

>>>>>> Thanks/Ray

>>>>>>

>>>>>>> -----Original Message-----

>>>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf

>>>>>>> Of Leif Lindholm

>>>>>>> Sent: Thursday, November 17, 2016 1:49 AM

>>>>>>> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org;

>>>>>>> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney, Michael

>>>>>>> D <michael.d.kinney@intel.com>

>>>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>>>>> discoverable device protocol

>>>>>>>

>>>>>>>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

>>>>>>>> Introduce a protocol that can be exposed by a platform for devices

>>>>>>>> that are not discoverable, usually because they are wired straight

>>>>>>>> to the memory bus rather than to an enumerable bus like PCI or USB.

>>>>>>>>

>>>>>>>> Contributed-under: TianoCore Contribution Agreement 1.0

>>>>>>>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>>> ---

>>>>>>>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

>>>>>>> ++++++++++++++++++++

>>>>>>>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

>>>>>>>> 2 files changed, 93 insertions(+)

>>>>>>>>

>>>>>>>> diff --git a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>> new file mode 100644

>>>>>>>> index 000000000000..47ed841b407b

>>>>>>>> --- /dev/null

>>>>>>>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>> @@ -0,0 +1,90 @@

>>>>>>>> +/** @file

>>>>>>>> +  Protocol to describe devices that are not on a discoverable bus

>>>>>>>> +

>>>>>>>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

>>>>>>>> +

>>>>>>>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define

>>>>>>>> +__NON_DISCOVERABLE_DEVICE_H__

>>>>>>>> +

>>>>>>>> +#include <IndustryStandard/Acpi.h>

>>>>>>>> +

>>>>>>>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

>>>>>>>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc,

>>>>>>>> +0x8d, 0x51, 0x4a } }

>>>>>>

>>>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>>>

>>>>>

>>>>> No. This protocol does not describe pci devices, and it is a peculiarity of the

>>>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>>>

>>>>> in other words, pci is part of the /driver/ side, and it is perfectly possible for,

>>>>> e.g., a non-discoverable ahci device to be driven by a different non-pci driver

>>>>> in the future.

>>>>>

>>>>

>>>> I see. So some types of devices are handled by the current

>>>> NonDiscoveablePciDevice driver, and some other types of devices may be

>>>> handled by a future NonDiscoverableXXXDevice driver.

>>>> Now since the AHCI type is already handled by the NonDiscoverablePciDevice

>>>> driver, when there is a new NonDiscoverableXXXDevice driver, how can the two

>>>> know whether it should manage the AHCI type device or not?

>>>

>>>Good question. But how does the UEFI driver model deal with that? What happens if i have two drivers that both support

>the

>>>Ahci Pci class codes?

>> PCI CFG header contains VendorID/DeviceID fields which can be used to distinguish

>> them.

>>

>

>No, that is not what I mean.

>

>Your question is how we should deal with multiple drivers that

>support, for instance, the AHCI non-discoverable device type. My

>answer is that this is not any different from a platform configuration

>that has more than one PCI I/O based driver that supports the AHCI PCI

>class codes. The UEFI driver model has priority rules and protocols to

>decide which driver gets precedence. I don't see how it should be any

>different here.


I see they are different. Based on PciIo, the *HCI drivers can query
additional information from PCI CFG header, instead of just using
the PCI class code.

But with the NonDiscoverableDevice protocol, there is no additional
information can help the *HCI drivers decide which to manage.

I don't see any practical negative point which prevents degrading
NonDiscoverableDevice protocol to NonDiscoverable*Pci*Protocol.
After all, as I said, all *HCI drivers are based on PciIo.

>

>Thanks,

>Ard.

>_______________________________________________

>edk2-devel mailing list

>edk2-devel@lists.01.org

>https://lists.01.org/mailman/listinfo/edk2-devel

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Nov. 18, 2016, 6:57 a.m. | #10
On 18 November 2016 at 05:24, Tian, Feng <feng.tian@intel.com> wrote:
> Ard,

>

> I have another question.

>

> Is it the only way to specify device type in below enum? Looks like it will be changed often. Is it possible to make use of DevicePath node? Of course, I have no good idea to handle AMBA controller...

>


How would you use a device path node to do that? I think we will
always need a mapping somewhere in the code between numbers and
AHCI/EHCI/etc types, given that the device itself cannot be
interrogated to provide this information. If we can do the same with a
device path, I'm happy to investigate, but I will need some help
understanding how that would work

> +//

> +// Data Types

> +//

> +typedef enum {

> +  NonDiscoverableDeviceTypeAmba,

> +  NonDiscoverableDeviceTypeOhci,

> +  NonDiscoverableDeviceTypeUhci,

> +  NonDiscoverableDeviceTypeEhci,

> +  NonDiscoverableDeviceTypeXhci,

> +  NonDiscoverableDeviceTypeAhci,

> +  NonDiscoverableDeviceTypeSdhci,

> +  NonDiscoverableDeviceTypeUfs,

> +  NonDiscoverableDeviceTypeNvme,

> +  NonDiscoverableDeviceTypeMax,

> +} NON_DISCOVERABLE_DEVICE_TYPE;

>

> Thanks

> Feng

>

> -----Original Message-----

> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Ard Biesheuvel

> Sent: Friday, November 18, 2016 12:59 PM

> To: Ni, Ruiyu <ruiyu.ni@intel.com>

> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-discoverable device protocol

>

> On 18 November 2016 at 02:11, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>

>>

>> Regards,

>> Ray

>>

>>>-----Original Message-----

>>>From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org]

>>>Sent: Thursday, November 17, 2016 6:43 PM

>>>To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>Cc: Kinney, Michael D <michael.d.kinney@intel.com>;

>>>edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>>>afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>>Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce

>>>non-discoverable device protocol

>>>

>>>

>>>> On 17 Nov 2016, at 08:52, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>

>>>>

>>>>

>>>> Thanks/Ray

>>>>

>>>>> -----Original Message-----

>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf

>>>>> Of Ard Biesheuvel

>>>>> Sent: Thursday, November 17, 2016 2:07 PM

>>>>> To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>>> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-

>>>>> devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>>>>> afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>>> discoverable device protocol

>>>>>

>>>>>

>>>>>

>>>>>> On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>>>

>>>>>> Ard,

>>>>>> I have two comments in below.

>>>>>>

>>>>>> Thanks/Ray

>>>>>>

>>>>>>> -----Original Message-----

>>>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On

>>>>>>> Behalf Of Leif Lindholm

>>>>>>> Sent: Thursday, November 17, 2016 1:49 AM

>>>>>>> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org;

>>>>>>> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney,

>>>>>>> Michael D <michael.d.kinney@intel.com>

>>>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>>>>> discoverable device protocol

>>>>>>>

>>>>>>>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

>>>>>>>> Introduce a protocol that can be exposed by a platform for

>>>>>>>> devices that are not discoverable, usually because they are

>>>>>>>> wired straight to the memory bus rather than to an enumerable bus like PCI or USB.

>>>>>>>>

>>>>>>>> Contributed-under: TianoCore Contribution Agreement 1.0

>>>>>>>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>>> ---

>>>>>>>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

>>>>>>> ++++++++++++++++++++

>>>>>>>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

>>>>>>>> 2 files changed, 93 insertions(+)

>>>>>>>>

>>>>>>>> diff --git

>>>>>>>> a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>> new file mode 100644

>>>>>>>> index 000000000000..47ed841b407b

>>>>>>>> --- /dev/null

>>>>>>>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>> @@ -0,0 +1,90 @@

>>>>>>>> +/** @file

>>>>>>>> +  Protocol to describe devices that are not on a discoverable

>>>>>>>> +bus

>>>>>>>> +

>>>>>>>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

>>>>>>>> +

>>>>>>>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define

>>>>>>>> +__NON_DISCOVERABLE_DEVICE_H__

>>>>>>>> +

>>>>>>>> +#include <IndustryStandard/Acpi.h>

>>>>>>>> +

>>>>>>>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

>>>>>>>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc,

>>>>>>>> +0x8d, 0x51, 0x4a } }

>>>>>>

>>>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>>>

>>>>>

>>>>> No. This protocol does not describe pci devices, and it is a

>>>>> peculiarity of the

>>>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>>>

>>>>> in other words, pci is part of the /driver/ side, and it is

>>>>> perfectly possible for, e.g., a non-discoverable ahci device to be

>>>>> driven by a different non-pci driver in the future.

>>>>>

>>>>

>>>> I see. So some types of devices are handled by the current

>>>> NonDiscoveablePciDevice driver, and some other types of devices may

>>>> be handled by a future NonDiscoverableXXXDevice driver.

>>>> Now since the AHCI type is already handled by the

>>>> NonDiscoverablePciDevice driver, when there is a new

>>>> NonDiscoverableXXXDevice driver, how can the two know whether it should manage the AHCI type device or not?

>>>

>>>Good question. But how does the UEFI driver model deal with that? What

>>>happens if i have two drivers that both support the Ahci Pci class codes?

>> PCI CFG header contains VendorID/DeviceID fields which can be used to

>> distinguish them.

>>

>

> No, that is not what I mean.

>

> Your question is how we should deal with multiple drivers that support, for instance, the AHCI non-discoverable device type. My answer is that this is not any different from a platform configuration that has more than one PCI I/O based driver that supports the AHCI PCI class codes. The UEFI driver model has priority rules and protocols to decide which driver gets precedence. I don't see how it should be any different here.

>

> Thanks,

> Ard.

> _______________________________________________

> edk2-devel mailing list

> edk2-devel@lists.01.org

> https://lists.01.org/mailman/listinfo/edk2-devel

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Nov. 18, 2016, 7:04 a.m. | #11
On 18 November 2016 at 06:13, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:
>

>

> Regards,

> Ray

>

>>-----Original Message-----

>>From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of Ard Biesheuvel

>>Sent: Friday, November 18, 2016 12:59 PM

>>To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>>afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-discoverable device protocol

>>

>>On 18 November 2016 at 02:11, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>

>>>

>>> Regards,

>>> Ray

>>>

>>>>-----Original Message-----

>>>>From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org]

>>>>Sent: Thursday, November 17, 2016 6:43 PM

>>>>To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>>Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>>>>afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>>>Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-discoverable device protocol

>>>>

>>>>

>>>>> On 17 Nov 2016, at 08:52, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>>

>>>>>

>>>>>

>>>>> Thanks/Ray

>>>>>

>>>>>> -----Original Message-----

>>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of

>>>>>> Ard Biesheuvel

>>>>>> Sent: Thursday, November 17, 2016 2:07 PM

>>>>>> To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>>>> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-

>>>>>> devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; afish@apple.com;

>>>>>> Leif Lindholm <leif.lindholm@linaro.org>

>>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>>>> discoverable device protocol

>>>>>>

>>>>>>

>>>>>>

>>>>>>> On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>>>>

>>>>>>> Ard,

>>>>>>> I have two comments in below.

>>>>>>>

>>>>>>> Thanks/Ray

>>>>>>>

>>>>>>>> -----Original Message-----

>>>>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf

>>>>>>>> Of Leif Lindholm

>>>>>>>> Sent: Thursday, November 17, 2016 1:49 AM

>>>>>>>> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org;

>>>>>>>> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney, Michael

>>>>>>>> D <michael.d.kinney@intel.com>

>>>>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>>>>>> discoverable device protocol

>>>>>>>>

>>>>>>>>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

>>>>>>>>> Introduce a protocol that can be exposed by a platform for devices

>>>>>>>>> that are not discoverable, usually because they are wired straight

>>>>>>>>> to the memory bus rather than to an enumerable bus like PCI or USB.

>>>>>>>>>

>>>>>>>>> Contributed-under: TianoCore Contribution Agreement 1.0

>>>>>>>>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>>>> ---

>>>>>>>>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

>>>>>>>> ++++++++++++++++++++

>>>>>>>>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

>>>>>>>>> 2 files changed, 93 insertions(+)

>>>>>>>>>

>>>>>>>>> diff --git a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>>> new file mode 100644

>>>>>>>>> index 000000000000..47ed841b407b

>>>>>>>>> --- /dev/null

>>>>>>>>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>>> @@ -0,0 +1,90 @@

>>>>>>>>> +/** @file

>>>>>>>>> +  Protocol to describe devices that are not on a discoverable bus

>>>>>>>>> +

>>>>>>>>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

>>>>>>>>> +

>>>>>>>>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define

>>>>>>>>> +__NON_DISCOVERABLE_DEVICE_H__

>>>>>>>>> +

>>>>>>>>> +#include <IndustryStandard/Acpi.h>

>>>>>>>>> +

>>>>>>>>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

>>>>>>>>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc,

>>>>>>>>> +0x8d, 0x51, 0x4a } }

>>>>>>>

>>>>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>>>>

>>>>>>

>>>>>> No. This protocol does not describe pci devices, and it is a peculiarity of the

>>>>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>>>>

>>>>>> in other words, pci is part of the /driver/ side, and it is perfectly possible for,

>>>>>> e.g., a non-discoverable ahci device to be driven by a different non-pci driver

>>>>>> in the future.

>>>>>>

>>>>>

>>>>> I see. So some types of devices are handled by the current

>>>>> NonDiscoveablePciDevice driver, and some other types of devices may be

>>>>> handled by a future NonDiscoverableXXXDevice driver.

>>>>> Now since the AHCI type is already handled by the NonDiscoverablePciDevice

>>>>> driver, when there is a new NonDiscoverableXXXDevice driver, how can the two

>>>>> know whether it should manage the AHCI type device or not?

>>>>

>>>>Good question. But how does the UEFI driver model deal with that? What happens if i have two drivers that both support

>>the

>>>>Ahci Pci class codes?

>>> PCI CFG header contains VendorID/DeviceID fields which can be used to distinguish

>>> them.

>>>

>>

>>No, that is not what I mean.

>>

>>Your question is how we should deal with multiple drivers that

>>support, for instance, the AHCI non-discoverable device type. My

>>answer is that this is not any different from a platform configuration

>>that has more than one PCI I/O based driver that supports the AHCI PCI

>>class codes. The UEFI driver model has priority rules and protocols to

>>decide which driver gets precedence. I don't see how it should be any

>>different here.

>

> I see they are different. Based on PciIo, the *HCI drivers can query

> additional information from PCI CFG header, instead of just using

> the PCI class code.

>

> But with the NonDiscoverableDevice protocol, there is no additional

> information can help the *HCI drivers decide which to manage.

>

> I don't see any practical negative point which prevents degrading

> NonDiscoverableDevice protocol to NonDiscoverable*Pci*Protocol.

> After all, as I said, all *HCI drivers are based on PciIo.

>


Yes the *drivers* are based on PCI. But that does not make the
*devices* PCI devices. That is the whole problem we are trying to deal
with. So describing the non-PCI devices as PCI devices is incorrect
imo. The fact that we will use PCI drivers to drive non-PCI devices is
an implementation detail of EDK2, and is a property of the *driver*
side not the *device* side. So using PCI class codes etc to wire up
the correct driver should be local to the driver, and not pollute the
description of the device.

For example, if we would ever split the AHCI driver into a AHCI part
and a PCI part (which I know is unlikely to occur), I would want the
non-PCI AHCI driver to be used with the same protocol. Perhaps that
means we need a protocol for each type of device rather than an enum?
In any case, putting PCI-specific metadata into the device description
makes the situation worse, because now both the *device* and the
*driver* side are forced to use PCI internals to describe devices that
have nothing to do with PCI

Thanks,
Ard.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Tian, Feng Nov. 18, 2016, 8:39 a.m. | #12
The simplest way I can think is

+struct _NON_DISCOVERABLE_DEVICE {
+  //
+  // The type of device
+  //
+  NON_DISCOVERABLE_DEVICE_TYPE        Type; -> change it to UINT8 Type; //Type is the subtype of corresponding device, such as SATA is MSG_SATA_DP(0x12)
+  //
+  // Whether this device is DMA coherent
+  //
+  NON_DISCOVERABLE_DEVICE_DMA_TYPE    DmaType;
+  //
+  // Initialization function for the device
+  //
+  NON_DISCOVERABLE_DEVICE_INIT        Initialize;
+  //
+  // The MMIO and I/O regions owned by the device
+  //
+  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR   *Resources;
+};

Thanks
Feng

-----Original Message-----
From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org] 

Sent: Friday, November 18, 2016 2:57 PM
To: Tian, Feng <feng.tian@intel.com>
Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>
Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-discoverable device protocol

On 18 November 2016 at 05:24, Tian, Feng <feng.tian@intel.com> wrote:
> Ard,

>

> I have another question.

>

> Is it the only way to specify device type in below enum? Looks like it will be changed often. Is it possible to make use of DevicePath node? Of course, I have no good idea to handle AMBA controller...

>


How would you use a device path node to do that? I think we will always need a mapping somewhere in the code between numbers and AHCI/EHCI/etc types, given that the device itself cannot be interrogated to provide this information. If we can do the same with a device path, I'm happy to investigate, but I will need some help understanding how that would work

> +//

> +// Data Types

> +//

> +typedef enum {

> +  NonDiscoverableDeviceTypeAmba,

> +  NonDiscoverableDeviceTypeOhci,

> +  NonDiscoverableDeviceTypeUhci,

> +  NonDiscoverableDeviceTypeEhci,

> +  NonDiscoverableDeviceTypeXhci,

> +  NonDiscoverableDeviceTypeAhci,

> +  NonDiscoverableDeviceTypeSdhci,

> +  NonDiscoverableDeviceTypeUfs,

> +  NonDiscoverableDeviceTypeNvme,

> +  NonDiscoverableDeviceTypeMax,

> +} NON_DISCOVERABLE_DEVICE_TYPE;

>

> Thanks

> Feng

>

> -----Original Message-----

> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of 

> Ard Biesheuvel

> Sent: Friday, November 18, 2016 12:59 PM

> To: Ni, Ruiyu <ruiyu.ni@intel.com>

> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 

> edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; 

> afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce 

> non-discoverable device protocol

>

> On 18 November 2016 at 02:11, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>

>>

>> Regards,

>> Ray

>>

>>>-----Original Message-----

>>>From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org]

>>>Sent: Thursday, November 17, 2016 6:43 PM

>>>To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>Cc: Kinney, Michael D <michael.d.kinney@intel.com>; 

>>>edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; 

>>>afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>>Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce 

>>>non-discoverable device protocol

>>>

>>>

>>>> On 17 Nov 2016, at 08:52, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>

>>>>

>>>>

>>>> Thanks/Ray

>>>>

>>>>> -----Original Message-----

>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On 

>>>>> Behalf Of Ard Biesheuvel

>>>>> Sent: Thursday, November 17, 2016 2:07 PM

>>>>> To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>>> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2- 

>>>>> devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; 

>>>>> afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non- 

>>>>> discoverable device protocol

>>>>>

>>>>>

>>>>>

>>>>>> On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>>>

>>>>>> Ard,

>>>>>> I have two comments in below.

>>>>>>

>>>>>> Thanks/Ray

>>>>>>

>>>>>>> -----Original Message-----

>>>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On 

>>>>>>> Behalf Of Leif Lindholm

>>>>>>> Sent: Thursday, November 17, 2016 1:49 AM

>>>>>>> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org; 

>>>>>>> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney, 

>>>>>>> Michael D <michael.d.kinney@intel.com>

>>>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non- 

>>>>>>> discoverable device protocol

>>>>>>>

>>>>>>>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

>>>>>>>> Introduce a protocol that can be exposed by a platform for 

>>>>>>>> devices that are not discoverable, usually because they are 

>>>>>>>> wired straight to the memory bus rather than to an enumerable bus like PCI or USB.

>>>>>>>>

>>>>>>>> Contributed-under: TianoCore Contribution Agreement 1.0

>>>>>>>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>>> ---

>>>>>>>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

>>>>>>> ++++++++++++++++++++

>>>>>>>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

>>>>>>>> 2 files changed, 93 insertions(+)

>>>>>>>>

>>>>>>>> diff --git

>>>>>>>> a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>> new file mode 100644

>>>>>>>> index 000000000000..47ed841b407b

>>>>>>>> --- /dev/null

>>>>>>>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>> @@ -0,0 +1,90 @@

>>>>>>>> +/** @file

>>>>>>>> +  Protocol to describe devices that are not on a discoverable 

>>>>>>>> +bus

>>>>>>>> +

>>>>>>>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

>>>>>>>> +

>>>>>>>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define 

>>>>>>>> +__NON_DISCOVERABLE_DEVICE_H__

>>>>>>>> +

>>>>>>>> +#include <IndustryStandard/Acpi.h>

>>>>>>>> +

>>>>>>>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

>>>>>>>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 

>>>>>>>> +0x8d, 0x51, 0x4a } }

>>>>>>

>>>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>>>

>>>>>

>>>>> No. This protocol does not describe pci devices, and it is a 

>>>>> peculiarity of the

>>>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>>>

>>>>> in other words, pci is part of the /driver/ side, and it is 

>>>>> perfectly possible for, e.g., a non-discoverable ahci device to be 

>>>>> driven by a different non-pci driver in the future.

>>>>>

>>>>

>>>> I see. So some types of devices are handled by the current 

>>>> NonDiscoveablePciDevice driver, and some other types of devices may 

>>>> be handled by a future NonDiscoverableXXXDevice driver.

>>>> Now since the AHCI type is already handled by the 

>>>> NonDiscoverablePciDevice driver, when there is a new 

>>>> NonDiscoverableXXXDevice driver, how can the two know whether it should manage the AHCI type device or not?

>>>

>>>Good question. But how does the UEFI driver model deal with that? 

>>>What happens if i have two drivers that both support the Ahci Pci class codes?

>> PCI CFG header contains VendorID/DeviceID fields which can be used to 

>> distinguish them.

>>

>

> No, that is not what I mean.

>

> Your question is how we should deal with multiple drivers that support, for instance, the AHCI non-discoverable device type. My answer is that this is not any different from a platform configuration that has more than one PCI I/O based driver that supports the AHCI PCI class codes. The UEFI driver model has priority rules and protocols to decide which driver gets precedence. I don't see how it should be any different here.

>

> Thanks,

> Ard.

> _______________________________________________

> edk2-devel mailing list

> edk2-devel@lists.01.org

> https://lists.01.org/mailman/listinfo/edk2-devel

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Nov. 18, 2016, 8:52 a.m. | #13
On 18 November 2016 at 08:39, Tian, Feng <feng.tian@intel.com> wrote:
> The simplest way I can think is

>

> +struct _NON_DISCOVERABLE_DEVICE {

> +  //

> +  // The type of device

> +  //

> +  NON_DISCOVERABLE_DEVICE_TYPE        Type; -> change it to UINT8 Type; //Type is the subtype of corresponding device, such as SATA is MSG_SATA_DP(0x12)


What should we use for AMBA devices then?

> +  //

> +  // Whether this device is DMA coherent

> +  //

> +  NON_DISCOVERABLE_DEVICE_DMA_TYPE    DmaType;

> +  //

> +  // Initialization function for the device

> +  //

> +  NON_DISCOVERABLE_DEVICE_INIT        Initialize;

> +  //

> +  // The MMIO and I/O regions owned by the device

> +  //

> +  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR   *Resources;

> +};

>

> Thanks

> Feng

>

> -----Original Message-----

> From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org]

> Sent: Friday, November 18, 2016 2:57 PM

> To: Tian, Feng <feng.tian@intel.com>

> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; Kinney, Michael D <michael.d.kinney@intel.com>; edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>; afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-discoverable device protocol

>

> On 18 November 2016 at 05:24, Tian, Feng <feng.tian@intel.com> wrote:

>> Ard,

>>

>> I have another question.

>>

>> Is it the only way to specify device type in below enum? Looks like it will be changed often. Is it possible to make use of DevicePath node? Of course, I have no good idea to handle AMBA controller...

>>

>

> How would you use a device path node to do that? I think we will always need a mapping somewhere in the code between numbers and AHCI/EHCI/etc types, given that the device itself cannot be interrogated to provide this information. If we can do the same with a device path, I'm happy to investigate, but I will need some help understanding how that would work

>

>> +//

>> +// Data Types

>> +//

>> +typedef enum {

>> +  NonDiscoverableDeviceTypeAmba,

>> +  NonDiscoverableDeviceTypeOhci,

>> +  NonDiscoverableDeviceTypeUhci,

>> +  NonDiscoverableDeviceTypeEhci,

>> +  NonDiscoverableDeviceTypeXhci,

>> +  NonDiscoverableDeviceTypeAhci,

>> +  NonDiscoverableDeviceTypeSdhci,

>> +  NonDiscoverableDeviceTypeUfs,

>> +  NonDiscoverableDeviceTypeNvme,

>> +  NonDiscoverableDeviceTypeMax,

>> +} NON_DISCOVERABLE_DEVICE_TYPE;

>>

>> Thanks

>> Feng

>>

>> -----Original Message-----

>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On Behalf Of

>> Ard Biesheuvel

>> Sent: Friday, November 18, 2016 12:59 PM

>> To: Ni, Ruiyu <ruiyu.ni@intel.com>

>> Cc: Kinney, Michael D <michael.d.kinney@intel.com>;

>> edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>> afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce

>> non-discoverable device protocol

>>

>> On 18 November 2016 at 02:11, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>

>>>

>>> Regards,

>>> Ray

>>>

>>>>-----Original Message-----

>>>>From: Ard Biesheuvel [mailto:ard.biesheuvel@linaro.org]

>>>>Sent: Thursday, November 17, 2016 6:43 PM

>>>>To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>>Cc: Kinney, Michael D <michael.d.kinney@intel.com>;

>>>>edk2-devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>>>>afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>>>Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce

>>>>non-discoverable device protocol

>>>>

>>>>

>>>>> On 17 Nov 2016, at 08:52, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>>

>>>>>

>>>>>

>>>>> Thanks/Ray

>>>>>

>>>>>> -----Original Message-----

>>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On

>>>>>> Behalf Of Ard Biesheuvel

>>>>>> Sent: Thursday, November 17, 2016 2:07 PM

>>>>>> To: Ni, Ruiyu <ruiyu.ni@intel.com>

>>>>>> Cc: Kinney, Michael D <michael.d.kinney@intel.com>; edk2-

>>>>>> devel@lists.01.org; Gao, Liming <liming.gao@intel.com>;

>>>>>> afish@apple.com; Leif Lindholm <leif.lindholm@linaro.org>

>>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>>>> discoverable device protocol

>>>>>>

>>>>>>

>>>>>>

>>>>>>> On 17 Nov 2016, at 02:53, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>>>>

>>>>>>> Ard,

>>>>>>> I have two comments in below.

>>>>>>>

>>>>>>> Thanks/Ray

>>>>>>>

>>>>>>>> -----Original Message-----

>>>>>>>> From: edk2-devel [mailto:edk2-devel-bounces@lists.01.org] On

>>>>>>>> Behalf Of Leif Lindholm

>>>>>>>> Sent: Thursday, November 17, 2016 1:49 AM

>>>>>>>> To: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>>> Cc: Ni, Ruiyu <ruiyu.ni@intel.com>; edk2-devel@lists.01.org;

>>>>>>>> afish@apple.com; Gao, Liming <liming.gao@intel.com>; Kinney,

>>>>>>>> Michael D <michael.d.kinney@intel.com>

>>>>>>>> Subject: Re: [edk2] [PATCH v3 1/5] MdeModulePkg: introduce non-

>>>>>>>> discoverable device protocol

>>>>>>>>

>>>>>>>>> On Wed, Nov 16, 2016 at 04:59:27PM +0000, Ard Biesheuvel wrote:

>>>>>>>>> Introduce a protocol that can be exposed by a platform for

>>>>>>>>> devices that are not discoverable, usually because they are

>>>>>>>>> wired straight to the memory bus rather than to an enumerable bus like PCI or USB.

>>>>>>>>>

>>>>>>>>> Contributed-under: TianoCore Contribution Agreement 1.0

>>>>>>>>> Signed-off-by: Ard Biesheuvel <ard.biesheuvel@linaro.org>

>>>>>>>>> ---

>>>>>>>>> MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h | 90

>>>>>>>> ++++++++++++++++++++

>>>>>>>>> MdeModulePkg/MdeModulePkg.dec                         |  3 +

>>>>>>>>> 2 files changed, 93 insertions(+)

>>>>>>>>>

>>>>>>>>> diff --git

>>>>>>>>> a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>>> b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>>> new file mode 100644

>>>>>>>>> index 000000000000..47ed841b407b

>>>>>>>>> --- /dev/null

>>>>>>>>> +++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h

>>>>>>>>> @@ -0,0 +1,90 @@

>>>>>>>>> +/** @file

>>>>>>>>> +  Protocol to describe devices that are not on a discoverable

>>>>>>>>> +bus

>>>>>>>>> +

>>>>>>>>> +  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>

>>>>>>>>> +

>>>>>>>>> +  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 __NON_DISCOVERABLE_DEVICE_H__ #define

>>>>>>>>> +__NON_DISCOVERABLE_DEVICE_H__

>>>>>>>>> +

>>>>>>>>> +#include <IndustryStandard/Acpi.h>

>>>>>>>>> +

>>>>>>>>> +#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \

>>>>>>>>> +  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc,

>>>>>>>>> +0x8d, 0x51, 0x4a } }

>>>>>>>

>>>>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>>>>

>>>>>>

>>>>>> No. This protocol does not describe pci devices, and it is a

>>>>>> peculiarity of the

>>>>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>>>>

>>>>>> in other words, pci is part of the /driver/ side, and it is

>>>>>> perfectly possible for, e.g., a non-discoverable ahci device to be

>>>>>> driven by a different non-pci driver in the future.

>>>>>>

>>>>>

>>>>> I see. So some types of devices are handled by the current

>>>>> NonDiscoveablePciDevice driver, and some other types of devices may

>>>>> be handled by a future NonDiscoverableXXXDevice driver.

>>>>> Now since the AHCI type is already handled by the

>>>>> NonDiscoverablePciDevice driver, when there is a new

>>>>> NonDiscoverableXXXDevice driver, how can the two know whether it should manage the AHCI type device or not?

>>>>

>>>>Good question. But how does the UEFI driver model deal with that?

>>>>What happens if i have two drivers that both support the Ahci Pci class codes?

>>> PCI CFG header contains VendorID/DeviceID fields which can be used to

>>> distinguish them.

>>>

>>

>> No, that is not what I mean.

>>

>> Your question is how we should deal with multiple drivers that support, for instance, the AHCI non-discoverable device type. My answer is that this is not any different from a platform configuration that has more than one PCI I/O based driver that supports the AHCI PCI class codes. The UEFI driver model has priority rules and protocols to decide which driver gets precedence. I don't see how it should be any different here.

>>

>> Thanks,

>> Ard.

>> _______________________________________________

>> edk2-devel mailing list

>> edk2-devel@lists.01.org

>> https://lists.01.org/mailman/listinfo/edk2-devel

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ni, Ruiyu Nov. 18, 2016, 1:39 p.m. | #14
>>>>>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>>>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>>>>>

>>>>>>>

>>>>>>> No. This protocol does not describe pci devices, and it is a peculiarity of the

>>>>>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>>>>>

>>>>>>> in other words, pci is part of the /driver/ side, and it is perfectly possible for,

>>>>>>> e.g., a non-discoverable ahci device to be driven by a different non-pci driver

>>>>>>> in the future.

>>>>>>>

>>>>>>

>>>>>> I see. So some types of devices are handled by the current

>>>>>> NonDiscoveablePciDevice driver, and some other types of devices may be

>>>>>> handled by a future NonDiscoverableXXXDevice driver.

>>>>>> Now since the AHCI type is already handled by the NonDiscoverablePciDevice

>>>>>> driver, when there is a new NonDiscoverableXXXDevice driver, how can the two

>>>>>> know whether it should manage the AHCI type device or not?

>>>>>

>>>>>Good question. But how does the UEFI driver model deal with that? What happens if i have two drivers that both support

>>>the

>>>>>Ahci Pci class codes?

>>>> PCI CFG header contains VendorID/DeviceID fields which can be used to distinguish

>>>> them.

>>>>

>>>

>>>No, that is not what I mean.

>>>

>>>Your question is how we should deal with multiple drivers that

>>>support, for instance, the AHCI non-discoverable device type. My

>>>answer is that this is not any different from a platform configuration

>>>that has more than one PCI I/O based driver that supports the AHCI PCI

>>>class codes. The UEFI driver model has priority rules and protocols to

>>>decide which driver gets precedence. I don't see how it should be any

>>>different here.

>>

>> I see they are different. Based on PciIo, the *HCI drivers can query

>> additional information from PCI CFG header, instead of just using

>> the PCI class code.

>>

>> But with the NonDiscoverableDevice protocol, there is no additional

>> information can help the *HCI drivers decide which to manage.

>>

>> I don't see any practical negative point which prevents degrading

>> NonDiscoverableDevice protocol to NonDiscoverable*Pci*Protocol.

>> After all, as I said, all *HCI drivers are based on PciIo.

>>

>

>Yes the *drivers* are based on PCI. But that does not make the

>*devices* PCI devices. That is the whole problem we are trying to deal

>with. So describing the non-PCI devices as PCI devices is incorrect

>imo. The fact that we will use PCI drivers to drive non-PCI devices is

>an implementation detail of EDK2, and is a property of the *driver*

>side not the *device* side. So using PCI class codes etc to wire up

>the correct driver should be local to the driver, and not pollute the

>description of the device.

>

>For example, if we would ever split the AHCI driver into a AHCI part

>and a PCI part (which I know is unlikely to occur), I would want the

>non-PCI AHCI driver to be used with the same protocol. Perhaps that

>means we need a protocol for each type of device rather than an enum?

>In any case, putting PCI-specific metadata into the device description

>makes the situation worse, because now both the *device* and the

>*driver* side are forced to use PCI internals to describe devices that

>have nothing to do with PCI


If I understand correctly, you want the protocol producer can simply
produce such protocol without the knowledge of PCI. I agree!
But we do need to make the protocol definition stable enough. I do not
like to see the enum type being extended in future to support more types
of devices.
1. Can you use different GUIDs for different types of devices?
2. As I replied as comment #2 to patch 3/5, do you have better way to
deal with the SDHCI Host controller driver access?


>

>Thanks,

>Ard.

_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Nov. 18, 2016, 1:50 p.m. | #15
On 18 Nov 2016, at 14:39, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>>>>>>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>>>>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>>>>>> 

>>>>>>>> 

>>>>>>>> No. This protocol does not describe pci devices, and it is a peculiarity of the

>>>>>>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>>>>>> 

>>>>>>>> in other words, pci is part of the /driver/ side, and it is perfectly possible for,

>>>>>>>> e.g., a non-discoverable ahci device to be driven by a different non-pci driver

>>>>>>>> in the future.

>>>>>>>> 

>>>>>>> 

>>>>>>> I see. So some types of devices are handled by the current

>>>>>>> NonDiscoveablePciDevice driver, and some other types of devices may be

>>>>>>> handled by a future NonDiscoverableXXXDevice driver.

>>>>>>> Now since the AHCI type is already handled by the NonDiscoverablePciDevice

>>>>>>> driver, when there is a new NonDiscoverableXXXDevice driver, how can the two

>>>>>>> know whether it should manage the AHCI type device or not?

>>>>>> 

>>>>>> Good question. But how does the UEFI driver model deal with that? What happens if i have two drivers that both support

>>>> the

>>>>>> Ahci Pci class codes?

>>>>> PCI CFG header contains VendorID/DeviceID fields which can be used to distinguish

>>>>> them.

>>>>> 

>>>> 

>>>> No, that is not what I mean.

>>>> 

>>>> Your question is how we should deal with multiple drivers that

>>>> support, for instance, the AHCI non-discoverable device type. My

>>>> answer is that this is not any different from a platform configuration

>>>> that has more than one PCI I/O based driver that supports the AHCI PCI

>>>> class codes. The UEFI driver model has priority rules and protocols to

>>>> decide which driver gets precedence. I don't see how it should be any

>>>> different here.

>>> 

>>> I see they are different. Based on PciIo, the *HCI drivers can query

>>> additional information from PCI CFG header, instead of just using

>>> the PCI class code.

>>> 

>>> But with the NonDiscoverableDevice protocol, there is no additional

>>> information can help the *HCI drivers decide which to manage.

>>> 

>>> I don't see any practical negative point which prevents degrading

>>> NonDiscoverableDevice protocol to NonDiscoverable*Pci*Protocol.

>>> After all, as I said, all *HCI drivers are based on PciIo.

>>> 

>> 

>> Yes the *drivers* are based on PCI. But that does not make the

>> *devices* PCI devices. That is the whole problem we are trying to deal

>> with. So describing the non-PCI devices as PCI devices is incorrect

>> imo. The fact that we will use PCI drivers to drive non-PCI devices is

>> an implementation detail of EDK2, and is a property of the *driver*

>> side not the *device* side. So using PCI class codes etc to wire up

>> the correct driver should be local to the driver, and not pollute the

>> description of the device.

>> 

>> For example, if we would ever split the AHCI driver into a AHCI part

>> and a PCI part (which I know is unlikely to occur), I would want the

>> non-PCI AHCI driver to be used with the same protocol. Perhaps that

>> means we need a protocol for each type of device rather than an enum?

>> In any case, putting PCI-specific metadata into the device description

>> makes the situation worse, because now both the *device* and the

>> *driver* side are forced to use PCI internals to describe devices that

>> have nothing to do with PCI

> 

> If I understand correctly, you want the protocol producer can simply

> produce such protocol without the knowledge of PCI. I agree!

> But we do need to make the protocol definition stable enough. I do not

> like to see the enum type being extended in future to support more types

> of devices.

> 1. Can you use different GUIDs for different types of devices?


Yes that seems like a reasonable approach, in the spirit of EDK2 :-)

> 2. As I replied as comment #2 to patch 3/5, do you have better way to

> deal with the SDHCI Host controller driver access?



I need to think about this
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel
Ard Biesheuvel Nov. 25, 2016, 3:21 p.m. | #16
On 18 November 2016 at 13:50, Ard Biesheuvel <ard.biesheuvel@linaro.org> wrote:
>

> On 18 Nov 2016, at 14:39, Ni, Ruiyu <ruiyu.ni@intel.com> wrote:

>

>>>>>>>>>> 1. Can you add "PCI" keyword into the protocol name?

>>>>>>>>>> e.g.: EDKII_NON_DISCOVERABLE_PCI_DEVICE_PROTOCOL_GUID

>>>>>>>>>>

>>>>>>>>>

>>>>>>>>> No. This protocol does not describe pci devices, and it is a peculiarity of the

>>>>>>>>> edk2 driver stack that some non-pci devices can only be driven by pci drivers.

>>>>>>>>>

>>>>>>>>> in other words, pci is part of the /driver/ side, and it is perfectly possible for,

>>>>>>>>> e.g., a non-discoverable ahci device to be driven by a different non-pci driver

>>>>>>>>> in the future.

>>>>>>>>>

>>>>>>>>

>>>>>>>> I see. So some types of devices are handled by the current

>>>>>>>> NonDiscoveablePciDevice driver, and some other types of devices may be

>>>>>>>> handled by a future NonDiscoverableXXXDevice driver.

>>>>>>>> Now since the AHCI type is already handled by the NonDiscoverablePciDevice

>>>>>>>> driver, when there is a new NonDiscoverableXXXDevice driver, how can the two

>>>>>>>> know whether it should manage the AHCI type device or not?

>>>>>>>

>>>>>>> Good question. But how does the UEFI driver model deal with that? What happens if i have two drivers that both support

>>>>> the

>>>>>>> Ahci Pci class codes?

>>>>>> PCI CFG header contains VendorID/DeviceID fields which can be used to distinguish

>>>>>> them.

>>>>>>

>>>>>

>>>>> No, that is not what I mean.

>>>>>

>>>>> Your question is how we should deal with multiple drivers that

>>>>> support, for instance, the AHCI non-discoverable device type. My

>>>>> answer is that this is not any different from a platform configuration

>>>>> that has more than one PCI I/O based driver that supports the AHCI PCI

>>>>> class codes. The UEFI driver model has priority rules and protocols to

>>>>> decide which driver gets precedence. I don't see how it should be any

>>>>> different here.

>>>>

>>>> I see they are different. Based on PciIo, the *HCI drivers can query

>>>> additional information from PCI CFG header, instead of just using

>>>> the PCI class code.

>>>>

>>>> But with the NonDiscoverableDevice protocol, there is no additional

>>>> information can help the *HCI drivers decide which to manage.

>>>>

>>>> I don't see any practical negative point which prevents degrading

>>>> NonDiscoverableDevice protocol to NonDiscoverable*Pci*Protocol.

>>>> After all, as I said, all *HCI drivers are based on PciIo.

>>>>

>>>

>>> Yes the *drivers* are based on PCI. But that does not make the

>>> *devices* PCI devices. That is the whole problem we are trying to deal

>>> with. So describing the non-PCI devices as PCI devices is incorrect

>>> imo. The fact that we will use PCI drivers to drive non-PCI devices is

>>> an implementation detail of EDK2, and is a property of the *driver*

>>> side not the *device* side. So using PCI class codes etc to wire up

>>> the correct driver should be local to the driver, and not pollute the

>>> description of the device.

>>>

>>> For example, if we would ever split the AHCI driver into a AHCI part

>>> and a PCI part (which I know is unlikely to occur), I would want the

>>> non-PCI AHCI driver to be used with the same protocol. Perhaps that

>>> means we need a protocol for each type of device rather than an enum?

>>> In any case, putting PCI-specific metadata into the device description

>>> makes the situation worse, because now both the *device* and the

>>> *driver* side are forced to use PCI internals to describe devices that

>>> have nothing to do with PCI

>>

>> If I understand correctly, you want the protocol producer can simply

>> produce such protocol without the knowledge of PCI. I agree!

>> But we do need to make the protocol definition stable enough. I do not

>> like to see the enum type being extended in future to support more types

>> of devices.

>> 1. Can you use different GUIDs for different types of devices?

>

> Yes that seems like a reasonable approach, in the spirit of EDK2 :-)

>

>> 2. As I replied as comment #2 to patch 3/5, do you have better way to

>> deal with the SDHCI Host controller driver access?

>


The best way is to revert to the previous solution. This means two
SDHCI slots will be modeled as two separate non-discoverable devices,
and will each receive a separate instance of the PCI I/O protocol,
describing a SDHCI-PCI device with a single slot. But actually, I
don't think that matters at all. The way the SDHCI driver is
implemented is debatable anway: I still think it should be a bus
driver, with each slot a separate device on this bus.
_______________________________________________
edk2-devel mailing list
edk2-devel@lists.01.org
https://lists.01.org/mailman/listinfo/edk2-devel

Patch

diff --git a/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h
new file mode 100644
index 000000000000..47ed841b407b
--- /dev/null
+++ b/MdeModulePkg/Include/Protocol/NonDiscoverableDevice.h
@@ -0,0 +1,90 @@ 
+/** @file
+  Protocol to describe devices that are not on a discoverable bus
+
+  Copyright (c) 2016, Linaro, Ltd. All rights reserved.<BR>
+
+  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 __NON_DISCOVERABLE_DEVICE_H__
+#define __NON_DISCOVERABLE_DEVICE_H__
+
+#include <IndustryStandard/Acpi.h>
+
+#define EDKII_NON_DISCOVERABLE_DEVICE_PROTOCOL_GUID \
+  { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d, 0x51, 0x4a } }
+
+//
+// Protocol interface structure
+//
+typedef struct _NON_DISCOVERABLE_DEVICE NON_DISCOVERABLE_DEVICE;
+
+//
+// Data Types
+//
+typedef enum {
+  NonDiscoverableDeviceTypeAmba,
+  NonDiscoverableDeviceTypeOhci,
+  NonDiscoverableDeviceTypeUhci,
+  NonDiscoverableDeviceTypeEhci,
+  NonDiscoverableDeviceTypeXhci,
+  NonDiscoverableDeviceTypeAhci,
+  NonDiscoverableDeviceTypeSdhci,
+  NonDiscoverableDeviceTypeUfs,
+  NonDiscoverableDeviceTypeNvme,
+  NonDiscoverableDeviceTypeMax,
+} NON_DISCOVERABLE_DEVICE_TYPE;
+
+typedef enum {
+  NonDiscoverableDeviceDmaTypeCoherent,
+  NonDiscoverableDeviceDmaTypeNonCoherent,
+  NonDiscoverableDeviceDmaTypeMax,
+} NON_DISCOVERABLE_DEVICE_DMA_TYPE;
+
+//
+// Function Prototypes
+//
+
+/**
+  Perform device specific initialization before the device is started
+
+  @param  This          The non-discoverable device protocol pointer
+
+  @retval EFI_SUCCESS   Initialization successful, the device may be used
+  @retval Other         Initialization failed, device should not be started
+**/
+typedef
+EFI_STATUS
+(EFIAPI *NON_DISCOVERABLE_DEVICE_INIT) (
+  IN  NON_DISCOVERABLE_DEVICE       *This
+  );
+
+struct _NON_DISCOVERABLE_DEVICE {
+  //
+  // The type of device
+  //
+  NON_DISCOVERABLE_DEVICE_TYPE        Type;
+  //
+  // Whether this device is DMA coherent
+  //
+  NON_DISCOVERABLE_DEVICE_DMA_TYPE    DmaType;
+  //
+  // Initialization function for the device
+  //
+  NON_DISCOVERABLE_DEVICE_INIT        Initialize;
+  //
+  // The MMIO and I/O regions owned by the device
+  //
+  EFI_ACPI_ADDRESS_SPACE_DESCRIPTOR   *Resources;
+};
+
+extern EFI_GUID gEdkiiNonDiscoverableDeviceProtocolGuid;
+
+#endif
diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec
index 74b870051c67..6b956fc80c93 100644
--- a/MdeModulePkg/MdeModulePkg.dec
+++ b/MdeModulePkg/MdeModulePkg.dec
@@ -505,6 +505,9 @@  [Protocols]
   #  Include/Protocol/Ps2Policy.h
   gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE, 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 } }
 
+  ## Include/Protocol/NonDiscoverableDevice.h
+  gEdkiiNonDiscoverableDeviceProtocolGuid = { 0x0d51905b, 0xb77e, 0x452a, {0xa2, 0xc0, 0xec, 0xa0, 0xcc, 0x8d, 0x51, 0x4a } }
+
 #
 # [Error.gEfiMdeModulePkgTokenSpaceGuid]
 #   0x80000001 | Invalid value provided.