IOFWUserClientIsoch.cpp   [plain text]

/*
 * Copyright (c) 1998-2001 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 *  IOFWUserClientIsoch.cpp
 *  IOFireWireFamily
 *
 *  Created by NWG on Mon Mar 12 2001.
 *  Copyright (c) 2001 Apple Computer, Inc. All rights reserved.
 *
 */

#include <IOKit/firewire/IOFireWireUserClient.h>
#include <IOKit/firewire/IOFireWireBus.h>
#include <IOKit/firewire/IOFWLocalIsochPort.h>
#include <IOKit/firewire/IOFWIsochChannel.h>
#include <IOKit/firewire/IOFireWireDevice.h>
#include <IOKit/firewire/IOFireWireController.h>
#include <IOKit/firewire/IOFWUserIsochPort.h>
#include <IOKit/firewire/IOFWUserIsochChannel.h>
void
IOFireWireUserClient::initIsochMethodTable()
{
	//
	// --- isoch methods ----------
	//
	fMethods[kFWIsochPort_Allocate].object	= this ;
	fMethods[kFWIsochPort_Allocate].func 	= (IOMethod) & IOFireWireUserClient::isochPortAllocate ;
	fMethods[kFWIsochPort_Allocate].count0	= sizeof(FWIsochPortAllocateParams) ;
	fMethods[kFWIsochPort_Allocate].count1	= sizeof(FWKernIsochPortRef) ;
	fMethods[kFWIsochPort_Allocate].flags	= kIOUCStructIStructO ;

	fMethods[kFWIsochPort_Release].object	= this ;
	fMethods[kFWIsochPort_Release].func		= (IOMethod) & IOFireWireUserClient::isochPortRelease ;
	fMethods[kFWIsochPort_Release].count0	= 1 ;
	fMethods[kFWIsochPort_Release].count1	= 0 ;
	fMethods[kFWIsochPort_Release].flags	= kIOUCScalarIScalarO ;
	
	fMethods[kFWIsochPort_GetSupported].object	= this ;
	fMethods[kFWIsochPort_GetSupported].func	= (IOMethod) & IOFireWireUserClient::isochPortGetSupported ;
	fMethods[kFWIsochPort_GetSupported].count0	= 1 ;
	fMethods[kFWIsochPort_GetSupported].count1	= 3 ;
	fMethods[kFWIsochPort_GetSupported].flags	= kIOUCScalarIScalarO ;

	fMethods[kFWIsochPort_AllocatePort].object	= this ;
	fMethods[kFWIsochPort_AllocatePort].func	= (IOMethod) & IOFireWireUserClient::isochPortAllocatePort ;
	fMethods[kFWIsochPort_AllocatePort].count0	= 3 ;
	fMethods[kFWIsochPort_AllocatePort].count1	= 0 ;
	fMethods[kFWIsochPort_AllocatePort].flags	= kIOUCScalarIScalarO ;

	fMethods[kFWIsochPort_ReleasePort].object	= this ;
	fMethods[kFWIsochPort_ReleasePort].func		= (IOMethod) & IOFireWireUserClient::isochPortReleasePort ;
	fMethods[kFWIsochPort_ReleasePort].count0	= 1 ;
	fMethods[kFWIsochPort_ReleasePort].count1	= 0 ;
	fMethods[kFWIsochPort_ReleasePort].flags	= kIOUCScalarIScalarO ;

	fMethods[kFWIsochPort_Start].object	= this ;
	fMethods[kFWIsochPort_Start].func	= (IOMethod) & IOFireWireUserClient::isochPortStart ;
	fMethods[kFWIsochPort_Start].count0	= 1 ;
	fMethods[kFWIsochPort_Start].count1	= 0 ;
	fMethods[kFWIsochPort_Start].flags	= kIOUCScalarIScalarO ;

	fMethods[kFWIsochPort_Stop].object	= this ;
	fMethods[kFWIsochPort_Stop].func	= (IOMethod) & IOFireWireUserClient::isochPortStop ;
	fMethods[kFWIsochPort_Stop].count0	= 1 ;
	fMethods[kFWIsochPort_Stop].count1	= 0 ;
	fMethods[kFWIsochPort_Stop].flags	= kIOUCScalarIScalarO ;

	// --- local isoch port methods ----------------------
	fMethods[kFWLocalIsochPort_Allocate].object			= this ;
	fMethods[kFWLocalIsochPort_Allocate].func			= (IOMethod) & IOFireWireUserClient::localIsochPortAllocate ;
	fMethods[kFWLocalIsochPort_Allocate].count0			= sizeof(FWLocalIsochPortAllocateParams) ;
	fMethods[kFWLocalIsochPort_Allocate].count1			= sizeof(FWKernIsochPortRef) ;
	fMethods[kFWLocalIsochPort_Allocate].flags			= kIOUCStructIStructO ;

	fMethods[kFWLocalIsochPort_ModifyJumpDCL].object	= this ;
	fMethods[kFWLocalIsochPort_ModifyJumpDCL].func	= (IOMethod) & IOFireWireUserClient::localIsochPortModifyJumpDCL ;
	fMethods[kFWLocalIsochPort_ModifyJumpDCL].count0	= 3 ;
	fMethods[kFWLocalIsochPort_ModifyJumpDCL].count1	= 0 ;
	fMethods[kFWLocalIsochPort_ModifyJumpDCL].flags	= kIOUCScalarIScalarO ;
	
	// --- isoch channel methods -------------------------
	fMethods[kFWIsochChannel_Allocate].object	= this ;
	fMethods[kFWIsochChannel_Allocate].func		= (IOMethod) & IOFireWireUserClient::isochChannelAllocate ;
	fMethods[kFWIsochChannel_Allocate].count0	= 3 ;
	fMethods[kFWIsochChannel_Allocate].count1	= 1 ;
	fMethods[kFWIsochChannel_Allocate].flags	= kIOUCScalarIScalarO ;
	
	fMethods[kFWIsochChannel_Release].object	= this ;
	fMethods[kFWIsochChannel_Release].func		= (IOMethod) & IOFireWireUserClient::isochChannelRelease ;
	fMethods[kFWIsochChannel_Release].count0	= 1 ;
	fMethods[kFWIsochChannel_Release].count1	= 0 ;
	fMethods[kFWIsochChannel_Release].flags		= kIOUCScalarIScalarO ;

/*	fMethods[kFWIsochChannel_SetTalker].object	= this ;
	fMethods[kFWIsochChannel_SetTalker].func	= (IOMethod) & IOFireWireUserClient::isochChannelSetTalker ;
	fMethods[kFWIsochChannel_SetTalker].count0	= 2 ;
	fMethods[kFWIsochChannel_SetTalker].count1	= 0 ;
	fMethods[kFWIsochChannel_SetTalker].flags	= kIOUCScalarIScalarO ;

	fMethods[kFWIsochChannel_AddListener].object= this ;
	fMethods[kFWIsochChannel_AddListener].func	= (IOMethod) & IOFireWireUserClient::isochChannelAddListener ;
	fMethods[kFWIsochChannel_AddListener].count0= 2 ;
	fMethods[kFWIsochChannel_AddListener].count1= 0 ;
	fMethods[kFWIsochChannel_AddListener].flags	= kIOUCScalarIScalarO ;

	fMethods[kFWIsochChannel_AllocateChannel].object	= this ;
	fMethods[kFWIsochChannel_AllocateChannel].func		= (IOMethod) & IOFireWireUserClient::isochChannelAllocateChannel ;
	fMethods[kFWIsochChannel_AllocateChannel].count0	= 1 ;
	fMethods[kFWIsochChannel_AllocateChannel].count1	= 0 ;
	fMethods[kFWIsochChannel_AllocateChannel].flags		= kIOUCScalarIScalarO ;

	fMethods[kFWIsochChannel_ReleaseChannel].object		= this ;
	fMethods[kFWIsochChannel_ReleaseChannel].func		= (IOMethod) & IOFireWireUserClient::isochChannelReleaseChannel ;
	fMethods[kFWIsochChannel_ReleaseChannel].count0		= 1 ;
	fMethods[kFWIsochChannel_ReleaseChannel].count1		= 0 ;
	fMethods[kFWIsochChannel_ReleaseChannel].flags		= kIOUCScalarIScalarO ;

	fMethods[kFWIsochChannel_Start].object				= this ;
	fMethods[kFWIsochChannel_Start].func				= (IOMethod) & IOFireWireUserClient::isochChannelStart ;
	fMethods[kFWIsochChannel_Start].count0				= 1 ;
	fMethods[kFWIsochChannel_Start].count1				= 0 ;
	fMethods[kFWIsochChannel_Start].flags				= kIOUCScalarIScalarO ;

	fMethods[kFWIsochChannel_Stop].object				= this ;
	fMethods[kFWIsochChannel_Stop].func					= (IOMethod) & IOFireWireUserClient::isochChannelStop ;
	fMethods[kFWIsochChannel_Stop].count0				= 1 ;
	fMethods[kFWIsochChannel_Stop].count1				= 0 ;
	fMethods[kFWIsochChannel_Stop].flags				= kIOUCScalarIScalarO ;*/

	fMethods[kFWIsochChannel_UserAllocateChannelBegin].object	= this ;
	fMethods[kFWIsochChannel_UserAllocateChannelBegin].func		= (IOMethod) & IOFireWireUserClient::isochChannelUserAllocateChannelBegin ;
	fMethods[kFWIsochChannel_UserAllocateChannelBegin].count0	= 4 ;
	fMethods[kFWIsochChannel_UserAllocateChannelBegin].count1	= 2 ;
	fMethods[kFWIsochChannel_UserAllocateChannelBegin].flags	= kIOUCScalarIScalarO ;
	
	fMethods[kFWIsochChannel_UserReleaseChannelComplete].object	= this ;
	fMethods[kFWIsochChannel_UserReleaseChannelComplete].func	= (IOMethod) & IOFireWireUserClient::isochChannelUserReleaseChannelComplete ;
	fMethods[kFWIsochChannel_UserReleaseChannelComplete].count0	= 1 ;
	fMethods[kFWIsochChannel_UserReleaseChannelComplete].count1	= 0 ;
	fMethods[kFWIsochChannel_UserReleaseChannelComplete].flags	= kIOUCScalarIScalarO ;
}

