sbIDeviceFirmwareHandler.idl

Go to the documentation of this file.

/*
 *=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
 */

#include "nsISupports.idl"

interface nsISimpleEnumerator;
interface nsIURI;
interface sbIDevice;
interface sbIDeviceEventListener;
interface sbIDeviceFirmwareUpdate;

[scriptable, uuid(caf2294b-da39-48ac-859a-6ebfd4433eeb)]
interface sbIDeviceFirmwareHandler : nsISupports
{
  readonly attribute AString contractId;

  readonly attribute nsIURI latestFirmwareLocation;
  
  readonly attribute unsigned long latestFirmwareVersion;

  readonly attribute AString latestFirmwareReadableVersion;

  readonly attribute unsigned long currentFirmwareVersion;
  readonly attribute AString currentFirmwareReadableVersion;

  readonly attribute nsIURI releaseNotesLocation;

  readonly attribute nsIURI resetInstructionsLocation;

  readonly attribute AString recoveryModeKeyCombination;

  readonly attribute nsIURI customerSupportLocation;

  readonly attribute nsIURI registerLocation;

  readonly attribute boolean needsRecoveryMode;

  readonly attribute boolean recoveryMode;

  readonly attribute sbIDeviceFirmwareUpdate defaultFirmwareUpdate;

  readonly attribute sbIDevice boundDevice;

  readonly attribute AString deviceModelNumber;

  readonly attribute AString deviceModelVersion;

  readonly attribute AString deviceVendor;

  readonly attribute nsISimpleEnumerator supportedDevices;

  boolean canUpdate(in sbIDevice aDevice, 
                    in unsigned long aDeviceVendorID, 
                    in unsigned long aDeviceProductID);

  void initiateRecoveryModeSwitch(
                                 [optional] in unsigned long aDeviceVendorID,
                                 [optional] in unsigned long aDeviceProductID);

  void bind(in sbIDevice aDevice, in sbIDeviceEventListener aListener);

  boolean rebind(in sbIDevice aDevice, in sbIDeviceEventListener aListener);

  void unbind();

  void cancel();

  void refreshInfo();

  void update(in sbIDeviceFirmwareUpdate aFirmwareUpdate);

  void recover(in sbIDeviceFirmwareUpdate aFirmwareUpdate);

  void verifyDevice();
  
  void verifyUpdate(in sbIDeviceFirmwareUpdate aFirmwareUpdate);
};

%{C++

#include <nsIComponentManager.h>
#include <nsICategoryManager.h>
#include <nsIGenericFactory.h>
#include <nsIServiceManager.h>

#include <nsCOMPtr.h>
#include <nsServiceManagerUtils.h>
#include <nsStringGlue.h>
#include <nsXPCOMCID.h>

class nsIFile;
struct nsModuleComponentInfo;

#define SB_DEVICE_FIRMWARE_HANDLER_CATEGORY "songbird-device-firmware-handler"

#define SB_DEVICE_FIRMWARE_HANDLER_REGISTERSELF(_name)                               \
                                                                               \
  NS_METHOD _name##RegisterSelf(nsIComponentManager* aCompMgr,                 \
                                nsIFile* aPath,                                \
                                const char* registryLocation,                  \
                                const char* componentType,                     \
                                const nsModuleComponentInfo* info);            \
                                                                               \
  NS_METHOD _name##UnregisterSelf(nsIComponentManager* aCompMgr,               \
                                  nsIFile* aPath,                              \
                                  const char* registryLocation,                \
                                  const nsModuleComponentInfo* info)

#define SB_DEVICE_FIRMWARE_HANLDER_REGISTERSELF_IMPL(_name, _desc)             \
                                                                               \
  NS_METHOD                                                                    \
  _name##RegisterSelf(nsIComponentManager* aCompMgr,                           \
                      nsIFile* aPath,                                          \
                      const char* registryLocation,                            \
                      const char* componentType,                               \
                      const nsModuleComponentInfo* info)                       \
  {                                                                            \
    nsresult rv;                                                               \
    nsCOMPtr<nsICategoryManager> catMan =                                      \
      do_GetService(NS_CATEGORYMANAGER_CONTRACTID, &rv);                       \
    NS_ENSURE_SUCCESS(rv, rv);                                                 \
    nsCAutoString prevEntry;                                                   \
    rv = catMan->AddCategoryEntry(SB_DEVICE_FIRMWARE_HANDLER_CATEGORY,         \
                                  _desc,                                       \
                                  info->mContractID,                           \
                                  PR_TRUE, PR_TRUE,                            \
                                  getter_Copies(prevEntry));                   \
    NS_ENSURE_SUCCESS(rv, rv);                                                 \
    NS_WARN_IF_FALSE(prevEntry.IsEmpty(),                                      \
                     "Another controller was registered with that id!");       \
    return NS_OK;                                                              \
  }                                                                            \
                                                                               \
  NS_METHOD                                                                    \
  _name##UnregisterSelf(nsIComponentManager* aCompMgr,                         \
                        nsIFile* aPath,                                        \
                        const char* registryLocation,                          \
                        const nsModuleComponentInfo* info)                     \
  {                                                                            \
    nsresult rv;                                                               \
    nsCOMPtr<nsICategoryManager> catMan =                                      \
      do_GetService(NS_CATEGORYMANAGER_CONTRACTID, &rv);                       \
    NS_ENSURE_SUCCESS(rv, rv);                                                 \
    rv = catMan->DeleteCategoryEntry(SB_DEVICE_FIRMWARE_HANDLER_CATEGORY,      \
                                     _desc,                                    \
                                     PR_TRUE);                                 \
    NS_ENSURE_SUCCESS(rv, rv);                                                 \
    return NS_OK;                                                              \
  }
%}