sbUSBDeviceUtils.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set sw=2 :miv */
/*
 *=BEGIN SONGBIRD GPL
 *
 * This file is part of the Songbird web player.
 *
 * Copyright(c) 2005-2010 POTI, Inc.
 * http://www.songbirdnest.com
 *
 * This file may be licensed under the terms of of the
 * GNU General Public License Version 2 (the ``GPL'').
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the GPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the GPL along with this
 * program. If not, go to http://www.gnu.org/licenses/gpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 *=END SONGBIRD GPL
 */

#ifndef __SB_USB_DEVICE_UTILS_H__
#define __SB_USB_DEVICE_UTILS_H__

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//
// Songbird USB device utilities defs.
//
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//------------------------------------------------------------------------------
//
// Songbird USB device utilities imported services.
//
//------------------------------------------------------------------------------

// Mozilla imports.
#include <nsAutoPtr.h>
#include <nsTArray.h>


//------------------------------------------------------------------------------
//
// Songbird USB device utilities typedefs.
//
//------------------------------------------------------------------------------

// List of USB descriptors.
class sbUSBDescriptor;
typedef nsTArray<nsRefPtr<sbUSBDescriptor> > sbUSBDescriptorList;


//------------------------------------------------------------------------------
//
// Songbird USB standard defs and structures.
//
//------------------------------------------------------------------------------

//
// USB descriptor type defs.
//

#define SB_USB_DESCRIPTOR_TYPE_DEVICE        1
#define SB_USB_DESCRIPTOR_TYPE_CONFIGURATION 2
#define SB_USB_DESCRIPTOR_TYPE_STRING        3
#define SB_USB_DESCRIPTOR_TYPE_INTERFACE     4
#define SB_USB_DESCRIPTOR_TYPE_ENDPOINT      5

//
// Apple's USB vendor ID is 05ac according to: http://www.linux-usb.org/usb.ids
//
#define SB_USB_APPLE_VENDOR_ID 0x05ac

typedef struct
{
  PRUint8                       bLength;
  PRUint8                       bDescriptorType;
} sbUSBDescriptorHeader;


typedef struct
{
  PRUint8                       bLength;
  PRUint8                       bDescriptorType;
  PRUint16                      bcdUSB;
  PRUint8                       bDeviceClass;
  PRUint8                       bDeviceSubClass;
  PRUint8                       bDeviceProtocol;
  PRUint8                       bMaxPacketSize0;
  PRUint16                      idVendor;
  PRUint16                      idProduct;
  PRUint16                      bcdDevice;
  PRUint8                       iManufacturer;
  PRUint8                       iProduct;
  PRUint8                       iSerialNumber;
  PRUint8                       bNumConfigurations;
} sbUSBDeviceDescriptor;


typedef struct
{
  PRUint8                       bLength;
  PRUint8                       bDescriptorType;
  PRUint16                      wTotalLength;
  PRUint8                       bNumInterfaces;
  PRUint8                       bConfigurationValue;
  PRUint8                       iConfiguration;
  PRUint8                       bmAttributes;
  PRUint8                       bMaxPower;
} sbUSBConfigurationDescriptor;


typedef struct
{
  PRUint8                       bLength;
  PRUint8                       bDescriptorType;
  PRUint8                       bInterfaceNumber;
  PRUint8                       bAlternateSetting;
  PRUint8                       bNumEndpoints;
  PRUint8                       bInterfaceClass;
  PRUint8                       bInterfaceSubClass;
  PRUint8                       bInterfaceProtocol;
  PRUint8                       iInterface;
} sbUSBInterfaceDescriptor;


typedef struct
{
  PRUint8                       bLength;
  PRUint8                       bDescriptorType;
  PRUnichar                     bString[1];
} sbUSBStringDescriptor;


//------------------------------------------------------------------------------
//
// Songbird USB device utilities classes and structures.
//
//------------------------------------------------------------------------------

//
// sbUSBDeviceRef               Reference to a USB device.  This class should be
//                              sub-classed by the USB device system services
//                              to contain whatever data is required to
//                              reference a USB device.
//