void
IOFireWireUserClient::initIsochAsyncMethodTable()
{
	fAsyncMethods[kFWSetAsyncRef_IsochChannelForceStop].object	= this ;
	fAsyncMethods[kFWSetAsyncRef_IsochChannelForceStop].func	= (IOAsyncMethod) & IOFireWireUserClient::setAsyncRef_IsochChannelForceStop ;
	fAsyncMethods[kFWSetAsyncRef_IsochChannelForceStop].count0	= 3 ;
	fAsyncMethods[kFWSetAsyncRef_IsochChannelForceStop].count1	= 0 ;
	fAsyncMethods[kFWSetAsyncRef_IsochChannelForceStop].flags	= kIOUCScalarIScalarO ;

	fAsyncMethods[kFWSetAsyncRef_DCLCallProc].object			= this ;
	fAsyncMethods[kFWSetAsyncRef_DCLCallProc].func				= (IOAsyncMethod) & IOFireWireUserClient::setAsyncRef_DCLCallProc ;
	fAsyncMethods[kFWSetAsyncRef_DCLCallProc].count0			= 2 ;
	fAsyncMethods[kFWSetAsyncRef_DCLCallProc].count1			= 0 ;
	fAsyncMethods[kFWSetAsyncRef_DCLCallProc].flags				= kIOUCScalarIScalarO ;
}
	
