etherage 0.5.1

use crate::{
    master::Master,
    rawmaster::{RawMaster, SlaveAddress},
    data::{PduData, Field},
    sii::{Sii, SiiError},
    mailbox::Mailbox,
    can::Can,
    registers::{self, AlError},
    eeprom,
    error::{EthercatError, EthercatResult},
    };
use tokio::sync::{Mutex, MutexGuard};
use std::sync::Arc;
use core::time::Duration;



pub type CommunicationState = registers::AlState;
use registers::AlState::*;



/**
    This struct exposes the ethercat master functions addressing one slave.

    Its lifetime refers to the [Master] the slave answers to.

    ## Note

    At contrary to [RawMaster], this struct is protocol-safe, which mean the communication cannot break because methods as not been called in the right order or at the right moment. There is nothing the user can do that might accidentally break the communication.
    The communication might however fail for hardware reasons, and the communication-safe functions shall report such errors.
    
    ## Communication state
    
    A slave's current [CommunicationState] determines what this slave is capable of doing. Upgrading or downgrading the communication states is done though [Slave::switch].
    
    ![communication state](https://raw.githubusercontent.com/jimy-byerley/etherage/master/schemes/communication-state.svg)

    ## Example

    The following is a typical configuration sequence of a slave

    ```ignore
    slave.switch(CommunicationState::Init).await;
    slave.set_address(1).await;
    slave.init_mailbox().await;
    slave.init_coe().await;
    slave.switch(CommunicationState::PreOperational).await;
    group.configure(&slave).await;
    slave.switch(CommunicationState::SafeOperational).await;
    slave.switch(CommunicationState::Operational).await;
    ```

    In this example, `group` is a tool to manage the logical memory and mappings from [crate::mapping].
*/

