MaxOS::drivers::Driver Class Reference

base class for all drivers, handles the activation, deactivation, initialisation and reset of the driver as well as error messages and identifying the device More...

#include <driver.h>

Inheritance diagram for MaxOS::drivers::Driver:

Public Member Functions
virtual void	activate ()
	Activate the driver.
virtual void	deactivate ()
	Deactivate the driver.
virtual void	initialise ()
	Initialise the driver.
virtual uint32_t	reset ()
	Reset the driver.
virtual string	vendor_name ()
	Get who created the device.
virtual string	device_name ()
	Get the device name of the driver.

Detailed Description

base class for all drivers, handles the activation, deactivation, initialisation and reset of the driver as well as error messages and identifying the device

Definition at line 27 of file driver.h.

Member Function Documentation

activate()

void Driver::activate ( )

virtual

Activate the driver.

Reimplemented in MaxOS::drivers::disk::IntegratedDriveElectronicsController, MaxOS::drivers::ethernet::AMD_AM79C973, MaxOS::drivers::ethernet::IntelI217, MaxOS::drivers::peripherals::KeyboardDriver, MaxOS::drivers::peripherals::MouseDriver, MaxOS::drivers::clock::Clock, and MaxOS::drivers::disk::Disk.

Definition at line 25 of file driver.cpp.

                      {
 
}

Referenced by MaxOS::drivers::disk::Disk::activate().

deactivate()

void Driver::deactivate ( )

virtual

Deactivate the driver.

Reimplemented in MaxOS::drivers::ethernet::AMD_AM79C973, and MaxOS::drivers::ethernet::IntelI217.

Definition at line 32 of file driver.cpp.

                        {
 
}

Referenced by MaxOS::drivers::ethernet::IntelI217::deactivate().

device_name()

string Driver::device_name ( )

virtual

Get the device name of the driver.

Returns

The device name of the driver

Reimplemented in MaxOS::drivers::clock::Clock, MaxOS::drivers::disk::AdvancedTechnologyAttachment, MaxOS::drivers::disk::IntegratedDriveElectronicsController, MaxOS::drivers::ethernet::AMD_AM79C973, MaxOS::drivers::ethernet::IntelI217, MaxOS::drivers::peripherals::KeyboardDriver, MaxOS::drivers::peripherals::MouseDriver, MaxOS::drivers::video::VideoElectronicsStandardsAssociation, MaxOS::drivers::video::VideoGraphicsArray, and MaxOS::drivers::disk::Disk.

Definition at line 66 of file driver.cpp.

                           {
    return "Unknown Driver";
}

initialise()

void Driver::initialise ( )

virtual

Initialise the driver.

Reimplemented in MaxOS::drivers::disk::IntegratedDriveElectronicsController.

Definition at line 39 of file driver.cpp.

                        {
 
}

reset()

uint32_t Driver::reset ( )

virtual

Reset the driver.

Returns

How long in milliseconds it took to reset the driver

Reimplemented in MaxOS::drivers::ethernet::AMD_AM79C973, and MaxOS::drivers::ethernet::IntelI217.

Definition at line 48 of file driver.cpp.

                       {
    return 0;
}

Referenced by MaxOS::drivers::ethernet::IntelI217::reset().

vendor_name()

string Driver::vendor_name ( )

virtual

Get who created the device.

Returns

The vendor name of the driver

Reimplemented in MaxOS::drivers::clock::Clock, MaxOS::drivers::disk::AdvancedTechnologyAttachment, MaxOS::drivers::disk::IntegratedDriveElectronicsController, MaxOS::drivers::ethernet::AMD_AM79C973, MaxOS::drivers::ethernet::IntelI217, MaxOS::drivers::video::VideoElectronicsStandardsAssociation, MaxOS::drivers::video::VideoGraphicsArray, and MaxOS::drivers::disk::Disk.

Definition at line 57 of file driver.cpp.

                           {
    return "Generic";
}

---

The documentation for this class was generated from the following files:

• /home/runner/work/MaxOS/MaxOS/kernel/include/drivers/driver.h
• /home/runner/work/MaxOS/MaxOS/kernel/src/drivers/driver.cpp