//
// isoch port
//

IOReturn
IOFireWireUserClient::isochPortAllocate(
	FWIsochPortAllocateParams*		inParams,
	FWKernIsochPortRef*				outPortRef)
{
	IOFWUserIsochPortProxy*	newPort	= new IOFWUserIsochPortProxy() ;
	
//	IOLog("IOFireWireUserClient::isochPortAllocate: new port @ 0x%08lX\n", newPort) ;

	if (!newPort)
		return kIOReturnNoMemory ;
	if (!newPort->init(this))
	{
		IOLog("IOFireWireUserClient::isochPortAllocate: port init failed\n") ;
		newPort->release() ;
		
		return kIOReturnInternalError ;
	}

	IOLockLock(fSetLock) ;
	fUserIsochPorts->setObject(newPort) ;
	IOLockUnlock(fSetLock) ;
	
	// the OSSet has the object, so we can release it
	newPort->release() ;
	
	// pass new port out to user
	*outPortRef		= newPort ;

	return kIOReturnSuccess ;
}

IOReturn
IOFireWireUserClient::isochPortRelease(
	FWKernIsochPortRef		inPortRef)
{
	if (!OSDynamicCast(IOFWUserIsochPortProxy, inPortRef))
		return kIOReturnBadArgument ;
	
	IOLockLock(fSetLock) ;
	fUserIsochPorts->removeObject(inPortRef) ;
	IOLockUnlock(fSetLock) ;
	
	return kIOReturnSuccess ;
}

