//-----------------------------------------------------------------------
// <copyright file="IPassThruConnection.cs" company="bedug.com">
//     Copyright © 2012 Nils Hammar. All rights reserved.
// </copyright>
//-----------------------------------------------------------------------
/*
 * Software to access vehicle information via the OBD-II connector.
 * 
 * Copyright © 2012 Nils Hammar
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Alternative licensing is possible, see the licensing document.
 * 
 * The above text may not be removed or modified.
 */

namespace SharedObjects.Api
{
    /// <summary>
    /// Interface for handling one connection to the J2534 API.
    /// Notice: It is possible to have multiple connections, however only one per protocol family.
    /// </summary>
    public interface IPassThruConnection
    {
        /// <summary>
        /// Gets a string containing the last encountered error.
        /// </summary>
        string lastError { get; }

        /// <summary>
        /// Gets the Instance of the PassThruDevice that this PassThruConnection is applicable for.
        /// </summary>
        IPassThruDevice passThruDevice { get; }

        /// <summary>
        /// Get the flag indicating that the device has a disconnect bug in the API.
        /// </summary>
        /// <returns>'true' if disconnect bug exists.</returns>
        bool disconnectBug();

        /// <summary>
        /// Get array of possible connection flags for this connection.
        /// </summary>
        /// <returns>Array of flags.</returns>
        CanFlags[] getConnFlags();

        /// <summary>
        /// Get array of possible message flags for this connection.
        /// </summary>
        /// <returns>Array of flags.</returns>
        CanFlags[] getMessageFlags();

        /// <summary>
        /// Perform a connection.
        /// </summary>
        /// <param name="ProtocolID">ID of protocol to use.</param>
        /// <param name="Flags">Connection flags.</param>
        /// <param name="Baudrate">Baudrate to connect with.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode Gl_PassThruConnect(int ProtocolID, uint Flags, uint Baudrate);

        /// <summary>
        /// Disconnect the current connection.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode Gl_PassThruDisconnect();

        /// <summary>
        /// Perform IOCTL operation on connection.
        /// </summary>
        /// <param name="IoctlID">IOCTL operation.</param>
        /// <param name="pInput">Pointer to out data to IOCTL.</param>
        /// <param name="pOutput">Pointer to result data from IOCTL.</param>
        /// <returns>Result status, 0=success.</returns>
        unsafe PassThruConstants.resultCode Gl_PassThruIoctl(int IoctlID, void* pInput, void* pOutput);

        /// <summary>
        /// Read messages from the connection on the device.
        /// </summary>
        /// <param name="protocolId">ID of protocol.</param>
        /// <param name="msg">Received message (out data).</param>
        /// <param name="numMsgs">Number of messages to read and returns actual number of messages read.</param>
        /// <param name="Timeout">Timeout waiting for message.</param>
        /// <returns>Result status, 0=success.</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "2#", Justification = "Reviewed, intentional.")]
        PassThruConstants.resultCode Gl_PassThruReadMsgs(int protocolId, out IPassThruMsg msg, ref int numMsgs, int Timeout);

        /// <summary>
        /// Add a message filter.
        /// </summary>
        /// <param name="FilterType">Type of filter.</param>
        /// <param name="maskMsg">Mask message.</param>
        /// <param name="patternMsg">Pattern message.</param>
        /// <param name="flowControlMsg">Flow control message.</param>
        /// <param name="msgId">ID of filter added. (out value)</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode Gl_PassThruStartMsgFilter(uint FilterType, IPassThruMsg maskMsg, IPassThruMsg patternMsg, IPassThruMsg flowControlMsg, out int msgId);

        /// <summary>
        /// Start sending of a periodic message.
        /// </summary>
        /// <param name="msg">Message to send.</param>
        /// <param name="msgID">ID of message (out value)</param>
        /// <param name="TimeInterval">Interval between transmissions.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode Gl_PassThruStartPeriodicMsg(IPassThruMsg msg, out int msgID, int TimeInterval);

