Rearrange mctp trait arguments for consistency

Previously arguments to send() and return value from recv() had
different orders. These are now consistent, always ordered
(typ, ic, buf, resp) where applicable.

pldm and control protocol handlers are updated likewise.

Signed-off-by: Matt Johnston <[email protected]>

Author: mkj

mctp-estack/src/control.rs

@@ -226,11 +226,11 @@ pub fn respond_error<'a>(
 pub fn mctp_control_rx_req<'f, 'l, L>(
     listener: &'l mut L,
     buf: &'f mut [u8],
-) -> mctp::Result<(L::RespChannel<'l>, MctpControlMsg<'f>)>
+) -> mctp::Result<(MctpControlMsg<'f>, L::RespChannel<'l>)>
 where
     L: Listener,
 {
-    let (buf, ch, typ, ic) = listener.recv(buf)?;
+    let (typ, ic, buf, ch) = listener.recv(buf)?;
     if ic.0 {
         return Err(Error::InvalidInput);
     }
@@ -240,7 +240,7 @@ where
     }
 
     let msg = MctpControlMsg::from_buf(buf).map_err(|_| Error::InvalidInput)?;
-    Ok((ch, msg))
+    Ok((msg, ch))
 }
 
 /// A Control Message handler.

mctp-estack/src/router.rs

@@ -770,7 +770,7 @@ impl mctp::AsyncReqChannel for RouterAsyncReqChannel<'_> {
     async fn recv<'f>(
         &mut self,
         buf: &'f mut [u8],
-    ) -> Result<(&'f mut [u8], MsgType, MsgIC)> {
+    ) -> Result<(MsgType, MsgIC, &'f mut [u8])> {
         let Some(Tag::Owned(tv)) = self.sent_tag else {
             debug!("recv without send");
             return Err(Error::BadArgument);
@@ -782,8 +782,7 @@ impl mctp::AsyncReqChannel for RouterAsyncReqChannel<'_> {
             .await?;
         debug_assert_eq!(tag, recv_tag);
         debug_assert_eq!(eid, self.eid);
-        Ok((buf, typ, ic))
-        // todo!()
+        Ok((typ, ic, buf))
     }
 
     fn remote_eid(&self) -> Eid {
@@ -857,7 +856,7 @@ impl<'r> mctp::AsyncListener for RouterAsyncListener<'r> {
     async fn recv<'f>(
         &mut self,
         buf: &'f mut [u8],
-    ) -> mctp::Result<(&'f mut [u8], Self::RespChannel<'_>, MsgType, MsgIC)>
+    ) -> mctp::Result<(MsgType, MsgIC, &'f mut [u8], Self::RespChannel<'_>)>
     {
         let (msg, eid, typ, tag, ic) = self
             .router
@@ -875,7 +874,7 @@ impl<'r> mctp::AsyncListener for RouterAsyncListener<'r> {
             router: self.router,
             typ,
         };
-        Ok((msg, resp, typ, ic))
+        Ok((typ, ic, msg, resp))
     }
 }
 

mctp-linux/examples/mctp-req.rs