IOReturn
IOFireWireUserClient::isochPortGetSupported(
	FWKernIsochPortRef		inPortRef,
	IOFWSpeed*				outMaxSpeed,
	UInt32*					outChanSupportedHi,
	UInt32*					outChanSupportedLo)
{
	if (!OSDynamicCast(IOFWUserIsochPortProxy, inPortRef))
		return kIOReturnBadArgument ;
		
	UInt64		chanSupported ;
	IOReturn	result			= kIOReturnSuccess ;

	result = inPortRef->getSupported(*outMaxSpeed, chanSupported) ;

	*outChanSupportedHi = *(UInt32*)&chanSupported ;
	*outChanSupportedLo	= *((UInt32*)&chanSupported + 1) ;
	
	return result ;
}

IOReturn
IOFireWireUserClient::isochPortAllocatePort(
	FWKernIsochPortRef		inPortRef,
	IOFWSpeed				inSpeed,
	UInt32					inChannel)
{
	if (!OSDynamicCast(IOFWUserIsochPortProxy, inPortRef))
		return kIOReturnBadArgument ;

	return inPortRef->allocatePort(inSpeed, inChannel) ;
}

IOReturn
IOFireWireUserClient::isochPortReleasePort(
	FWKernIsochPortRef		inPortRef)
{
	if (!OSDynamicCast(IOFWUserIsochPortProxy, inPortRef))
		return kIOReturnBadArgument ;

	return inPortRef->releasePort() ;
}

IOReturn
IOFireWireUserClient::isochPortStart(
	FWKernIsochPortRef		inPortRef)
{
	if (!OSDynamicCast(IOFWUserIsochPortProxy, inPortRef))
		return kIOReturnBadArgument ;

	return inPortRef->start() ;
}

IOReturn
IOFireWireUserClient::isochPortStop(
	FWKernIsochPortRef		inPortRef)
{
	if (!OSDynamicCast(IOFWUserIsochPortProxy, inPortRef))
		return kIOReturnBadArgument ;


//	IOLog("IOFireWireUserClient::isochPortStop: was going to stop port @ 0x%08lX, fPort 0x%08lX\n", inPortRef, inPortRef->getPort()) ;
	return inPortRef->stop() ;
}

IOReturn
IOFireWireUserClient::localIsochPortAllocate(
	FWLocalIsochPortAllocateParams*	inParams,
	FWKernIsochPortRef*				outPortRef)
{
	IOReturn						result		= kIOReturnSuccess ;
	IOFWUserLocalIsochPortProxy*	newPort 	= new IOFWUserLocalIsochPortProxy ;
	if (!newPort)
		return kIOReturnNoMemory ;

//	IOLog("IOFireWireUserClient::localIsochPortAllocate: new IOFWUserLocalIsochPortProxy @ 0x%08lX\n", newPort) ;

	if (!newPort->initWithUserDCLProgram(inParams, this))
		return kIOReturnNoMemory ;

	if (kIOReturnSuccess != result)
		newPort->release() ;
	else
	{
		IOLockLock(fSetLock) ;
		fUserIsochPorts->setObject(newPort) ;
		IOLockUnlock(fSetLock) ;
		
		// the OSSet has the object, so we can release it
		newPort->release() ;
		
		// pass new port out to user
		*outPortRef = newPort ;
	}

	return result ;
}

