sl@0: // Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // e32\include\d32ethernet.h
sl@0: // User side class definition for using ethernet support
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file d32ethernet.h
sl@0:  @publishedPartner
sl@0:  @released
sl@0: */
sl@0: 
sl@0: #ifndef __D32ETHERNET_H__
sl@0: #define __D32ETHERNET_H__
sl@0: #include <e32cmn.h>
sl@0: #include <e32ver.h>
sl@0: 
sl@0: 
sl@0: /** @addtogroup enet Ethernet Drivers
sl@0:  *  Kernel Ethernet Support
sl@0:  */
sl@0: 
sl@0: /** @addtogroup enet_external The External Intarface to the Ethernet support
sl@0:  * @ingroup enet
sl@0:  * @{
sl@0:  */
sl@0: // Ethernet Specific Error Codes
sl@0: /** Transmit out of memory error */
sl@0: const TInt KErrTxOutOfMemory = (-302);
sl@0: /** General Transmit Error */
sl@0: const TInt KErrTxError       = (-303);
sl@0: /** Trying to send a frame that is too big */
sl@0: const TInt KErrTxFrameToBig  = (-304);
sl@0: /** General Recieve Error */
sl@0: const TInt KErrRxError       = (-305);
sl@0: 
sl@0: // Card configuration - speed settings.
sl@0: /** Ethernet speed unknown */
sl@0: const TUint8 KEthSpeedUnknown=0x00;
sl@0: /** Ethernet speed autosensing */
sl@0: const TUint8 KEthSpeedAuto=0x01;
sl@0: /** Ethernet speed 10Mbits */
sl@0: const TUint8 KEthSpeed10BaseT=0x02;
sl@0: /** Ethernet speed 100Mbits */
sl@0: const TUint8 KEthSpeed100BaseTX=0x03;
sl@0: 
sl@0: // Card configuration - duplex settings.
sl@0: /** Ethernet duplex setting unknown */
sl@0: const TUint8 KEthDuplexUnknown=0x00;
sl@0: /** Ethernet duplex setting automatic */
sl@0: const TUint8 KEthDuplexAuto=0x01;
sl@0: /** Ethernet full duplex */
sl@0: const TUint8 KEthDuplexFull=0x02;
sl@0: /** Ethernet helf duplex */
sl@0: const TUint8 KEthDuplexHalf=0x03;
sl@0: 
sl@0: // Default Ethernet Address
sl@0: const TUint8 KDefEtherAddByte0=0x30; // MSB
sl@0: const TUint8 KDefEtherAddByte1=0x32;
sl@0: const TUint8 KDefEtherAddByte2=0x33;
sl@0: const TUint8 KDefEtherAddByte3=0x34;
sl@0: const TUint8 KDefEtherAddByte4=0x35;
sl@0: const TUint8 KDefEtherAddByte5=0x36; // LSB
sl@0: 
sl@0: /** Ethernet address length */
sl@0: const TUint KEthernetAddressLength=6;
sl@0: 
sl@0: /**
sl@0:  * The ethernet configuration class
sl@0:  */
sl@0: class TEthernetConfigV01
sl@0:     {
sl@0:     public:
sl@0:     /**
sl@0:      * The speed 
sl@0:      */
sl@0:     TUint8 iEthSpeed;
sl@0:     /**
sl@0:      * The duplex setting
sl@0:      */
sl@0:     TUint8 iEthDuplex;
sl@0:     /** 
sl@0:      * The MAC address
sl@0:      */
sl@0:     TUint8 iEthAddress[KEthernetAddressLength];
sl@0:     };
sl@0: typedef TPckgBuf<TEthernetConfigV01> TEthernetConfig;
sl@0: 
sl@0: /**
sl@0:  * The ethernet capibility class
sl@0:  */
sl@0: class TEthernetCapsV01
sl@0:     {
sl@0:     public:
sl@0: 
sl@0:     };
sl@0: typedef TPckgBuf<TEthernetCapsV01> TEthernetCaps;
sl@0: 
sl@0: /**
sl@0:  * The Ethernet device capibility class
sl@0:  */
sl@0: class TCapsDevEthernetV01
sl@0:     {
sl@0:     public:
sl@0:     /**
sl@0:      * The device version
sl@0:      */
sl@0:     TVersion version;
sl@0:     };
sl@0: 
sl@0:     
sl@0: #ifdef ETH_CHIP_IO_ENABLED
sl@0: enum TMemSpace 
sl@0:     {
sl@0:     BGE_SPACE_CFG =  0,       /* PCI config space */
sl@0:     BGE_SPACE_REG = 1,       /* PCI memory space */
sl@0:     BGE_SPACE_NIC =  2,       /* on-chip memory   */
sl@0:     BGE_SPACE_MII =  3,       /* PHY's MII registers  */
sl@0:     BGE_SPACE_BGE =  4,       /* driver's soft state  */
sl@0:     BGE_SPACE_TXDESC = 5,       /* TX descriptors   */
sl@0:     BGE_SPACE_TXBUFF = 6,       /* TX buffers       */
sl@0:     BGE_SPACE_RXDESC = 7,       /* RX descriptors   */
sl@0:     BGE_SPACE_RXBUFF = 8,       /* RX buffers       */
sl@0:     BGE_SPACE_STATUS = 9,       /* status block     */
sl@0:     BGE_SPACE_STATISTICS = 10,      /* statistics block */
sl@0:     BGE_SPACE_SEEPROM =  11,      /* SEEPROM (if fitted)  */
sl@0:     BGE_SPACE_FLASH = 12      /* FLASH (if fitted)    */
sl@0:     };
sl@0: 
sl@0: struct TChipIOInfo
sl@0:     {
sl@0:     TUint32 iSize; /* in bytes: 1,2,4,8    */
sl@0:     TUint32 iSpace; /* See #defines below   */
sl@0:     TUint32 iOffset;
sl@0:     TUint32 iData; /* output for peek  */
sl@0:     TUint32 iCnt; /* number of contigues items to be dumped*/
sl@0:     };   
sl@0: #endif 
sl@0: 
sl@0: 
sl@0: /**
sl@0: @publishedPartner
sl@0: @released
sl@0: 
sl@0: The externally visible interface
sl@0: */
sl@0: class RBusDevEthernet : public RBusLogicalChannel 
sl@0:     {
sl@0:     public:
sl@0: 	
sl@0: 	enum TVer {EMajorVersionNumber=1,EMinorVersionNumber=0,EBuildVersionNumber=KE32BuildVersionNumber};
sl@0: 
sl@0:     /**
sl@0:      * Asyncorus requests
sl@0:      */
sl@0:     enum TRequest
sl@0: 	{
sl@0: 	ERequestRead=0x0,         /**< Read request */
sl@0:         ERequestReadCancel=0x1,   /**< Cancel read request */
sl@0: 	ERequestWrite=0x1,        /**< Write request */
sl@0:         ERequestWriteCancel=0x2   /**< Cancel write request */
sl@0: #ifdef ETH_CHIP_IO_ENABLED
sl@0:     ,EChipDiagIOCtrl=0x3
sl@0: #endif
sl@0: 	};
sl@0: 
sl@0:     /**
sl@0:      * Control requests
sl@0:      */
sl@0:     enum TControl
sl@0: 	{
sl@0: 	EControlConfig,    /**< Get the current configuration */
sl@0:         EControlSetConfig, /**< Set the current configuration */
sl@0:         EControlSetMac,    /**< Set the MAC address */
sl@0:         EControlCaps       /**< Get ethernet capibilites */
sl@0: 	};
sl@0: 
sl@0:     public:
sl@0: #ifndef __KLIB_H__
sl@0:     /**
sl@0:      * Open a channel
sl@0:      * @param aUnit The channel number to open
sl@0:      */
sl@0:     inline TInt Open(TInt aUnit);
sl@0:     /**
sl@0:      * Get the ethernet version
sl@0:      * @return The version
sl@0:      */
sl@0:     inline TVersion VersionRequired() const;
sl@0:     /**
sl@0:      * Read from the channel
sl@0:      * @param aStatus The callback status 
sl@0:      * @param aDes Buffer to be filled in
sl@0:      */
sl@0:     inline void Read(TRequestStatus &aStatus,TDes8 &aDes);
sl@0:     /**
sl@0:      * Read from the channel
sl@0:      * @param aStatus The callback status 
sl@0:      * @param aDes Buffer to be filled in
sl@0:      * @param aLength The maximun length frame to read
sl@0:      */
sl@0:     inline void Read(TRequestStatus &aStatus,TDes8 &aDes,TInt aLength);
sl@0:     /**
sl@0:      * Cancel a pending read request
sl@0:      */
sl@0:     inline void ReadCancel();
sl@0: 
sl@0:     /**
sl@0:      * Write to the channel
sl@0:      * @param aStatus The callback status 
sl@0:      * @param aDes Buffer containing the frame to be sent
sl@0:      */
sl@0:     inline void Write(TRequestStatus &aStatus,const TDesC8 &aDes);
sl@0:     /**
sl@0:      * Write to the channel
sl@0:      * @param aStatus The callback status 
sl@0:      * @param aDes Buffer containing the frame to be sent
sl@0:      * @param aLength The length of the frame to send
sl@0:      */
sl@0:     inline void Write(TRequestStatus &aStatus,const TDesC8 &aDes,TInt aLength);
sl@0:     /**
sl@0:      * Cancel a pending write request
sl@0:      */
sl@0:     inline void WriteCancel();
sl@0: 
sl@0:     /**
sl@0:      * Get the channels configuration
sl@0:      * @param aConfig Buffer that will contain an configuration object
sl@0:      */
sl@0:     inline void Config(TDes8 &aConfig);
sl@0:     /**
sl@0:      * Set the channels configuration
sl@0:      * @param aConfig Buffer containing an configuration object
sl@0:      */
sl@0:     inline TInt SetConfig(const TDesC8 &aConfig);
sl@0:     /**
sl@0:      * Set the channels MAC address
sl@0:      * @param aConfig Buffer containing an configuration object with the MAC 
sl@0:      * address set
sl@0:      */
sl@0:     inline TInt SetMAC(const TDesC8 &aConfig);
sl@0: 
sl@0:     /**
sl@0:      * Request the channels capabilities
sl@0:      * @param aCaps Buffer to contain the capibilites object
sl@0:      */
sl@0:     inline void Caps(TDes8 &aCaps);
sl@0:     
sl@0: #ifdef ETH_CHIP_IO_ENABLED    
sl@0:     inline void ChipIOCtrl(TRequestStatus &aStatus,TPckgBuf<TChipIOInfo> &aDes);
sl@0: #endif
sl@0:     #endif
sl@0:     };
sl@0: 
sl@0: /** @} */ // End of external interface
sl@0: #include <d32ethernet.inl>
sl@0: 
sl@0: #endif