ParallelPortImpl.cpp revision cdd02359ba9ceffb2e9bd104a572ad1130091f44
/* $Id$ */
/** @file
* VirtualBox COM class implementation
*/
/*
* Copyright (C) 2006-2007 innotek GmbH
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* 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.
*/
#include "ParallelPortImpl.h"
#include "MachineImpl.h"
#include "VirtualBoxImpl.h"
#include "Logging.h"
#include <iprt/string.h>
#include <iprt/cpputils.h>
// constructor / destructor
/////////////////////////////////////////////////////////////////////////////
DEFINE_EMPTY_CTOR_DTOR (ParallelPort)
HRESULT ParallelPort::FinalConstruct()
{
return S_OK;
}
void ParallelPort::FinalRelease()
{
uninit();
}
// public initializer/uninitializer for internal purposes only
/////////////////////////////////////////////////////////////////////////////
/**
* Initializes the Parallel Port object.
*
* @param aParent Handle of the parent object.
*/
HRESULT ParallelPort::init (Machine *aParent, ULONG aSlot)
{
LogFlowThisFunc (("aParent=%p, aSlot=%d\n", aParent, aSlot));
ComAssertRet (aParent, E_INVALIDARG);
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan (this);
AssertReturn (autoInitSpan.isOk(), E_UNEXPECTED);
unconst (mParent) = aParent;
/* mPeer is left null */
mData.allocate();
/* initialize data */
mData->mSlot = aSlot;
/* Confirm a successful initialization */
autoInitSpan.setSucceeded();
return S_OK;
}
/**
* Initializes the Parallel Port object given another serial port object
* (a kind of copy constructor). This object shares data with
* the object passed as an argument.
*
* @note This object must be destroyed before the original object
* it shares data with is destroyed.
*
* @note Locks @a aThat object for reading.
*/
HRESULT ParallelPort::init (Machine *aParent, ParallelPort *aThat)
{
LogFlowThisFunc (("aParent=%p, aThat=%p\n", aParent, aThat));
ComAssertRet (aParent && aThat, E_INVALIDARG);
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan (this);
AssertReturn (autoInitSpan.isOk(), E_UNEXPECTED);
unconst (mParent) = aParent;
unconst (mPeer) = aThat;
AutoCaller thatCaller (aThat);
AssertComRCReturnRC (thatCaller.rc());
AutoReaderLock thatLock (aThat);
mData.share (aThat->mData);
/* Confirm a successful initialization */
autoInitSpan.setSucceeded();
return S_OK;
}
/**
* Initializes the guest object given another guest object
* (a kind of copy constructor). This object makes a private copy of data
* of the original object passed as an argument.
*
* @note Locks @a aThat object for reading.
*/
HRESULT ParallelPort::initCopy (Machine *aParent, ParallelPort *aThat)
{
LogFlowThisFunc (("aParent=%p, aThat=%p\n", aParent, aThat));
ComAssertRet (aParent && aThat, E_INVALIDARG);
/* Enclose the state transition NotReady->InInit->Ready */
AutoInitSpan autoInitSpan (this);
AssertReturn (autoInitSpan.isOk(), E_UNEXPECTED);
unconst (mParent) = aParent;
/* mPeer is left null */
AutoCaller thatCaller (aThat);
AssertComRCReturnRC (thatCaller.rc());
AutoReaderLock thatLock (aThat);
mData.attachCopy (aThat->mData);
/* Confirm a successful initialization */
autoInitSpan.setSucceeded();
return S_OK;
}
/**
* Uninitializes the instance and sets the ready flag to FALSE.
* Called either from FinalRelease() or by the parent when it gets destroyed.
*/
void ParallelPort::uninit()
{
LogFlowThisFunc (("\n"));
/* Enclose the state transition Ready->InUninit->NotReady */
AutoUninitSpan autoUninitSpan (this);
if (autoUninitSpan.uninitDone())
return;
mData.free();
unconst (mPeer).setNull();
unconst (mParent).setNull();
}
// public methods only for internal purposes
////////////////////////////////////////////////////////////////////////////////
/**
* Loads settings from the given port node.
* May be called once right after this object creation.
*
* @param aPortNode <Port> node.
*
* @note Locks this object for writing.
*/
HRESULT ParallelPort::loadSettings (const settings::Key &aPortNode)
{
using namespace settings;
AssertReturn (!aPortNode.isNull(), E_FAIL);
AutoCaller autoCaller (this);
AssertComRCReturnRC (autoCaller.rc());
AutoLock alock (this);
/* Note: we assume that the default values for attributes of optional
* nodes are assigned in the Data::Data() constructor and don't do it
* here. It implies that this method may only be called after constructing
* a new BIOSSettings object while all its data fields are in the default
* values. Exceptions are fields whose creation time defaults don't match
* values that should be applied when these fields are not explicitly set
* in the settings file (for backwards compatibility reasons). This takes
* place when a setting of a newly created object must default to A while
* the same setting of an object loaded from the old settings file must
* default to B. */
/* enabled (required) */
mData->mEnabled = aPortNode.value <bool> ("enabled");
/* I/O base (required) */
mData->mIOBase = aPortNode.value <ULONG> ("IOBase");
/* IRQ (required) */
mData->mIRQ = aPortNode.value <ULONG> ("IRQ");
/* device path (optional, defaults to null) */
Bstr path = aPortNode.stringValue ("path");
HRESULT rc = checkSetPath (path);
CheckComRCReturnRC (rc);
mData->mPath = path;
return S_OK;
}
/**
* Saves settings to the given port node.
*
* Note that the given Port node is comletely empty on input.
*
* @param aPortNode <Port> node.
*
* @note Locks this object for reading.
*/
HRESULT ParallelPort::saveSettings (settings::Key &aPortNode)
{
using namespace settings;
AssertReturn (!aPortNode.isNull(), E_FAIL);
AutoCaller autoCaller (this);
AssertComRCReturnRC (autoCaller.rc());
AutoReaderLock alock (this);
aPortNode.setValue <bool> ("enabled", !!mData->mEnabled);
aPortNode.setValue <ULONG> ("IOBase", mData->mIOBase, 16);
aPortNode.setValue <ULONG> ("IRQ", mData->mIRQ);
/* 'path' is optional in XML */
if (!mData->mPath.isEmpty())
aPortNode.setValue <Bstr> ("path", mData->mPath);
return S_OK;
}
/**
* @note Locks this object for writing.
*/
bool ParallelPort::rollback()
{
/* sanity */
AutoCaller autoCaller (this);
AssertComRCReturn (autoCaller.rc(), false);
AutoLock alock (this);
bool changed = false;
if (mData.isBackedUp())
{
/* we need to check all data to see whether anything will be changed
* after rollback */
changed = mData.hasActualChanges();
mData.rollback();
}
return changed;
}
/**
* @note Locks this object for writing, together with the peer object (also
* for writing) if there is one.
*/
void ParallelPort::commit()
{
/* sanity */
AutoCaller autoCaller (this);
AssertComRCReturnVoid (autoCaller.rc());
/* sanity too */
AutoCaller peerCaller (mPeer);
AssertComRCReturnVoid (peerCaller.rc());
/* lock both for writing since we modify both (mPeer is "master" so locked
* first) */
AutoMultiWriteLock2 alock (mPeer, this);
if (mData.isBackedUp())
{
mData.commit();
if (mPeer)
{
/* attach new data to the peer and reshare it */
mPeer->mData.attach (mData);
}
}
}
/**
* @note Locks this object for writing, together with the peer object
* represented by @a aThat (locked for reading).
*/
void ParallelPort::copyFrom (ParallelPort *aThat)
{
AssertReturnVoid (aThat != NULL);
/* sanity */
AutoCaller autoCaller (this);
AssertComRCReturnVoid (autoCaller.rc());
/* sanity too */
AutoCaller thatCaller (aThat);
AssertComRCReturnVoid (thatCaller.rc());
/* peer is not modified, lock it for reading (aThat is "master" so locked
* first) */
AutoMultiLock2 alock (aThat->rlock(), this->wlock());
/* this will back up current data */
mData.assignCopy (aThat->mData);
}
// IParallelPort properties
/////////////////////////////////////////////////////////////////////////////
STDMETHODIMP ParallelPort::COMGETTER(Enabled) (BOOL *aEnabled)
{
if (!aEnabled)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoReaderLock alock (this);
*aEnabled = mData->mEnabled;
return S_OK;
}
STDMETHODIMP ParallelPort::COMSETTER(Enabled) (BOOL aEnabled)
{
LogFlowThisFunc (("aEnabled=%RTbool\n", aEnabled));
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* the machine needs to be mutable */
Machine::AutoMutableStateDependency adep (mParent);
CheckComRCReturnRC (adep.rc());
AutoLock alock (this);
if (mData->mEnabled != aEnabled)
{
if (aEnabled &&
mData->mPath.isEmpty())
return setError (E_INVALIDARG,
tr ("Cannot enable the parallel port %d "
"because the port path is empty or null"),
mData->mSlot);
mData.backup();
mData->mEnabled = aEnabled;
/* leave the lock before informing callbacks */
alock.unlock();
mParent->onParallelPortChange (this);
}
return S_OK;
}
STDMETHODIMP ParallelPort::COMGETTER(Slot) (ULONG *aSlot)
{
if (!aSlot)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoReaderLock alock (this);
*aSlot = mData->mSlot;
return S_OK;
}
STDMETHODIMP ParallelPort::COMGETTER(IRQ) (ULONG *aIRQ)
{
if (!aIRQ)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoReaderLock alock (this);
*aIRQ = mData->mIRQ;
return S_OK;
}
STDMETHODIMP ParallelPort::COMSETTER(IRQ)(ULONG aIRQ)
{
/* check IRQ limits
* (when changing this, make sure it corresponds to XML schema */
if (aIRQ > 255)
return setError (E_INVALIDARG,
tr ("Invalid IRQ number of the parallel port %d: "
"%lu (must be in range [0, %lu])"),
mData->mSlot, aIRQ, 255);
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* the machine needs to be mutable */
Machine::AutoMutableStateDependency adep (mParent);
CheckComRCReturnRC (adep.rc());
AutoLock alock (this);
HRESULT rc = S_OK;
bool emitChangeEvent = false;
if (mData->mIRQ != aIRQ)
{
mData.backup();
mData->mIRQ = aIRQ;
emitChangeEvent = true;
}
if (emitChangeEvent)
{
/* leave the lock before informing callbacks */
alock.unlock();
mParent->onParallelPortChange (this);
}
return rc;
}
STDMETHODIMP ParallelPort::COMGETTER(IOBase) (ULONG *aIOBase)
{
if (!aIOBase)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoReaderLock alock (this);
*aIOBase = mData->mIOBase;
return S_OK;
}
STDMETHODIMP ParallelPort::COMSETTER(IOBase)(ULONG aIOBase)
{
/* check IOBase limits
* (when changing this, make sure it corresponds to XML schema */
if (aIOBase > 0xFFFF)
return setError (E_INVALIDARG,
tr ("Invalid I/O port base address of the parallel port %d: "
"%lu (must be in range [0, 0x%X])"),
mData->mSlot, aIOBase, 0, 0xFFFF);
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* the machine needs to be mutable */
Machine::AutoMutableStateDependency adep (mParent);
CheckComRCReturnRC (adep.rc());
AutoLock alock (this);
HRESULT rc = S_OK;
bool emitChangeEvent = false;
if (mData->mIOBase != aIOBase)
{
mData.backup();
mData->mIOBase = aIOBase;
emitChangeEvent = true;
}
if (emitChangeEvent)
{
/* leave the lock before informing callbacks */
alock.unlock();
mParent->onParallelPortChange (this);
}
return rc;
}
STDMETHODIMP ParallelPort::COMGETTER(Path) (BSTR *aPath)
{
if (!aPath)
return E_POINTER;
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
AutoReaderLock alock (this);
mData->mPath.cloneTo (aPath);
return S_OK;
}
/**
* Validates COMSETTER(Path) arguments.
*/
HRESULT ParallelPort::checkSetPath (const BSTR aPath)
{
AssertReturn (isLockedOnCurrentThread(), E_FAIL);
if (mData->mEnabled &&
(aPath == NULL || *aPath == '\0'))
return setError (E_INVALIDARG,
tr ("Path of the parallel port %d may not be empty or null "
"when the port is enabled"),
mData->mSlot);
return S_OK;
}
STDMETHODIMP ParallelPort::COMSETTER(Path) (INPTR BSTR aPath)
{
AutoCaller autoCaller (this);
CheckComRCReturnRC (autoCaller.rc());
/* the machine needs to be mutable */
Machine::AutoMutableStateDependency adep (mParent);
CheckComRCReturnRC (adep.rc());
AutoLock alock (this);
if (mData->mPath != aPath)
{
HRESULT rc = checkSetPath (aPath);
CheckComRCReturnRC (rc);
mData.backup();
mData->mPath = aPath;
/* leave the lock before informing callbacks */
alock.unlock();
return mParent->onParallelPortChange (this);
}
return S_OK;
}