IProgrammer.java

/*******************************************************************************
 * Copyright (c) 2008, 2011 Thomas Holland (thomas@innot.de) and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Thomas Holland - initial API and implementation
 *******************************************************************************/

package de.innot.avreclipse.core.targets;

/**
 * Description of programmer interface hardware.
 * <p>
 * This interface represents a single programmer interface.
 * </p>
 * <p>
 * A list of supported <code>IProgrammer</code> objects is returned by every implementation of the
 * <code>ITargetConfigurationTool</code> interface.
 * </p>
 * 
 * 
 * @author Thomas Holland
 * @since 2.4
 * 
 */
public interface IProgrammer {

	/**
	 * Returns the id of the programmer.
	 * <p>
	 * The id is determined by the implementation. The id is unique, every id will represent only a
	 * single programmer. However a single programmer can have more than one id (as is done with
	 * avrdude).
	 * </p>
	 * <p>
	 * The baseline for id values are the programmer id's from avrdude.
	 * <code>ITargetConfigurationTools</code> supporting the same programmers as avrdude should use
	 * the same id values. <code>ITargetConfigurationTools</code> that support programmers not
	 * supported by avrdude must use separate id values.
	 * </p>
	 * 
	 * @return
	 */
	public String getId();

	/**
	 * Returns a descriptive name of the programmer.
	 * <p>
	 * The description is used in the user interface.
	 * </p>
	 * 
	 * @return
	 */
	public String getDescription();

	/**
	 * Returns additional info about the programmer.
	 * <p>
	 * This info is used by the user interface to display additional info.
	 * </p>
	 * 
	 * @return
	 */
	public String getAdditionalInfo();

	/**
	 * Returns all host interfaces the programmer supports.
	 * <p>
	 * Most programmer hardware supports only a single host interface, e.g. the serial port, but
	 * some hardware, like the AVR ICE MkII can be connected to either the serial port or via usb.
	 * So this function may returns an array of all {@link HostInterface}s supported by the
	 * programmer.
	 * </p>
	 * 
	 * @return <code>HostInterface</code>s supported by the programmer.
	 */
	public HostInterface[] getHostInterfaces();

	/**
	 * Returns the target interface supported by the programmer.
	 * 
	 * @return {@link TargetInterface}
	 */
	public TargetInterface getTargetInterface();

	/**
	 * Returns an array of usable target interface clock frequencies.
	 * <p>
	 * This is only supported by some programmers.
	 * </p>
	 * <p>
	 * The returned array is sorted from the lowest to the highest frequency and always has a value
	 * of <code>0</code> as its first element</code>. If the programmer does not support user
	 * selectable clock frequencies then an empty array is returned.
	 * 
	 * @return Array of clock frequencies. May be empty.
	 */
	public int[] getTargetInterfaceClockFrequencies();

	/**
	 * Returns whether the programmer is capable of JTAG daisy chaining.
	 * 
	 * @return <code>true</code> if the programmer supports JTAG daisy chaining.
	 */
	public boolean isDaisyChainCapable();

	/**
	 * Returns true if the config has a parent.
	 */
	public boolean hasParent();
}