ExtScsiPassThru support for Logical SCSI devices

ExtScsiPassThru support for Logical SCSI devices

[Ravi Kumar Siadri]

[-- Attachment #1: Type: text/plain, Size: 1611 bytes --]

Hi all,

I have couple of queries regarding the *EFI_EXT_SCSI_PASS_THRU_ ATTRIBUTES_LOGICAL* attribute support in *EFI_EXT_SCSI_PASS_THRU_ PROTOCOL*.

*1.*
*The Attributes field of the EFI_EXT_SCSI_PASS_THRU_ PROTOCOL interface tells if the interface is for physical SCSI devices or logical SCSI devices. Drivers for non-RAID SCSI controllers will set both the EFI_EXT_SCSI_PASS_THRU_ ATTRIBUTES_PHYSICAL, and the EFI_EXT_SCSI_PASS_THRU_ ATTRIBUTES_LOGICAL bits.*

If the Drivers is for non-RAID SCSI controllers why to set the EFI_EXT_SCSI_PASS_THRU_ ATTRIBUTES_LOGICAL bit. Will there be any case that non-RAID SCSI controllers have Logical devices connected to it ??
**
*2.*
*Drivers for RAID controllers that allow access to the physical devices and logical devices will produce two EFI_EXT_SCSI_PASS_THRU_ PROTOCOL interfaces:*
*One with the just the EFI_EXT_SCSI_PASS_THRU_ ATTRIBUTES_PHYSICAL bit set and another with just the EFI_EXT_SCSI_PASS_THRU_ ATTRIBUTES_LOGICAL bit set. One interface can be used to access the physical devices attached to the RAID controller, and the other can be used to access the logical devices attached to the RAID controller for its current configuration.*

Any background why EFI_EXT_SCSI_PASS_THRU_ PROTOCOL needed 2 instances ? why can't we install attributes EFI_EXT_SCSI_PASS_THRU_ ATTRIBUTES_LOGICAL and EFI_EXT_SCSI_PASS_THRU_ ATTRIBUTES_PHYSICAL on same Instance ??
How User locates the Instance with EFI_EXT_SCSI_PASS_THRU_ ATTRIBUTES_LOGICAL bit set and Instance with EFI_EXT_SCSI_PASS_THRU_ ATTRIBUTES_PHYSICAL bit set. ??

Thanks,
Ravi Kumar

[-- Attachment #2: Type: text/html, Size: 3660 bytes --]

Re: ExtScsiPassThru support for Logical SCSI devices

[Ravi Kumar Siadri]

[-- Attachment #1: Type: text/plain, Size: 1816 bytes --]

Hi,

Can someone help me in clarifying my queries ??

Thanks,
Ravi Kumar

On Mon, Jun 10, 2019 at 3:55 PM Ravi Kumar Siadri <
siadriravikumaruefi@gmail.com> wrote:

> Hi all,
>
> I have couple of queries regarding the
> *EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL* attribute support in
> *EFI_EXT_SCSI_PASS_THRU_PROTOCOL*.
>
> *1. *
> *The Attributes field of the EFI_EXT_SCSI_PASS_THRU_PROTOCOL interface
> tells if the interface is for physical SCSI devices or logical SCSI
> devices. Drivers for non-RAID SCSI controllers will set both the
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL, and the
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bits.*
>
> If the Drivers is for non-RAID SCSI controllers why to set the
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit. Will there be any case that
> non-RAID SCSI controllers have Logical devices connected to it ??
>
> *2. *
> *Drivers for RAID controllers that allow access to the physical devices
> and logical devices will produce two EFI_EXT_SCSI_PASS_THRU_PROTOCOL
> interfaces:  *
> *One with the just the EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL bit set
> and another with just the EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit
> set. One interface can be used to access the physical devices attached to
> the RAID controller, and the other can be used to access the logical
> devices attached to the RAID controller for its current configuration.*
>
> Any background why EFI_EXT_SCSI_PASS_THRU_PROTOCOL needed 2 instances ?
> why can't we install attributes EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL
> and EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL on same Instance ??
> How User locates the Instance with
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit set and Instance with
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL bit set. ??
>
> Thanks,
> Ravi Kumar
>
>

[-- Attachment #2: Type: text/html, Size: 2458 bytes --]

Re: [edk2-devel] ExtScsiPassThru support for Logical SCSI devices

[Laszlo Ersek]

On 06/10/19 14:32, Ravi Kumar Siadri wrote:
> Hi all,
>
> I have couple of queries regarding the
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL attribute support in
> EFI_EXT_SCSI_PASS_THRU_PROTOCOL.
>
> 1.
> The Attributes field of the EFI_EXT_SCSI_PASS_THRU_PROTOCOL interface
> tells if the interface is for physical SCSI devices or logical SCSI
> devices. Drivers for non-RAID SCSI controllers will set both the
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL, and the
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bits.
>
> If the Drivers is for non-RAID SCSI controllers why to set the
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit. Will there be any case
> that non-RAID SCSI controllers have Logical devices connected to it ??
>
> 2.
> Drivers for RAID controllers that allow access to the physical devices
> and logical devices will produce two EFI_EXT_SCSI_PASS_THRU_PROTOCOL
> interfaces: One with the just the
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL bit set and another with
> just the EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit set. One
> interface can be used to access the physical devices attached to the
> RAID controller, and the other can be used to access the logical
> devices attached to the RAID controller for its current configuration.
>
> Any background why EFI_EXT_SCSI_PASS_THRU_PROTOCOL needed 2 instances
> ? why can't we install attributes
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL and
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL on same Instance ?? How
> User locates the Instance with
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit set and Instance with
> EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL bit set. ??

Please consult the UEFI Driver Writer's Guide on these questions. (What
I have on my disk now is Version 1.01, for UEFI 2.3.1, released
03/08/2012.)

Excerpts:

> 6.3 Hybrid drivers
>
> [...]
>
> A driver for a multi-channel RAID SCSI host controller is a hybrid
> driver. It produces the Extended SCSI Pass Thru Protocol (with the
> logical bit on) on the controller handle and creates child handles
> with Extended SCSI Pass Thru Protocol for each physical channel (with
> the logical bit off).

> 20.1.3 SCSI Adapters with RAID
>
> A SCSI host controller driver may also support SCSI adapters with RAID
> capability. The following figure shows an example implementation with
> two physical SCSI channels and one logical channel. The two physical
> channels are implemented on the SCSI adapter. The RAID component then
> configures these two channels to produce a logical SCSI channel. The
> two physical channels each have Extended SCSI Pass Thru installed, but
> these are not be used except for diagnostic use. For the logical
> channel, the SCSI host controller driver produces another Extended
> SCSI Pass Thru Protocol (with physical bit turned off) instance based
> on the RAID configuration. Requests sent to the Extended SCSI Pass
> Thru protocol for the logical channel are processed by the SCSI host
> controller drivers and converted into requests on the physical SCSI
> channels. The platform firmware must only enumerate and boot from SCSI
> targets present on the logical SCSI channel.
>
> The SCSI adapter hardware may not be able to expose the physical SCSI
> channel(s) to upper-level software when implementing RAID. If the
> physical SCSI channel cannot be exposed to upper software, then the
> SCSI host controller driver is only required to produce a single
> logical channel for the RAID.
>
> Although the basic theory is the same as the one on a physical
> channel, it is different from a manufacturing and diagnostic
> perspective. If the physical SCSI channels are exposed, any SCSI
> command, including diagnostic ones, can be sent to an individual
> channel, which is very helpful on manufacturing lines. Furthermore,
> the diagnostic command can be sent simultaneously to all physical
> channels using the non-blocking mode that is supported by Extended
> SCSI Pass Thru Protocol. The diagnostic process may considerably
> benefit from the performance gain. In summary, it is suggested to
> expose physical SCSI channel whenever possible.

> 20.1.4.2 Start()
>
> [...]
>
> The Start() function tells the SCSI host controller driver to start
> managing the SCSI host controller. In this function, a single channel
> SCSI host controller driver uses chip-specific knowledge to perform
> the following tasks:
> * Initialize the SCSI host controller.
> * Enable the PCI device.
> * Allocate resources.
> * Construct data structures for the driver to use.
> * Install the Extended SCSI Pass Thru Protocol instance on the same
>   handle that has the PCI I/O Protocol.
>
> If the SCSI adapter is a multi-channel adapter, then the driver should
> also do the following:
>
> Enumerate the SCSI channels that are supported by the SCSI host
> controller.
> * Create child handles for each physical SCSI channel.
> * Append the device path for each channel handle.
> * Install the Device Path Protocol and Extended SCSI Pass Thru
>   Protocol on every newly created channel handle.

---------

So the trick is that the parent controller is the logical one (the
combined device -- the array), and the child controllers are the
physical ones (the individual "inexpensive" disks). The platform
firmware will ignore the individual physical disks for all intents and
purposes, but on "manufacturing lines", exposing the physical disks is
good for diagnosing problems.

Regarding the device paths of the child controllers: you can build the
device path for each child controller for example by appending a
VenMsg() device path node to the parent controller's device path. The
opaque data bytes in the VenMsg() node would carry hardware specific
identifying information for the individual physical disk.

If you don't want to expose the physical ("inexpensive") disks for any
purpose, then don't write a hybrid driver -- write a device driver.
Install EFI_ATA_PASS_THRU_PROTOCOL only on the "parent" handle (the one
with PciIo), produce no child handles, and set only the logical
attribute bit.

Thanks
Laszlo

Re: [edk2-devel] ExtScsiPassThru support for Logical SCSI devices

[Wu, Hao A]

> -----Original Message-----
> From: Laszlo Ersek [mailto:lersek@redhat.com]
> Sent: Saturday, July 13, 2019 6:11 AM
> To: siadriravikumaruefi@gmail.com
> Cc: devel@edk2.groups.io; Wu, Hao A; Cetola, Stephano
> Subject: Re: [edk2-devel] ExtScsiPassThru support for Logical SCSI devices
> 
> On 06/10/19 14:32, Ravi Kumar Siadri wrote:
> > Hi all,
> >
> > I have couple of queries regarding the
> > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL attribute support in
> > EFI_EXT_SCSI_PASS_THRU_PROTOCOL.
> >
> > 1.
> > The Attributes field of the EFI_EXT_SCSI_PASS_THRU_PROTOCOL interface
> > tells if the interface is for physical SCSI devices or logical SCSI
> > devices. Drivers for non-RAID SCSI controllers will set both the
> > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL, and the
> > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bits.
> >
> > If the Drivers is for non-RAID SCSI controllers why to set the
> > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit. Will there be any
> case
> > that non-RAID SCSI controllers have Logical devices connected to it ??
> >
> > 2.
> > Drivers for RAID controllers that allow access to the physical devices
> > and logical devices will produce two EFI_EXT_SCSI_PASS_THRU_PROTOCOL
> > interfaces: One with the just the
> > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL bit set and another
> with
> > just the EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit set. One
> > interface can be used to access the physical devices attached to the
> > RAID controller, and the other can be used to access the logical
> > devices attached to the RAID controller for its current configuration.
> >
> > Any background why EFI_EXT_SCSI_PASS_THRU_PROTOCOL needed 2
> instances
> > ? why can't we install attributes
> > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL and
> > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL on same Instance ??
> How
> > User locates the Instance with
> > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit set and Instance with
> > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL bit set. ??
> 
> Please consult the UEFI Driver Writer's Guide on these questions. (What
> I have on my disk now is Version 1.01, for UEFI 2.3.1, released
> 03/08/2012.)

Thanks Laszlo,

The information mentioned above is really helpful.

As a supplementary, the UEFI Driver Writer's Guide is also available online at:
https://edk2-docs.gitbooks.io/edk-ii-uefi-driver-writer-s-guide/

Best Regards,
Hao Wu

> 
> Excerpts:
> 
> > 6.3 Hybrid drivers
> >
> > [...]
> >
> > A driver for a multi-channel RAID SCSI host controller is a hybrid
> > driver. It produces the Extended SCSI Pass Thru Protocol (with the
> > logical bit on) on the controller handle and creates child handles
> > with Extended SCSI Pass Thru Protocol for each physical channel (with
> > the logical bit off).
> 
> > 20.1.3 SCSI Adapters with RAID
> >
> > A SCSI host controller driver may also support SCSI adapters with RAID
> > capability. The following figure shows an example implementation with
> > two physical SCSI channels and one logical channel. The two physical
> > channels are implemented on the SCSI adapter. The RAID component then
> > configures these two channels to produce a logical SCSI channel. The
> > two physical channels each have Extended SCSI Pass Thru installed, but
> > these are not be used except for diagnostic use. For the logical
> > channel, the SCSI host controller driver produces another Extended
> > SCSI Pass Thru Protocol (with physical bit turned off) instance based
> > on the RAID configuration. Requests sent to the Extended SCSI Pass
> > Thru protocol for the logical channel are processed by the SCSI host
> > controller drivers and converted into requests on the physical SCSI
> > channels. The platform firmware must only enumerate and boot from SCSI
> > targets present on the logical SCSI channel.
> >
> > The SCSI adapter hardware may not be able to expose the physical SCSI
> > channel(s) to upper-level software when implementing RAID. If the
> > physical SCSI channel cannot be exposed to upper software, then the
> > SCSI host controller driver is only required to produce a single
> > logical channel for the RAID.
> >
> > Although the basic theory is the same as the one on a physical
> > channel, it is different from a manufacturing and diagnostic
> > perspective. If the physical SCSI channels are exposed, any SCSI
> > command, including diagnostic ones, can be sent to an individual
> > channel, which is very helpful on manufacturing lines. Furthermore,
> > the diagnostic command can be sent simultaneously to all physical
> > channels using the non-blocking mode that is supported by Extended
> > SCSI Pass Thru Protocol. The diagnostic process may considerably
> > benefit from the performance gain. In summary, it is suggested to
> > expose physical SCSI channel whenever possible.
> 
> > 20.1.4.2 Start()
> >
> > [...]
> >
> > The Start() function tells the SCSI host controller driver to start
> > managing the SCSI host controller. In this function, a single channel
> > SCSI host controller driver uses chip-specific knowledge to perform
> > the following tasks:
> > * Initialize the SCSI host controller.
> > * Enable the PCI device.
> > * Allocate resources.
> > * Construct data structures for the driver to use.
> > * Install the Extended SCSI Pass Thru Protocol instance on the same
> >   handle that has the PCI I/O Protocol.
> >
> > If the SCSI adapter is a multi-channel adapter, then the driver should
> > also do the following:
> >
> > Enumerate the SCSI channels that are supported by the SCSI host
> > controller.
> > * Create child handles for each physical SCSI channel.
> > * Append the device path for each channel handle.
> > * Install the Device Path Protocol and Extended SCSI Pass Thru
> >   Protocol on every newly created channel handle.
> 
> ---------
> 
> So the trick is that the parent controller is the logical one (the
> combined device -- the array), and the child controllers are the
> physical ones (the individual "inexpensive" disks). The platform
> firmware will ignore the individual physical disks for all intents and
> purposes, but on "manufacturing lines", exposing the physical disks is
> good for diagnosing problems.
> 
> Regarding the device paths of the child controllers: you can build the
> device path for each child controller for example by appending a
> VenMsg() device path node to the parent controller's device path. The
> opaque data bytes in the VenMsg() node would carry hardware specific
> identifying information for the individual physical disk.
> 
> If you don't want to expose the physical ("inexpensive") disks for any
> purpose, then don't write a hybrid driver -- write a device driver.
> Install EFI_ATA_PASS_THRU_PROTOCOL only on the "parent" handle (the
> one
> with PciIo), produce no child handles, and set only the logical
> attribute bit.
> 
> Thanks
> Laszlo

Re: [edk2-devel] ExtScsiPassThru support for Logical SCSI devices

[Ravi Kumar Siadri]

[-- Attachment #1: Type: text/plain, Size: 10612 bytes --]

Hi Laszlo Ersek / Hao Wu,

I have gone through the Guide, i can see some points which are not very
clear..

*1.  *
*Single-Channel SCSI Adapters*
*If the SCSI adapter supports one channel, then the SCSI host controller
driver*
*performs the following:*
*• Install Extended SCSI Pass Thru Protocol onto the controller handle for
the*
*SCSI host controller.*
*• Set the logical attribute for the SCSI channel in the mode structure.*
*• Set the physical attribute for the SCSI channel in the mode structure.*

*The platform firmware must only enumerate and boot from SCSI targets
present on the logical SCSI channel.*

Suppose a HBA controller (non RAID) has only Physical Devices connected to
it.(logical devices cannot be created on it).
What is the point in setting *logical attribute *in SCSI passthru handle,
when a controller cannot produce logical devices (as it is non RAID) ??

UEFI spec say logical SCSI passthru handle is to access the logical devices
attached to the RAID controller. Then what is the dependency here to
produce child handles (Block IO protocol) of Physical devices with the
logical SCSI passthru handle, when the controller cannot produce a logical
devices ??


*2. *
*EFI_EXT_SCSI_PASS_THRU_PROTOCOL.Mode is a structure that describes the
intrinsic*
*attributes of Extended SCSI Pass Thru Protocol instance. Note that a
non-RAID SCSI*
*channel sets both the physical and logical attributes. A physical channel
on the RAID*
*adapter only sets the physical attribute, and the logical channel on the
RAID adapter*
*only sets the logical attribute. If the channel supports non-blocking I/O,
the nonblocking attribute is also set*

*Of course, there are many possible designs for implementing SCSI RAID
functionality.*
*The point is that an SCSI host controller driver may be designed and
implemented for a*
*wide variety of SCSI adapters types, and those SCSI host controller
drivers can*
*produce the Extended SCSI Pass Thru Protocol for SCSI channels that
contain SCSI*
*targets that may be used as UEFI boot devices.*

All the implementations recommended are hacks/tricks to achieve the spec
defined way of SCSI pass Thru. To acheive this each Producers of scsi pass
thru protocol can follow a multiple ways. If this happens how a Consumer of
scsi pass thru (application or other drivers) can figure out the
implementation of producer if it is not defined in any standard
specification ?? how the producer and consumer of SCSI passthru are inline
??

I feel the current design is an over head and not cleary defined by UEFI
specification. Can't we update the way of implementation ??
I have a new design proposal which can make a scsi pass thru protocol more
clear and simple. Can you please check and comment on this.
https://edk2.groups.io/g/devel/files/Designs/2019/0710
<https://edk2.groups.io/g/devel/files/Designs/2019/0710>

I think the Driver Writer's Guide is designed by assuming the RAID
controllers will expose/produce only Logical Devices, but a there are some
RAID controllers which exposes a mix of Physical and Logical Devices (RAID
devices) as well.

Thanks,
Ravi Kumar

On Mon, Jul 15, 2019 at 10:55 AM Wu, Hao A <hao.a.wu@intel.com> wrote:

> > -----Original Message-----
> > From: Laszlo Ersek [mailto:lersek@redhat.com]
> > Sent: Saturday, July 13, 2019 6:11 AM
> > To: siadriravikumaruefi@gmail.com
> > Cc: devel@edk2.groups.io; Wu, Hao A; Cetola, Stephano
> > Subject: Re: [edk2-devel] ExtScsiPassThru support for Logical SCSI
> devices
> >
> > On 06/10/19 14:32, Ravi Kumar Siadri wrote:
> > > Hi all,
> > >
> > > I have couple of queries regarding the
> > > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL attribute support in
> > > EFI_EXT_SCSI_PASS_THRU_PROTOCOL.
> > >
> > > 1.
> > > The Attributes field of the EFI_EXT_SCSI_PASS_THRU_PROTOCOL interface
> > > tells if the interface is for physical SCSI devices or logical SCSI
> > > devices. Drivers for non-RAID SCSI controllers will set both the
> > > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL, and the
> > > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bits.
> > >
> > > If the Drivers is for non-RAID SCSI controllers why to set the
> > > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit. Will there be any
> > case
> > > that non-RAID SCSI controllers have Logical devices connected to it ??
> > >
> > > 2.
> > > Drivers for RAID controllers that allow access to the physical devices
> > > and logical devices will produce two EFI_EXT_SCSI_PASS_THRU_PROTOCOL
> > > interfaces: One with the just the
> > > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL bit set and another
> > with
> > > just the EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit set. One
> > > interface can be used to access the physical devices attached to the
> > > RAID controller, and the other can be used to access the logical
> > > devices attached to the RAID controller for its current configuration.
> > >
> > > Any background why EFI_EXT_SCSI_PASS_THRU_PROTOCOL needed 2
> > instances
> > > ? why can't we install attributes
> > > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL and
> > > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL on same Instance ??
> > How
> > > User locates the Instance with
> > > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL bit set and Instance with
> > > EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL bit set. ??
> >
> > Please consult the UEFI Driver Writer's Guide on these questions. (What
> > I have on my disk now is Version 1.01, for UEFI 2.3.1, released
> > 03/08/2012.)
>
> Thanks Laszlo,
>
> The information mentioned above is really helpful.
>
> As a supplementary, the UEFI Driver Writer's Guide is also available
> online at:
> https://edk2-docs.gitbooks.io/edk-ii-uefi-driver-writer-s-guide/
>
> Best Regards,
> Hao Wu
>
> >
> > Excerpts:
> >
> > > 6.3 Hybrid drivers
> > >
> > > [...]
> > >
> > > A driver for a multi-channel RAID SCSI host controller is a hybrid
> > > driver. It produces the Extended SCSI Pass Thru Protocol (with the
> > > logical bit on) on the controller handle and creates child handles
> > > with Extended SCSI Pass Thru Protocol for each physical channel (with
> > > the logical bit off).
> >
> > > 20.1.3 SCSI Adapters with RAID
> > >
> > > A SCSI host controller driver may also support SCSI adapters with RAID
> > > capability. The following figure shows an example implementation with
> > > two physical SCSI channels and one logical channel. The two physical
> > > channels are implemented on the SCSI adapter. The RAID component then
> > > configures these two channels to produce a logical SCSI channel. The
> > > two physical channels each have Extended SCSI Pass Thru installed, but
> > > these are not be used except for diagnostic use. For the logical
> > > channel, the SCSI host controller driver produces another Extended
> > > SCSI Pass Thru Protocol (with physical bit turned off) instance based
> > > on the RAID configuration. Requests sent to the Extended SCSI Pass
> > > Thru protocol for the logical channel are processed by the SCSI host
> > > controller drivers and converted into requests on the physical SCSI
> > > channels. The platform firmware must only enumerate and boot from SCSI
> > > targets present on the logical SCSI channel.
> > >
> > > The SCSI adapter hardware may not be able to expose the physical SCSI
> > > channel(s) to upper-level software when implementing RAID. If the
> > > physical SCSI channel cannot be exposed to upper software, then the
> > > SCSI host controller driver is only required to produce a single
> > > logical channel for the RAID.
> > >
> > > Although the basic theory is the same as the one on a physical
> > > channel, it is different from a manufacturing and diagnostic
> > > perspective. If the physical SCSI channels are exposed, any SCSI
> > > command, including diagnostic ones, can be sent to an individual
> > > channel, which is very helpful on manufacturing lines. Furthermore,
> > > the diagnostic command can be sent simultaneously to all physical
> > > channels using the non-blocking mode that is supported by Extended
> > > SCSI Pass Thru Protocol. The diagnostic process may considerably
> > > benefit from the performance gain. In summary, it is suggested to
> > > expose physical SCSI channel whenever possible.
> >
> > > 20.1.4.2 Start()
> > >
> > > [...]
> > >
> > > The Start() function tells the SCSI host controller driver to start
> > > managing the SCSI host controller. In this function, a single channel
> > > SCSI host controller driver uses chip-specific knowledge to perform
> > > the following tasks:
> > > * Initialize the SCSI host controller.
> > > * Enable the PCI device.
> > > * Allocate resources.
> > > * Construct data structures for the driver to use.
> > > * Install the Extended SCSI Pass Thru Protocol instance on the same
> > >   handle that has the PCI I/O Protocol.
> > >
> > > If the SCSI adapter is a multi-channel adapter, then the driver should
> > > also do the following:
> > >
> > > Enumerate the SCSI channels that are supported by the SCSI host
> > > controller.
> > > * Create child handles for each physical SCSI channel.
> > > * Append the device path for each channel handle.
> > > * Install the Device Path Protocol and Extended SCSI Pass Thru
> > >   Protocol on every newly created channel handle.
> >
> > ---------
> >
> > So the trick is that the parent controller is the logical one (the
> > combined device -- the array), and the child controllers are the
> > physical ones (the individual "inexpensive" disks). The platform
> > firmware will ignore the individual physical disks for all intents and
> > purposes, but on "manufacturing lines", exposing the physical disks is
> > good for diagnosing problems.
> >
> > Regarding the device paths of the child controllers: you can build the
> > device path for each child controller for example by appending a
> > VenMsg() device path node to the parent controller's device path. The
> > opaque data bytes in the VenMsg() node would carry hardware specific
> > identifying information for the individual physical disk.
> >
> > If you don't want to expose the physical ("inexpensive") disks for any
> > purpose, then don't write a hybrid driver -- write a device driver.
> > Install EFI_ATA_PASS_THRU_PROTOCOL only on the "parent" handle (the
> > one
> > with PciIo), produce no child handles, and set only the logical
> > attribute bit.
> >
> > Thanks
> > Laszlo
>

[-- Attachment #2: Type: text/html, Size: 12916 bytes --]

Re: [edk2-devel] ExtScsiPassThru support for Logical SCSI devices

[Laszlo Ersek]

On 07/18/19 18:02, Ravi Kumar Siadri wrote:
> Hi Laszlo Ersek / Hao Wu,
>
> I have gone through the Guide, i can see some points which are not
> very clear..
>
> [...]

Perhaps some examples will help.

In advance, I should mention a few things:

- This is just my interpretation of the spec, and of the guide.

- In my last email, the VenMsg suggestion was wrong. The device paths
  for the physical channel(s) are built by appending Ctrl(n) --
  "controller" -- hardware device path nodes, and not VenMsg() nodes.

- "Logical" means "channel with abstract devices, suitable for data
  access & booting", "Physical" means "channel with physical devices,
  used for diagnostics". A channel may be *both*, if each device on it
  is both physical and logical simultaneously -- that is, it can be used
  for data access / booting, and for low-level diagnostics.

So, the examples:

(A) non-RAID HBA

* Summary:

Handle#1: PciRoot(0x0)/Pci(0x1,0x0)               -- channel where each device is (L + P)
Handle#2: PciRoot(0x0)/Pci(0x1,0x0)/Scsi(0x1,0x0) -- disk that is (L + P)

* Details:

Handle#1:

- device path: PciRoot(0x0)/Pci(0x1,0x0)
- handle created by PciBusDxe [= platform firmware]
- device path protocol installed by PciBusDxe
- PciIo protocol installed by PciBusDxe
- ExtScsiPassThru protocol installed by the SCSI HBA driver, through
  consuming PciIo
- Logical bit set in ExtScsiPassThru: meaning that devices enumerated on
  this channel can be used for data access & booting
- Physical bit set in ExtScsiPassThru: meaning that devices enumerated
  on this channel can be sent diagnostic commands

Handle#2:

- device path: PciRoot(0x0)/Pci(0x1,0x0)/Scsi(0x1,0x0)
- handle created by ScsiBusDxe [= platform firmware]
- device path protocol installed by ScsiBusDxe (here: Target=1, Lun=0)
- ScsiIo protocol installed by ScsiBusDxe [= platform firmware], through
  consuming ExtScsiPassThru on Handle#1
- BlockIo protocol installed by ScsiDiskDxe [= platform firmware],
  through consuming ScsiIo on the same handle (= Handle#2)


(B) RAID HBA

* Summary:

Handle#1: PciRoot(0x0)/Pci(0x1,0x0)                         -- logical channel
Handle#2: PciRoot(0x0)/Pci(0x1,0x0)/Scsi(0x1,0x0)           -- logical disk
Handle#3: PciRoot(0x0)/Pci(0x1,0x0)/Ctrl(0x0)               -- physical channel
Handle#4: PciRoot(0x0)/Pci(0x1,0x0)/Ctrl(0x0)/Scsi(0x4,0x0) -- physical disk #0
Handle#5  PciRoot(0x0)/Pci(0x1,0x0)/Ctrl(0x0)/Scsi(0x4,0x1) -- physical disk #1

* Details:

Handle#1:

- The same as Handle#1 from (A), except the Physical bit is clear in the
  ExtScsiPassThru protocol instance.
- This handle stands for the logical channel.

Handle#2:
- The same as Handle#2 from (A).
- This handle stands for the logical disk.

Handle#3:
- Device path: PciRoot(0x0)/Pci(0x1,0x0)/Ctrl(0x0).
- Handle created by the SCSI HBA driver.
- Device path installed by the SCSI HBA driver.
- ExtScsiPassThru protocol installed by the SCSI HBA driver, through
  consuming PciIo on Handle#1.
- Logical bit is clear in ExtScsiPassThru.
- Physical bit is set in ExtScsiPassThru.
- This handle stands for the physical channel.

Handle#4:
- Device path: PciRoot(0x0)/Pci(0x1,0x0)/Ctrl(0x0)/Scsi(0x4,0x0)
- Handle created by ScsiBusDxe [= platform firmware].
- Device path protocol installed by ScsiBusDxe (here: Target=4, Lun=0).
- ScsiIo protocol installed by ScsiBusDxe [= platform firmware], through
  consuming ExtScsiPassThru on Handle#3.
- BlockIo protocol is *NOT* installed by ScsiDiskDxe [= platform
  firmware], due to the Logical bit being clear in ExtScsiPassThru on
  Handle#3.
- This handle stands for the first physical disk in the array.

Handle#5:
- Same as Handle#4, with the following differences:
- Device path: PciRoot(0x0)/Pci(0x1,0x0)/Ctrl(0x0)/Scsi(0x4,0x1).
- This handle stands for the second physical disk in the array.

Hope this helps,
Laszlo