IOReturn
IOFireWireUserClient::localIsochPortModifyJumpDCL(
	FWKernIsochPortRef		inPortRef,
	UInt32					inJumpDCLCompilerData,
	UInt32					inLabelDCLCompilerData)
{
	IOFWUserLocalIsochPortProxy*	portProxy ;
	if (NULL == (portProxy = OSDynamicCast(IOFWUserLocalIsochPortProxy, inPortRef)) )
		return kIOReturnBadArgument ;
	
	return portProxy->modifyJumpDCL(inJumpDCLCompilerData, inLabelDCLCompilerData) ;
}


IOReturn
IOFireWireUserClient::setAsyncRef_DCLCallProc(
	OSAsyncReference		asyncRef,
	FWKernIsochPortRef		inPortRef,
	DCLCallCommandProcPtr	inProc)
{
	IOFWUserLocalIsochPortProxy*	port = OSDynamicCast(IOFWUserLocalIsochPortProxy, inPortRef) ;
	if (!port)
		return kIOReturnBadArgument ;
	
	return port->setAsyncRef_DCLCallProc(asyncRef, inProc) ;
}

//
// --- isoch channel ----------
//
IOReturn
IOFireWireUserClient::isochChannelForceStopHandler(
	void*					refCon,
	IOFWIsochChannel*		isochChannelID,
	UInt32					stopCondition)
{
//	IOLog("IOFireWireUserClient::isochChannelForceStopHandler: refCon=0x%08lX, isochChannelID=0x%08lX, stopCondition=0x%08lX\n", refCon, isochChannelID, stopCondition) ;

	return kIOReturnSuccess ;
}
 
IOReturn
IOFireWireUserClient::isochChannelAllocate(
	bool					inDoIRM,
	UInt32					inPacketSize,
	IOFWSpeed				inPrefSpeed,
	FWKernIsochChannelRef*	outIsochChannelRef)
{
//	IOFWIsochChannel*	newChannel = fOwner->getController()->createIsochChannel(
//												inDoIRM, inPacketSize, inPrefSpeed, 
//												& IOFireWireUserClient::isochChannelForceStopHandler, this) ;

	IOReturn	result		= kIOReturnSuccess ;

	// this code the same as IOFireWireController::createIsochChannel
	// must update this code when controller changes.
	IOFWUserIsochChannel*	newChannel	= new IOFWUserIsochChannel ;
	if (!newChannel)
		result = kIOReturnNoMemory ;
		
	if (kIOReturnSuccess == result)
		if (!newChannel->init(fOwner->getController(), inDoIRM, inPacketSize, inPrefSpeed, & IOFireWireUserClient::isochChannelForceStopHandler, this))
		{
			newChannel->release() ;
			newChannel = NULL ;
			result = kIOReturnError ;
		}

	if (kIOReturnSuccess == result)
	{
		IOLockLock(fSetLock) ;
		if (!fUserIsochChannels->setObject(newChannel))
			IOLog("IOFireWireUserClient::isochChannelAllocate: new channel could not be added to set!") ;
		IOLockUnlock(fSetLock) ;
		
		// OSSet has this object, so we can release it
		newChannel->release() ;
	}
	
	*outIsochChannelRef = newChannel ;
	return result ;
}

