IdeController.c revision 4fd606d1f5abe38e1f42c38de1d2e895166bd0f4
/* $Id$ */
/** @file
*/
/*
* Copyright (C) 2009-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
/** @file
This driver module produces IDE_CONTROLLER_INIT protocol and will be used by
IDE Bus driver to support platform dependent timing information. This driver
is responsible for early initialization of IDE controller.
Copyright (c) 2008 - 2009 Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#include "IdeController.h"
//
// EFI_DRIVER_BINDING_PROTOCOL instance
//
0xa,
NULL,
};
//
// EFI_IDE_CONTROLLER_PROVATE_DATA Template
//
};
//
// EFI_ATA_COLLECTIVE_MODE Template
//
{
TRUE, // PioMode.Valid
0 // PioMode.Mode
},
{
TRUE, // SingleWordDmaMode.Valid
0
},
{
FALSE, // MultiWordDmaMode.Valid
0
},
{
TRUE, // UdmaMode.Valid
0 // UdmaMode.Mode
}
};
)
/*++
Routine Description:
Chipset Ide Driver EntryPoint function. It follows the standard EFI driver
model. It's called by StartImage() of DXE Core
Arguments:
ImageHandle -- While the driver image loaded be the ImageLoader(),
an image handle is assigned to this driver binary,
all activities of the driver is tied to this ImageHandle
*SystemTable -- A pointer to the system table, for all BS(Boo Services) and
RT(Runtime Services)
Returns:
Always call EfiLibInstallDriverBindingProtocol( ) and return the result
--*/
{
//
// Install driver model protocol(s).
//
);
return Status;
}
)
/*++
Routine Description:
Register Driver Binding protocol for this driver.
Arguments:
This -- a pointer points to the Binding Protocol instance
Controller -- The handle of controller to be tested.
*RemainingDevicePath -- A pointer to the device path. Ignored by device
driver but used by bus driver
Returns:
EFI_SUCCESS -- Driver loaded.
other -- Driver not loaded.
--*/
{
//
// Attempt to Open PCI I/O Protocol
//
);
return Status;
}
//
// Now further check the PCI header: Base class (offset 0x0B) and
// Sub Class (offset 0x0A). This controller should be an Ide controller
//
PCI_CLASSCODE_OFFSET + 2,
1,
);
goto Done;
}
PCI_CLASSCODE_OFFSET + 1,
1,
);
goto Done;
}
//
// Examine Ide PCI Configuration table fields
//
if ((PciClass != PCI_CLASS_MASS_STORAGE) || ((PciSubClass != PCI_CLASS_MASS_STORAGE_IDE) && (PciSubClass != 0x06 /*SATA*/))) {
}
if (PciSubClass == 0x6)
Done:
gBS->CloseProtocol (
);
return Status;
}
)
/*++
Routine Description:
This routine is called right after the .Supported() called and return
EFI_SUCCESS. Notes: The supported protocols are checked but the Protocols
are closed.
Arguments:
This -- a pointer points to the Binding Protocol instance
Controller -- The handle of controller to be tested. Parameter
passed by the caller
*RemainingDevicePath -- A pointer to the device path. Should be ignored by
device driver
--*/
{
//
// Now test and open the EfiPciIoProtocol
//
);
//
// Status == EFI_SUCCESS - A normal execution flow, SUCCESS and the program proceeds.
// Status == ALREADY_STARTED - A non-zero Status code returned. It indicates
// that the protocol has been opened and should be treated as a
// normal condition and the program proceeds. The Protocol will not
// opened 'again' by this call.
// Status != ALREADY_STARTED - Error status, terminate program execution
//
return Status;
}
//
// Install IDE_CONTROLLER_INIT protocol
//
return gBS->InstallMultipleProtocolInterfaces (
);
}
)
/*++
Routine Description:
Stop this driver on Controller Handle.
Arguments:
This - Protocol instance pointer.
Controller - Handle of device to stop driver on
NumberOfChildren - Not used
ChildHandleBuffer - Not used
Returns:
EFI_SUCCESS - This driver is removed DeviceHandle
other - This driver was not removed from this device
--*/
{
//
// Open the produced protocol
//
(VOID **) &IdeControllerInit,
);
return EFI_UNSUPPORTED;
}
//
// Make sure the protocol was produced by this driver
//
if (IdeControllerInit != &gEfiIdeControllerInit) {
return EFI_UNSUPPORTED;
}
//
// Uninstall the IDE Controller Init Protocol
//
);
return Status;
}
//
// Close protocols opened by Ide controller driver
//
return gBS->CloseProtocol (
);
}
//
// Interface functions of IDE_CONTROLLER_INIT protocol
//
)
/*++
Routine Description:
This function can be used to obtain information about a specified channel.
It's usually used by IDE Bus driver during enumeration process.
Arguments:
This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
Channel -- Channel number (0 based, either 0 or 1)
Enabled -- TRUE if the channel is enabled. If the channel is disabled,
then it will no be enumerated.
MaxDevices -- The Max number of IDE devices that the bus driver can expect
Returns:
EFI_STATUS
--*/
{
//
// Channel number (0 based, either 0 or 1)
//
if (Channel < ICH_IDE_MAX_CHANNEL) {
return EFI_SUCCESS;
}
return EFI_INVALID_PARAMETER;
}
)
/*++
Routine Description:
This function is called by IdeBus driver before executing certain actions.
This allows IDE Controller Init to prepare for each action.
Arguments:
This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
Phase -- phase indicator defined by IDE_CONTROLLER_INIT protocol
Channel -- Channel number (0 based, either 0 or 1)
Returns:
--*/
{
return EFI_SUCCESS;
}
)
/*++
Routine Description:
This function is called by IdeBus driver to submit EFI_IDENTIFY_DATA data structure
obtained from IDE deivce. This structure is used to set IDE timing
Arguments:
This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
Channel -- IDE channel number (0 based, either 0 or 1)
Device -- IDE device number
IdentifyData -- A pointer to EFI_IDENTIFY_DATA data structure
Returns:
--*/
{
return EFI_SUCCESS;
}
)
/*++
Routine Description:
This function is called by IdeBus driver to disqualify unsupported operation
mode on specific IDE device
Arguments:
This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
Channel -- IDE channel number (0 based, either 0 or 1)
Device -- IDE device number
BadModes -- Operation mode indicator
Returns:
--*/
{
return EFI_SUCCESS;
}
)
/*++
Routine Description:
This function is called by IdeBus driver to calculate the best operation mode
supported by specific IDE device
Arguments:
This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
Channel -- IDE channel number (0 based, either 0 or 1)
Device -- IDE device number
SupportedModes -- Modes collection supported by IDE device
Returns:
--*/
{
return EFI_INVALID_PARAMETER;
}
*SupportedModes = AllocateCopyPool (sizeof (EFI_ATA_COLLECTIVE_MODE), &gEfiAtaCollectiveModeTemplate);
if (*SupportedModes == NULL) {
return EFI_OUT_OF_RESOURCES;
}
if (gfIdeAhciEmulation)
{
}
return EFI_SUCCESS;
}
)
/*++
Routine Description:
This function is called by IdeBus driver to set appropriate timing on IDE
controller according supported operation mode
Arguments:
This -- the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
Channel -- IDE channel number (0 based, either 0 or 1)
Device -- IDE device number
Returns:
--*/
{
return EFI_SUCCESS;
}