pub struct Slave<'a> {
    master: Arc<RawMaster>,
    /// current address in use, fixed or topological
    address: SlaveAddress,
    /// assumed current state
    state: CommunicationState,
    /// safe master to report to if existing
    safemaster: Option<&'a Master>,

    // internal structures are inter-referencing, thus must be stored in Rc to ensure the references to it will not void because of deallocation or data move
    sii: Option<Mutex<Sii>>,
    mailbox: Option<Arc<Mutex<Mailbox>>>,
    coe: Option<Arc<Mutex<Can>>>,
}
impl<'a> Slave<'a> {
    /**
        build a slave from a `RawMaster`. As everything constructed with a `RawMaster` this is not protocol-safe: no check is done, in particular nothing prevents to create multiple instances for the same physical slave, or for non-existing slaves.
        However if the physical slave is used only through one `Slave` instance, all operations will be protocol-safe.
    */
    pub fn raw(master: Arc<RawMaster>, address: SlaveAddress) -> Self {
        Self {
            master,
            safemaster: None,
            address,
            state: Init,

            sii: None,
            mailbox: None,
            coe: None,
        }
    }
    /**
        build a slave from a `Master`. exclusive acces to the addressed slave is ensured by `Master`, and the use of this struct will be protocl-safe.
    */
    pub async fn new(master: &'a Master, address: SlaveAddress) -> EthercatResult<Slave<'a>> {
        let fixed = SlaveAddress::Fixed(master.raw.read(address, registers::address::fixed).await.one()?);
        let mut book = master.slaves.lock().unwrap();
        
        if book.contains(&address)
        || book.contains(&fixed)
            {Err(EthercatError::Master("slave already in use by an other instance"))}
        else {
            book.insert(address);
            drop(book);
            Ok(Self {
                master: master.raw.clone(),
                safemaster: Some(master),
                address,
                state: Init,

                sii: None,
                mailbox: None,
                coe: None,
            })
        }
    }

    /// return a reference to the underlying `RawMaster` used, this method is unsafe since it allows accessing any slave concurrently to what all `Slave` and `Master` instances are doing.
    pub unsafe fn raw_master(&self) -> &Arc<RawMaster> {&self.master}

    /// retreive the slave's identification informations
    pub fn informations(&self)  {todo!()}

    /// return the current state of the slave, it does not the current expected state for this slave
    pub async fn state(&self) -> EthercatResult<CommunicationState> {
        self.master.read(self.address, registers::al::status).await.one()?
            .state().try_into()
            .map_err(|_| EthercatError::Protocol("undefined slave state"))
    }
    /// send a state change request to the slave, and return once the slave has switched
    pub async fn switch(&mut self, target: CommunicationState) -> EthercatResult<(), AlError>  {
        // send state switch request
        self.master.write(self.address, registers::al::control, {
                let mut config = registers::AlControlRequest::default();
                config.set_state(target.into());
                config.set_ack(true);
                config.set_request_id(true);
                config
		}).await.one()?;

        // wait for state change, or error
        loop {
            let status = self.master.read(self.address, registers::al::response).await.one()?;
            if status.error() {
//                 if status.id() {
                    let error = self.master.read(self.address, registers::al::error).await.one()?;
                    if error != registers::AlError::NoError
                        {return Err(EthercatError::Slave(self.address, error))}
//                 }
//                 else 
//                     {return Err(EthercatError::Protocol("error during state change, but no error code provided"))}
            }
            if status.state() == target.into()  {break}
        }
        self.state = target;
		Ok(())
    }
    /**
        set the expected state of the slave.

        this actually does not perform any operation on the slave, but will change the expected behavior and thus error handling of the slave's methods
    */
    pub fn expect(&mut self, state: CommunicationState) {
        self.state = state;
    }
    /// expected state of the slave
    pub fn expected(&self) -> CommunicationState {
        self.state
    }

    /// get the current address used to communicate with the slave
    pub fn address(&self) -> SlaveAddress  {self.address}
    /// set a fixed address for the slave, `0` is forbidden
    pub async fn set_address(&mut self, fixed: u16) -> EthercatResult {
        assert!(fixed != 0);
        self.master.write(self.address, registers::address::fixed, fixed).await.one()?;
        let new = SlaveAddress::Fixed(fixed);
        // report existing address if a safemaster is used
        if let Some(safe) = self.safemaster {
            let mut book = safe.slaves.lock().unwrap();
            book.remove(&self.address);
            book.insert(new);
        }
        self.address = new;
        Ok(())
    }
    /// reset fixed address, the slave instance is consumed because the original topological address may have changed since
    pub async fn reset_address(self) -> EthercatResult {
        self.master.write(self.address, registers::address::fixed, 0).await.one()?;
        Ok(())
    }

    /// initialize the SII which grants access to the EEPROM
    pub async fn init_sii(&mut self) -> EthercatResult<(), SiiError> {
        let sii = Sii::new(self.master.clone(), self.address).await?;
        self.sii = Some(Mutex::new(sii));
        Ok(())
    }

    /// initialize the slave's mailbox (if supported by the slave)
    pub async fn init_mailbox(&mut self) -> EthercatResult<(), SiiError> {
        assert_eq!(self.state, Init);

        let address = match self.address {
            SlaveAddress::Fixed(i) => i,
            _ => panic!("mailbox is unsafe without fixed addresses"),
        };
        // get recommended settings
        if self.sii.is_none() {
            self.init_sii().await?;
        }
        let mut sii = self.sii().await;
        sii.acquire().await?;
        let write_offset = sii.read(eeprom::mailbox::standard::write::offset).await?;
        let write_size   = sii.read(eeprom::mailbox::standard::write::size).await?;
        let read_offset  = sii.read(eeprom::mailbox::standard::read::offset).await?;
        let read_size    = sii.read(eeprom::mailbox::standard::read::size).await?;
        sii.release().await?;
        drop(sii);

        // setup the mailbox
        let mailbox = Mailbox::new(
            self.master.clone(),
            address,
            (registers::sync_manager::interface.mailbox_write(), write_offset .. write_offset + write_size),
            (registers::sync_manager::interface.mailbox_read(), read_offset .. read_offset + read_size),
            ).await?;

        self.coe = None;
        self.mailbox = Some(Arc::new(Mutex::new(mailbox)));
        Ok(())
    }

    /// initialize CoE (Canopen over Ethercat) communication (if supported by the slave), this requires the mailbox to be initialized
    pub async fn init_coe(&mut self) -> EthercatResult<(), SiiError> {
        if self.mailbox.is_none() {
            self.init_mailbox().await?;
        }
        let mailbox = self.mailbox.clone().unwrap();
        self.coe = Some(Arc::new(Mutex::new(Can::new(mailbox))));
        Ok(())
    }

    /**
        enable synchronization of slaves tasks to the master

        Once enabled, the synchronous data exchanges done by the master must be in synchronization with the [DistributedClock](crate::clock::DistributedClock). And should send by anticipating the master-reference delay so that the data arrives on the reference slave when the clock value modulo is wrapping.

        ## Note:

        at the moment, only dc sync0 is supported. dc sync1 is not, SM-sync is not, SM-DC-sync is not
    */
    pub async fn init_sync(&mut self, period: Duration, activation: Duration) -> EthercatResult {
        assert_eq!(self.state, PreOperational);
        let period = u32::try_from(period.as_nanos()).expect("synchronization period must be below 4seconds");
        let activation = u32::try_from(activation.as_nanos()).expect("activation delay must be below 4seconds");

        self.master.write(self.address, registers::isochronous::sync::enable, Default::default()).await.one()?;
        self.master.write(self.address, Field::<u8>::simple(0x980), 0).await.one()?;
        let start = self.master.read(self.address, registers::dc::system_time).await.one()? as u32;
        let start = ((start + activation) / period) * period + period;
        self.master.write(self.address, registers::isochronous::sync::start_time, start).await.one()?;
        self.master.write(self.address, registers::isochronous::sync::sync0_cycle_time, period).await.one()?;
        self.master.write(self.address, registers::isochronous::sync::enable, {
			let mut enables = registers::IsochronousEnables::default();
			enables.set_operation(true);
			enables.set_sync0(true);
			enables
			}).await.one()?;
        Ok(())
    }

    /// lock access to SII communication and return the instance of [Sii] controling it
    pub async fn sii(&self) -> MutexGuard<'_, Sii> {
        self.sii
            .as_ref().expect("sii not initialized")
            .lock().await
    }

    /// locks access to CoE communication and return the underlying instance of [Can] running CoE
    pub async fn coe(&self) -> MutexGuard<'_, Can>    {
        self.coe
            .as_ref().expect("coe not initialized")
            .lock().await
    }

//     /// locks access to EoE communication
//     pub fn eoe(&'a self) {todo!()}

    /// read a value from the slave's physical memory
    pub async fn physical_read<T: PduData>(&self, field: Field<T>) -> EthercatResult<T>  {
        self.master.read(self.address, field).await.one()
    }
}

impl Drop for Slave<'_> {
    fn drop(&mut self) {
        // deregister from the safemaster if any
        if let Some(safe) = self.safemaster {
            let mut book = safe.slaves.lock().unwrap();
            book.remove(&self.address);
        }
    }
}


impl From<EthercatError<()>> for EthercatError<AlError> {
    fn from(src: EthercatError<()>) -> Self {src.upgrade()}
}