IOReturn
IOFireWireUserClient::isochChannelRelease(
	FWKernIsochChannelRef	inChannelRef)
{
	if (!OSDynamicCast(IOFWUserIsochChannel, inChannelRef))
		return kIOReturnBadArgument ;
	
	IOLockLock(fSetLock) ;
	fUserIsochChannels->removeObject(inChannelRef) ;
	IOLockUnlock(fSetLock) ;
	
	return kIOReturnSuccess ;
}
/*
IOReturn
IOFireWireUserClient::isochChannelSetTalker(
	FWKernIsochChannelRef	inChannelRef,
	FWKernIsochPortRef		inTalkerRef)
{
	if (!OSDynamicCast(IOFWUserIsochChannel, inChannelRef))
		return kIOReturnBadArgument ;
	if (!OSDynamicCast(IOFWUserIsochPort, inTalkerRef))
		return kIOReturnBadArgument ;
	
	return inChannelRef->setTalker(inTalkerRef->getPort()) ;
}
							
IOReturn
IOFireWireUserClient::isochChannelAddListener(
	FWKernIsochChannelRef	inChannelRef,
	FWKernIsochPortRef		inListenerRef)
{
	if (!OSDynamicCast(IOFWUserIsochChannel, inChannelRef))
	{
		IOLog("IOFireWireUserClient::isochChannelAddListener: bad inChannelRef 0x%08lX\n", inChannelRef) ;
		return kIOReturnBadArgument ;
	}
	if (!OSDynamicCast(IOFWUserIsochPortProxy, inListenerRef))
	{
		IOLog("IOFireWireUserClient::isochChannelAddListener: bad inListenerRef 0x%08lX\n", inListenerRef) ;
		return kIOReturnBadArgument ;
	}
	else
		IOLog("IOFireWireUserClient::isochChannelAddListener: inListenerRef->port=0x%08lX\n", inListenerRef->getPort()) ;

	return inChannelRef->addListener(inListenerRef->getPort()) ;
}

IOReturn
IOFireWireUserClient::isochChannelAllocateChannel(
	FWKernIsochChannelRef	inChannelRef)
{
	if (!OSDynamicCast(IOFWUserIsochChannel, inChannelRef))
		return kIOReturnBadArgument ;
	
	return inChannelRef->allocateChannel() ;
}

IOReturn
IOFireWireUserClient::isochChannelReleaseChannel(
	FWKernIsochChannelRef	inChannelRef)
{
	if (!OSDynamicCast(IOFWUserIsochChannel, inChannelRef))
		return kIOReturnBadArgument ;
	
	return inChannelRef->releaseChannel() ;
}

IOReturn
IOFireWireUserClient::isochChannelStart(
	FWKernIsochChannelRef	inChannelRef)
{
	IOLog("+ IOFireWireUserClient::isochChannelStart\n") ;
	if (!OSDynamicCast(IOFWUserIsochChannel, inChannelRef))
		return kIOReturnBadArgument ;
	
	IOLog("IOFireWireUserClient::isochChannelStart: starting channel %08lX\n", inChannelRef) ;
	return inChannelRef->start() ;
}

IOReturn
IOFireWireUserClient::isochChannelStop(
	FWKernIsochChannelRef	inChannelRef)
{
	if (!OSDynamicCast(IOFWUserIsochChannel, inChannelRef))
		return kIOReturnBadArgument ;
	
	return inChannelRef->stop() ;
}*/

IOReturn
IOFireWireUserClient::isochChannelUserAllocateChannelBegin(
	FWKernIsochChannelRef	inChannelRef,
	IOFWSpeed				inSpeed,
//	UInt32					inAllowedChansHi,
//	UInt32					inAllowedChansLo,	
	UInt64					inAllowedChans,
	IOFWSpeed*				outSpeed,
	UInt32*					outChannel)
{
	if (!OSDynamicCast(IOFWUserIsochChannel, inChannelRef))
		return kIOReturnBadArgument ;
	
	return inChannelRef->userAllocateChannelBegin(inSpeed, inAllowedChans,/*inAllowedChansHi, inAllowedChansLo,*/ outSpeed, outChannel) ;
}

IOReturn
IOFireWireUserClient::isochChannelUserReleaseChannelComplete(
	FWKernIsochChannelRef	inChannelRef)
{
	if (!OSDynamicCast(IOFWUserIsochChannel, inChannelRef))
		return kIOReturnBadArgument ;
	
	return inChannelRef->userReleaseChannelComplete() ;
}

IOReturn
IOFireWireUserClient::setAsyncRef_IsochChannelForceStop(
	OSAsyncReference		asyncRef,
	void*					inCallback,
	void*					inUserRefCon,
	void*,
	void*,
	void*,
	void*)
{
	return kIOReturnUnsupported ;
}