@@ -25,7 +25,7 @@ fn main() -> std::io::Result<()> {
     // Receive a response. We create a 16-byte vec to read into; ep.recv()
     // will return the sub-slice containing just the response data.
     let mut rx_buf = vec![0u8; 16];
-    let (rx_buf, eid, ic) = ep.recv(&mut rx_buf)?;
+    let (eid, ic, rx_buf) = ep.recv(&mut rx_buf)?;
 
     println!("response from {}, ic {:?}: {:x?}", eid, ic, rx_buf);
 

mctp-linux/src/lib.rs

@@ -363,7 +363,7 @@ impl mctp::ReqChannel for MctpLinuxReq {
     fn recv<'f>(
         &mut self,
         buf: &'f mut [u8],
-    ) -> Result<(&'f mut [u8], MsgType, MsgIC)> {
+    ) -> Result<(MsgType, MsgIC, &'f mut [u8])> {
         if !self.sent {
             return Err(mctp::Error::BadArgument);
         }
@@ -374,7 +374,7 @@ impl mctp::ReqChannel for MctpLinuxReq {
             // Kernel gave us a message from a different sender?
             return Err(mctp::Error::Other);
         }
-        Ok((&mut buf[..sz], typ, ic))
+        Ok((typ, ic, &mut buf[..sz]))
     }
 
     fn remote_eid(&self) -> Eid {
@@ -429,7 +429,7 @@ impl mctp::Listener for MctpLinuxListener {
     fn recv<'f>(
         &mut self,
         buf: &'f mut [u8],
-    ) -> Result<(&'f mut [u8], MctpLinuxResp<'_>, MsgType, MsgIC)> {
+    ) -> Result<(MsgType, MsgIC, &'f mut [u8], MctpLinuxResp<'_>)> {
         let (sz, addr) = self.sock.recvfrom(buf)?;
         let src = Eid(addr.0.smctp_addr);
         let (typ, ic) = mctp::decode_type_ic(addr.0.smctp_type);
@@ -448,7 +448,7 @@ impl mctp::Listener for MctpLinuxListener {
             listener: self,
             typ,
         };
-        Ok((&mut buf[..sz], ep, typ, ic))
+        Ok((typ, ic, &mut buf[..sz], ep))
     }
 }
 

mctp/src/lib.rs

@@ -265,7 +265,7 @@ pub trait ReqChannel {
     fn recv<'f>(
         &mut self,
         buf: &'f mut [u8],
-    ) -> Result<(&'f mut [u8], MsgType, MsgIC)>;
+    ) -> Result<(MsgType, MsgIC, &'f mut [u8])>;
 
     /// Return the remote Endpoint ID
     fn remote_eid(&self) -> Eid;
@@ -292,7 +292,7 @@ pub trait AsyncReqChannel {
     fn recv<'f>(
         &mut self,
         buf: &'f mut [u8],
-    ) -> impl Future<Output = Result<(&'f mut [u8], MsgType, MsgIC)>>;
+    ) -> impl Future<Output = Result<(MsgType, MsgIC, &'f mut [u8])>>;
 
     /// Return the remote Endpoint ID
     fn remote_eid(&self) -> Eid;
@@ -410,7 +410,7 @@ pub trait Listener {
     fn recv<'f>(
         &mut self,
         buf: &'f mut [u8],
-    ) -> Result<(&'f mut [u8], Self::RespChannel<'_>, MsgType, MsgIC)>;
+    ) -> Result<(MsgType, MsgIC, &'f mut [u8], Self::RespChannel<'_>)>;
 }
 
 #[allow(missing_docs)]
@@ -431,7 +431,7 @@ pub trait AsyncListener {
         &mut self,
         buf: &'f mut [u8],
     ) -> impl Future<
-        Output = Result<(&'f mut [u8], Self::RespChannel<'_>, MsgType, MsgIC)>,
+        Output = Result<(MsgType, MsgIC, &'f mut [u8], Self::RespChannel<'_>)>,
     >;
 }
 

pldm-fw/src/ua.rs