class sbUSBDeviceRef {};


class sbUSBDescriptor : public nsISupports
{
public:
  //
  // Inherited interfaces.
  //

  NS_DECL_ISUPPORTS


  //
  // Constructors/destructors.
  //

  sbUSBDescriptor(void*    aDescriptor,
                  PRUint16 aDescriptorLength) {
    mDescriptor = NS_Alloc(aDescriptorLength);
    if (mDescriptor) {
      mTotalLength = aDescriptorLength;
      memcpy(mDescriptor, aDescriptor, mTotalLength);
    } else {
      mTotalLength = 0;
    }
  }

  sbUSBDescriptor(sbUSBDescriptorHeader* aDescriptor)
  {
    if (aDescriptor && (aDescriptor->bLength > 0))
      mDescriptor = NS_Alloc(aDescriptor->bLength);
    else
      mDescriptor = nsnull;
    if (mDescriptor) {
      mTotalLength = aDescriptor->bLength;
      memcpy(mDescriptor, aDescriptor, mTotalLength);
    } else {
      mTotalLength = 0;
    }
  }

  virtual ~sbUSBDescriptor()
  {
    if (mDescriptor)
      NS_Free(mDescriptor);
  }


  void* Get()
  {
    return mDescriptor;
  }

  sbUSBDescriptorHeader* GetHeader()
  {
    return static_cast<sbUSBDescriptorHeader*>(mDescriptor);
  }

  sbUSBConfigurationDescriptor* GetConfiguration()
  {
    return static_cast<sbUSBConfigurationDescriptor*>(mDescriptor);
  }

  sbUSBDeviceDescriptor* GetDevice()
  {
    return static_cast<sbUSBDeviceDescriptor*>(mDescriptor);
  }

  sbUSBStringDescriptor* GetString()
  {
    return static_cast<sbUSBStringDescriptor*>(mDescriptor);
  }

  PRUint16 GetTotalLength()
  {
    return mTotalLength;
  }


private:
  //
  // mDescriptor                USB descriptor.
  // mTotalLength               Total length of descriptor data.
  //

  void*                         mDescriptor;
  PRUint16                      mTotalLength;
};


//------------------------------------------------------------------------------
//
// Songbird USB device services.
//
//------------------------------------------------------------------------------

//
// Songbird USB device services.
//

nsresult sbUSBDeviceImplementsClass(sbUSBDescriptorList& aDescriptorList,
                                    PRUint8              aUSBClass,
                                    PRBool*              aImplementsClass);

nsresult sbUSBDeviceGetDescriptor(sbUSBDeviceRef*   aDeviceRef,
                                  PRUint8           aDescriptorType,
                                  PRUint8           aDescriptorIndex,
                                  PRUint16          aDescriptorIndex2,
                                  sbUSBDescriptor** aDescriptor);

nsresult sbUSBDeviceGetStringDescriptor(sbUSBDeviceRef* aDeviceRef,
                                        PRUint8         aDescriptorIndex,
                                        PRUint16        aDescriptorIndex2,
                                        nsAString&      aString);

nsresult sbUSBDeviceGetLanguageList(sbUSBDeviceRef*     aDeviceRef,
                                    nsTArray<PRUint16>& aLanguageList);

nsresult sbUSBDeviceAddConfigurationDescriptors
           (sbUSBDeviceRef*      aDeviceRef,
            PRUint8              aConfigurationIndex,
            sbUSBDescriptorList& aDescriptorList);


//
// Songbird USB device system services.
//
//   These services must be provided by a system dependent sources.
//

nsresult sbUSBDeviceGetDescriptor(sbUSBDeviceRef*   aDeviceRef,
                                  PRUint8           aDescriptorType,
                                  PRUint8           aDescriptorIndex,
                                  PRUint16          aDescriptorIndex2,
                                  PRUint16          aDescriptorLength,
                                  sbUSBDescriptor** aDescriptor);


#endif // __SB_USB_DEVICE_UTILS_H__