        /// <summary>
        /// Remove message filter.
        /// </summary>
        /// <param name="msgId">ID of filter to remove.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode Gl_PassThruStopMsgFilter(int msgId);

        /// <summary>
        /// Stop sending a periodic message.
        /// </summary>
        /// <param name="MsgID">ID of message.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode Gl_PassThruStopPeriodicMsg(int MsgID);

        /// <summary>
        /// Write a message on the connection to the device.
        /// </summary>
        /// <param name="msg">Message to write</param>
        /// <param name="numMsgs">Number of messages.</param>
        /// <param name="Timeout">Timeout waiting to write message.</param>
        /// <returns>Result status, 0=success.</returns>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1045:DoNotPassTypesByReference", MessageId = "1#", Justification = "Reviewed, intentional.")]
        PassThruConstants.resultCode Gl_PassThruWriteMsgs(IPassThruMsg msg, ref int numMsgs, int Timeout);

        /// <summary>
        /// Add to message lookup table.
        /// </summary>
        /// <param name="address">Address to add.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlAddToFunctMsgLookupTable(uint address);

        /// <summary>
        /// Clear message lookup table.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlClearFunctMsgLookupTable();

        /// <summary>
        /// Clear all filters.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlClearMsgFilters();

        /// <summary>
        /// Clear all periodic messages.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlClearPeriodicMsgs();

        /// <summary>
        /// Clear the RX buffer of the interface.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlClearRxBuffer();

        /// <summary>
        /// Clear the TX buffer of the interface.
        /// </summary>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlClearTxBuffer();

        /// <summary>
        /// Remove from message lookup table.
        /// </summary>
        /// <param name="address">Address to remove.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlDeleteFromFunctMsgLookupTable(uint address);

        /// <summary>
        /// Perform a Fast Init. This is for protocol KWP2000.
        /// </summary>
        /// <param name="protocol">Protocol ID</param>
        /// <param name="srcaddress">Source address to use.</param>
        /// <param name="result">Result message from init.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlFastInit(int protocol, uint srcaddress, out IPassThruMsg result);

        /// <summary>
        /// Perform a five baud init, used by ISO9141 and KWP2000 protocol.
        /// The returned keywords identifies which protocol it is.
        /// </summary>
        /// <param name="target">Target address.</param>
        /// <param name="outBytes">Number of received bytes.</param>
        /// <param name="keyword1">Keyword 1.</param>
        /// <param name="keyword2">Keyword 2.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlFiveBaudInit(uint target, out uint outBytes, out uint keyword1, out uint keyword2);

        /// <summary>
        /// Get parameter using IOCTL.
        /// </summary>
        /// <param name="parameter">Parameter to get.</param>
        /// <param name="value">Value of parameter. (out value)</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlGetParameter(uint parameter, out uint value);

        /// <summary>
        /// Read the programming voltage.
        /// </summary>
        /// <param name="value">Programming voltage. (out data)</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlReadProgVoltage(out uint value);

        /// <summary>
        /// Read battery voltage on interface.
        /// </summary>
        /// <param name="value">Battery voltage. (out parameter)</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlReadVbatt(out uint value);

        /// <summary>
        /// Specific IOCTL call to set data rate.
        /// </summary>
        /// <param name="value">Data rate to set.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlSetDataRate(uint value);

        /// <summary>
        /// Set loopback flag on connection.
        /// </summary>
        /// <param name="state">'true' if sent messages shall be looped back to sender.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlSetLoopback(bool state);

        /// <summary>
        /// Set network line on interface.
        /// </summary>
        /// <param name="value">Network line to set.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlSetNetworkLine(uint value);

        /// <summary>
        /// Set address of this node on the interface.
        /// </summary>
        /// <param name="value">Address to set.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlSetNodeAddress(uint value);

        /// <summary>
        /// Set parameter using IOCTL.
        /// </summary>
        /// <param name="parameter">ID of parameter to set.</param>
        /// <param name="value">Value of parameter to set.</param>
        /// <returns>Result status, 0=success.</returns>
        PassThruConstants.resultCode IoctlSetParameter(uint parameter, uint value);
    }
}