@@ -348,7 +348,7 @@ where
 
     loop {
         // we should be in update mode, handle incoming data requests
-        let (mut req_ep, fw_req) = pldm::pldm_rx_req(listener)?;
+        let (fw_req, mut req_ep) = pldm::pldm_rx_req(listener)?;
 
         if fw_req.typ != PLDM_TYPE_FW {
             return Err(PldmUpdateError::new_proto(format!(
@@ -452,7 +452,7 @@ where
     }
 
     /* Verify results.. */
-    let (mut req_ep, fw_req) = pldm::pldm_rx_req(listener)?;
+    let (fw_req, mut req_ep) = pldm::pldm_rx_req(listener)?;
     match fw_req.cmd {
         0x17 => {
             let res = fw_req.data[0];
@@ -474,7 +474,7 @@ where
     drop(req_ep);
 
     /* Apply */
-    let (mut req_ep, fw_req) = pldm::pldm_rx_req(listener)?;
+    let (fw_req, mut req_ep) = pldm::pldm_rx_req(listener)?;
     match fw_req.cmd {
         0x18 => {
             let res = fw_req.data[0];

pldm/src/lib.rs

@@ -434,13 +434,13 @@ pub fn pldm_xfer_buf<'buf>(
 #[cfg(feature = "alloc")]
 pub fn pldm_rx_req<'lis, L>(
     listener: &'lis mut L,
-) -> Result<(L::RespChannel<'lis>, PldmRequest<'static>)>
+) -> Result<(PldmRequest<'static>, L::RespChannel<'lis>)>
 where
     L: mctp::Listener,
 {
     let mut rx_buf = [0u8; PLDM_MAX_MSGSIZE]; // todo: set size? peek?
-    let (ep, req) = pldm_rx_req_borrowed(listener, &mut rx_buf)?;
-    Ok((ep, req.make_owned()))
+    let (req, ep) = pldm_rx_req_borrowed(listener, &mut rx_buf)?;
+    Ok((req.make_owned(), ep))
 }
 
 /// Receive an incoming PLDM request in a borrowed buffer.
@@ -454,11 +454,11 @@ where
 pub fn pldm_rx_req_borrowed<'lis, 'buf, L>(
     listener: &'lis mut L,
     rx_buf: &'buf mut [u8],
-) -> Result<(L::RespChannel<'lis>, PldmRequest<'buf>)>
+) -> Result<(PldmRequest<'buf>, L::RespChannel<'lis>)>
 where
     L: mctp::Listener,
 {
-    let (rx_buf, ep, _typ, ic) = listener.recv(rx_buf)?;
+    let (typ, ic, rx_buf, ep) = listener.recv(rx_buf)?;
     if ic.0 {
         return Err(proto_error!("IC bit set"));
     }
@@ -468,15 +468,15 @@ where
     }
     let req = PldmRequest::from_buf_borrowed(rx_buf)?;
 
-    Ok((ep, req))
+    Ok((req, ep))
 }
 
 /// Receive an incoming PLDM response in a borrowed buffer.
 pub fn pldm_rx_resp_borrowed<'buf>(
     ep: &mut impl mctp::ReqChannel,
     rx_buf: &'buf mut [u8],
 ) -> Result<PldmResponse<'buf>> {
-    let (rx_buf, _eid, ic) = ep.recv(rx_buf)?;
+    let (_typ, ic, rx_buf) = ep.recv(rx_buf)?;
     if ic.0 {
         return Err(proto_error!("IC bit set"));
     }

standalone/examples/echo.rs

@@ -66,7 +66,7 @@ fn main() -> Result<()> {
     loop {
         let r = l.recv(&mut buf);
         match r {
-            Ok((buf, mut resp, _typ, _ic)) => {
+            Ok((_typ, _ic, buf, mut resp)) => {
                 info!("Received OK {buf:02x?}");
                 let r = resp.send(buf);
                 if let Err(e) = r {

standalone/examples/req.rs

@@ -100,7 +100,7 @@ fn req(
     info!("Sent OK");
 
     let mut buf = [0u8; 2000];
-    let (rep, rep_typ, _ic) = ch.recv(&mut buf)?;
+    let (rep_typ, _ic, rep) = ch.recv(&mut buf)?;
 
     info!("Reply {rep:02x?}");
 

standalone/src/serial.rs

@@ -184,7 +184,7 @@ impl<S: Read + Write> mctp::ReqChannel for MctpSerialReq<S> {
     fn recv<'f>(
         &mut self,
         buf: &'f mut [u8],
-    ) -> Result<(&'f mut [u8], MsgType, MsgIC)> {
+    ) -> Result<(MsgType, MsgIC, &'f mut [u8])> {
         let tv = self.sent_tv.ok_or(Error::BadArgument)?;
         let match_tag = Tag::Unowned(tv);
 
@@ -213,7 +213,7 @@ impl<S: Read + Write> mctp::ReqChannel for MctpSerialReq<S> {
                     buf.get_mut(..msg.payload.len()).ok_or(Error::NoSpace)?;
                 b.copy_from_slice(msg.payload);
                 self.inner.mctp.finished_receive(handle);
-                return Ok((b, typ, ic));
+                return Ok((typ, ic, b));
             } else {
                 warn!("Dropped unexpected MCTP message {msg:?}");
                 self.inner.mctp.finished_receive(handle);
@@ -285,7 +285,7 @@ impl<S: Read + Write> mctp::Listener for MctpSerialListener<S> {
     fn recv<'f>(
         &mut self,
         buf: &'f mut [u8],
-    ) -> Result<(&'f mut [u8], Self::RespChannel<'_>, MsgType, MsgIC)> {
+    ) -> Result<(MsgType, MsgIC, &'f mut [u8], Self::RespChannel<'_>)> {
         loop {
             // Receive a whole message
             let (msg, handle) = self.inner.receive(None)?;
@@ -306,7 +306,7 @@ impl<S: Read + Write> mctp::Listener for MctpSerialListener<S> {
                     inner: &mut self.inner,
                     typ,
                 };
-                return Ok((b, resp, typ, ic));
+                return Ok((typ, ic, b, resp));
             } else {
                 trace!("Discarding unmatched message {msg:?}");
                 self.inner.mctp.finished_receive(handle);