--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/bthci/hci2implementations/hctls/uart_original/src/hctluartoriginalreceiver.cpp Fri Jan 15 08:13:17 2010 +0200
@@ -0,0 +1,329 @@
+// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// under the terms of "Eclipse Public License v1.0"
+// which accompanies this distribution, and is available
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+/**
+ @file
+ @internalComponent
+*/
+
+#include "hctluartoriginalreceiver.h"
+
+#include "hctluartoriginal.h"
+#include "uartoriginalutils.h"
+
+#include <d32comm.h>
+#include <es_prot.h> // For GetLittleEndian methods
+#include <bluetooth/logger.h>
+
+// These files are included to get HCI specification defined constants.
+#include <bluetooth/hci/hciframe.h>
+#include <bluetooth/hci/event.h>
+
+
+
+#ifdef __FLOG_ACTIVE
+_LIT8(KLogComponent, LOG_COMPONENT_HCTL_UART_ORIGINAL);
+#endif
+
+
+CHCTLUartOriginalReceiver::CHCTLUartOriginalReceiver(CHCTLUartOriginal& aHCTLUartOriginal,RBusDevComm& aPort)
+ : CActive(EPriorityStandard),
+ iHCTLUartOriginal(aHCTLUartOriginal),
+ iState(EWaitingForHctlHeaderByte),
+ iReceiveBufPtr(NULL,0),
+ iPort(aPort)
+ {
+ LOG_FUNC
+ CActiveScheduler::Add(this);
+ }
+
+CHCTLUartOriginalReceiver::~CHCTLUartOriginalReceiver()
+ {
+ LOG_FUNC
+
+ Cancel();
+ iReceiveBuffer.Close();
+
+ HCI_LOG_UNLOAD(this);
+ }
+
+CHCTLUartOriginalReceiver* CHCTLUartOriginalReceiver::NewL(CHCTLUartOriginal& aHCTLUartOriginal, RBusDevComm& aPort)
+ {
+ LOG_STATIC_FUNC
+
+ CHCTLUartOriginalReceiver* self=new(ELeave)CHCTLUartOriginalReceiver(aHCTLUartOriginal, aPort);
+ CleanupStack::PushL(self);
+ self->ConstructL();
+ CleanupStack::Pop();
+ return self;
+ }
+
+void CHCTLUartOriginalReceiver::ConstructL()
+ {
+ LOG_FUNC
+
+ HCI_LOG_LOADL(this, KHCILoggerDatalinkTypeH4);
+
+ // Create the receive buffer
+ HBufC8* buf = HBufC8::NewMaxL(KHCTLRecvBufSize);
+
+ // HBufC8 is not modifiable. Create a RBuf8 object that
+ // allows the data to be modified.
+ iReceiveBuffer.Assign(buf);
+ }
+
+void CHCTLUartOriginalReceiver::QueueReadForNextFrame(TUint16 aOffset, TUint16 aBytesRequired)
+ {
+ LOG_FUNC
+
+ __ASSERT_DEBUG(!IsActive(), PANIC(KUartOriginalPanic, EPortReadAttemptWhenReadOutstanding));
+ __ASSERT_DEBUG(aBytesRequired != 0, PANIC(KUartOriginalPanic, EAttemptToReadZeroBytes));
+ __ASSERT_DEBUG(aOffset + aBytesRequired <= iReceiveBuffer.MaxLength(), PANIC(KUartOriginalPanic, EHctlReceiverBufferOverflow));
+
+ SetActive();
+
+ // Read the required number of bytes into the buffer starting at the specified offset.
+ iReceiveBufPtr.Set(iReceiveBuffer.MidTPtr(aOffset, aBytesRequired));
+ iPort.Read(iStatus, iReceiveBufPtr, aBytesRequired);
+ }
+
+void CHCTLUartOriginalReceiver::ProcessData()
+ {
+ LOG_FUNC
+
+ TUint16 bytesRequiredForNextRead = 0;
+ TUint16 currentReadOffset = 0;
+
+ switch (iState)
+ {
+ case EWaitingForHctlHeaderByte:
+ {
+ // reads the first byte of the Packet, to decide the
+ // type of Packet and set the next state
+ __ASSERT_ALWAYS(iReceiveBufPtr.Length() == KHctlHeaderSize,
+ PANIC(KUartOriginalPanic, EReadCompletedWithInsufficientBytes));
+
+ // Store the HCI packet.
+ iCurrentHCIPacketType = iReceiveBufPtr[KHctlPacketTypeOffset];
+ iState = EWaitingForHciHeader;
+
+ // Request the appropriate number of header bytes. The HCI packet
+ // type will be overwritten when the HCI header bytes are read.
+ switch(iCurrentHCIPacketType)
+ {
+ case CHCTLUartOriginal::EACLDataPacket:
+ {
+ HCI_LOG_FRAME(this,
+ KHCILoggerControllerToHost | KHCILoggerACLDataFrame | KHCILoggerFrameFragmented,
+ iReceiveBufPtr.Left(KHctlHeaderSize));
+
+ bytesRequiredForNextRead = CHctlAclDataFrame::KHCIACLDataPacketHeaderLength;
+ }
+ break;
+
+ case CHCTLUartOriginal::ESynchronousDataPacket:
+ {
+ HCI_LOG_FRAME(this,
+ KHCILoggerControllerToHost | KHCILoggerSynchronousDataFrame | KHCILoggerFrameFragmented,
+ iReceiveBufPtr.Left(KHctlHeaderSize));
+
+ bytesRequiredForNextRead = CHctlSynchronousDataFrame::KHCISynchronousDataPacketHeaderLength;
+ }
+ break;
+
+ case CHCTLUartOriginal::EEventPacket:
+ {
+ HCI_LOG_FRAME(this,
+ KHCILoggerControllerToHost | KHCILoggerCommandOrEvent | KHCILoggerFrameFragmented,
+ iReceiveBufPtr.Left(KHctlHeaderSize));
+
+ bytesRequiredForNextRead = THCIEventBase::KEventCommonFieldsLength;
+ }
+ break;
+
+ default:
+ // unexpected/unsupported data Received
+ iState = EInvalidDataReceived;
+ break;
+ };
+ }
+ break;
+
+ case EWaitingForHciHeader:
+ {
+ iState = EWaitingForHciPayload;
+
+ // Read the packet length.
+ switch(iCurrentHCIPacketType)
+ {
+ case CHCTLUartOriginal::EACLDataPacket:
+ {
+ __ASSERT_ALWAYS(iReceiveBufPtr.Length() == CHctlAclDataFrame::KHCIACLDataPacketHeaderLength,
+ PANIC(KUartOriginalPanic, EReadCompletedWithInsufficientBytes));
+
+ bytesRequiredForNextRead = LittleEndian::Get16(iReceiveBufPtr.Ptr() + CHctlDataFrameBase::KHCIDataPacketLengthFieldOffset);
+
+ // Check that the size of the ACL data does not exceed the internal buffer.
+ if(bytesRequiredForNextRead > (KHCTLRecvBufSize - CHctlAclDataFrame::KHCIACLDataPacketHeaderLength))
+ {
+ // This is unexpected from the controller. Try restarting it.
+ iState = EInvalidDataReceived;
+ }
+ else
+ {
+ HCI_LOG_FRAME(this,
+ KHCILoggerControllerToHost | KHCILoggerACLDataFrame | KHCILoggerFrameFragmented,
+ iReceiveBufPtr.Left(CHctlAclDataFrame::KHCIACLDataPacketHeaderLength));
+ currentReadOffset = CHctlAclDataFrame::KHCIACLDataPacketHeaderLength;
+ }
+ }
+ break;
+
+ case CHCTLUartOriginal::ESynchronousDataPacket:
+ {
+ __ASSERT_ALWAYS(iReceiveBufPtr.Length() == CHctlSynchronousDataFrame::KHCISynchronousDataPacketHeaderLength,
+ PANIC(KUartOriginalPanic, EReadCompletedWithInsufficientBytes));
+
+ bytesRequiredForNextRead = iReceiveBufPtr[CHctlDataFrameBase::KHCIDataPacketLengthFieldOffset];
+ HCI_LOG_FRAME(this,
+ KHCILoggerControllerToHost | KHCILoggerSynchronousDataFrame | KHCILoggerFrameFragmented,
+ iReceiveBufPtr.Left(CHctlSynchronousDataFrame::KHCISynchronousDataPacketHeaderLength));
+ currentReadOffset = CHctlSynchronousDataFrame::KHCISynchronousDataPacketHeaderLength;
+ }
+ break;
+
+ case CHCTLUartOriginal::EEventPacket:
+ {
+ __ASSERT_ALWAYS(iReceiveBufPtr.Length() == THCIEventBase::KEventCommonFieldsLength,
+ PANIC(KUartOriginalPanic, EReadCompletedWithInsufficientBytes));
+
+ bytesRequiredForNextRead = iReceiveBufPtr[THCIEventBase::KTotalParameterLengthOffset];
+ HCI_LOG_FRAME(this,
+ KHCILoggerControllerToHost | KHCILoggerCommandOrEvent | KHCILoggerFrameFragmented,
+ iReceiveBufPtr.Left(THCIEventBase::KEventCommonFieldsLength));
+ currentReadOffset = THCIEventBase::KEventCommonFieldsLength;
+ }
+ break;
+
+ default:
+ {
+ // Invalid state.
+ PANIC(KUartOriginalPanic, EIllegalState);
+ break;
+ }
+ };
+ }
+ break;
+
+ case EWaitingForHciPayload:
+ {
+ TUint16 payloadLength = iReceiveBufPtr.Length();
+ switch(iCurrentHCIPacketType)
+ {
+ case CHCTLUartOriginal::EACLDataPacket:
+ {
+ HCI_LOG_FRAME(this,
+ KHCILoggerControllerToHost | KHCILoggerACLDataFrame,
+ iReceiveBufPtr);
+ iHCTLUartOriginal.ProcessACLData(iReceiveBuffer.Left(payloadLength + CHctlAclDataFrame::KHCIACLDataPacketHeaderLength));
+ }
+ break;
+
+ case CHCTLUartOriginal::ESynchronousDataPacket:
+ {
+ HCI_LOG_FRAME(this,
+ KHCILoggerControllerToHost | KHCILoggerSynchronousDataFrame,
+ iReceiveBufPtr);
+ iHCTLUartOriginal.ProcessSynchronousData(iReceiveBuffer.Left(payloadLength + CHctlSynchronousDataFrame::KHCISynchronousDataPacketHeaderLength));
+ }
+ break;
+
+ case CHCTLUartOriginal::EEventPacket:
+ {
+ HCI_LOG_FRAME(this,
+ KHCILoggerControllerToHost | KHCILoggerCommandOrEvent,
+ iReceiveBufPtr);
+ iHCTLUartOriginal.ProcessEvent(iReceiveBuffer.Left(payloadLength + THCIEventBase::KEventCommonFieldsLength));
+ }
+ break;
+
+ default:
+ // Invalid state
+ PANIC(KUartOriginalPanic, EIllegalState);
+ };
+
+ // Starting a new Packet. Bytes Required now is 1, offset is 0
+ // We finished with this packet so we're back in 'wait for next mode'
+ currentReadOffset = 0;
+ bytesRequiredForNextRead = KHctlHeaderSize;
+ iState = EWaitingForHctlHeaderByte;
+ }
+ break;
+
+ default:
+ // must never get here
+ PANIC(KUartOriginalPanic, EIllegalState);
+ break;
+ }
+
+ if(iState == EInvalidDataReceived)
+ {
+ // The HCTL can not recover from this. Reset the controller and restart the host.
+ iHCTLUartOriginal.MhriStartHardReset();
+ }
+ else
+ {
+ // Request the next read on the port.
+ QueueReadForNextFrame(currentReadOffset, bytesRequiredForNextRead);
+ }
+ }
+
+
+void CHCTLUartOriginalReceiver::RunL()
+ {
+ LOG_FUNC
+ LOG1(_L8("\tiStatus = %d"), iStatus.Int());
+
+ // Only process the read if it has completed successfully.
+ if (iStatus.Int() == KErrNone)
+ {
+ ProcessData();
+ }
+ else
+ {
+ // The HCTL can not recover from this. Reset the controller and restart the host.
+ iHCTLUartOriginal.MhriStartHardReset();
+ }
+ }
+
+void CHCTLUartOriginalReceiver::DoCancel()
+ {
+ LOG_FUNC
+
+ // Cancel the outstanding read request.
+ iPort.ReadCancel();
+ }
+
+void CHCTLUartOriginalReceiver::Start()
+ {
+ LOG_FUNC
+ __ASSERT_DEBUG(!IsActive(), PANIC(KUartOriginalPanic, EStartCalledWhenReadOutstanding));
+
+ // Reset this object state and make an initial read on the UART.
+ iState = EWaitingForHctlHeaderByte;
+
+ // Read first byte on next frame (HCI packet type) into offset zero of the buffer.
+ QueueReadForNextFrame(0, KHctlHeaderSize);
+ }