sat-rs/satrs-example/src/pus.rs

391 lines
15 KiB
Rust
Raw Normal View History

2022-12-20 17:41:07 +01:00
use crate::hk::{CollectionIntervalFactor, HkRequest};
2022-12-21 10:23:32 +01:00
use crate::requests::{Request, RequestWithToken};
use crate::tmtc::{PusTcSource, TmStore};
2022-11-20 19:54:14 +01:00
use satrs_core::events::EventU32;
2023-01-26 10:58:44 +01:00
use satrs_core::pool::{StoreAddr, StoreError};
2022-11-20 19:54:14 +01:00
use satrs_core::pus::event::Subservices;
use satrs_core::pus::event_man::{EventRequest, EventRequestWithToken};
2022-12-20 15:33:00 +01:00
use satrs_core::pus::hk;
use satrs_core::pus::scheduling::{PusScheduler, ScheduleSubservice};
2022-11-20 19:54:14 +01:00
use satrs_core::pus::verification::{
FailParams, StdVerifReporterWithSender, TcStateAccepted, VerificationToken,
2022-09-11 14:51:25 +02:00
};
2022-11-27 22:05:42 +01:00
use satrs_core::res_code::ResultU16;
use satrs_core::spacepackets::time::{CcsdsTimeProvider, UnixTimestamp};
2022-11-20 19:54:14 +01:00
use satrs_core::tmtc::tm_helper::PusTmWithCdsShortHelper;
2022-12-20 15:33:00 +01:00
use satrs_core::tmtc::{AddressableId, PusServiceProvider};
2023-01-10 17:16:57 +01:00
use satrs_core::{
2023-01-26 10:58:44 +01:00
spacepackets, spacepackets::ecss::PusPacket, spacepackets::tc::PusTc,
spacepackets::time::cds::TimeProvider, spacepackets::time::TimeWriter, spacepackets::SpHeader,
2023-01-10 17:16:57 +01:00
};
2022-12-20 15:45:09 +01:00
use satrs_example::{hk_err, tmtc_err};
2023-01-27 14:02:46 +01:00
use std::cell::RefCell;
2022-12-19 17:03:26 +01:00
use std::collections::HashMap;
2023-01-26 10:58:44 +01:00
use std::rc::Rc;
2022-12-19 17:03:26 +01:00
use std::sync::mpsc::Sender;
2023-01-26 10:58:44 +01:00
use std::sync::{Arc, LockResult, Mutex};
use std::time::Duration;
2022-08-29 01:33:32 +02:00
2022-09-03 13:47:25 +02:00
pub struct PusReceiver {
pub tm_helper: PusTmWithCdsShortHelper,
2022-12-19 17:03:26 +01:00
pub tm_tx: Sender<StoreAddr>,
2022-09-10 13:34:04 +02:00
pub tm_store: TmStore,
pub verif_reporter: StdVerifReporterWithSender,
#[allow(dead_code)]
tc_source: PusTcSource,
2022-12-19 17:03:26 +01:00
event_request_tx: Sender<EventRequestWithToken>,
2022-12-21 10:23:32 +01:00
request_map: HashMap<u32, Sender<RequestWithToken>>,
2022-12-08 15:26:49 +01:00
stamper: TimeProvider,
2022-09-10 20:18:19 +02:00
time_stamp: [u8; 7],
2023-01-27 14:02:46 +01:00
scheduler: Rc<RefCell<PusScheduler>>,
2022-09-03 13:47:25 +02:00
}
impl PusReceiver {
2022-09-10 13:34:04 +02:00
pub fn new(
apid: u16,
2022-12-19 17:03:26 +01:00
tm_tx: Sender<StoreAddr>,
2022-09-10 13:34:04 +02:00
tm_store: TmStore,
verif_reporter: StdVerifReporterWithSender,
tc_source: PusTcSource,
2022-12-19 17:03:26 +01:00
event_request_tx: Sender<EventRequestWithToken>,
2022-12-21 10:23:32 +01:00
request_map: HashMap<u32, Sender<RequestWithToken>>,
2023-01-27 14:02:46 +01:00
scheduler: Rc<RefCell<PusScheduler>>,
2022-09-10 13:34:04 +02:00
) -> Self {
2022-09-03 13:47:25 +02:00
Self {
tm_helper: PusTmWithCdsShortHelper::new(apid),
tm_tx,
tm_store,
2022-09-10 13:34:04 +02:00
verif_reporter,
tc_source,
2022-11-19 12:16:51 +01:00
event_request_tx,
2022-12-19 17:03:26 +01:00
request_map,
2022-12-21 10:15:41 +01:00
stamper: TimeProvider::new_with_u16_days(0, 0),
2022-09-10 20:18:19 +02:00
time_stamp: [0; 7],
2023-01-26 10:58:44 +01:00
scheduler,
2022-09-03 13:47:25 +02:00
}
}
}
impl PusServiceProvider for PusReceiver {
type Error = ();
fn handle_pus_tc_packet(
&mut self,
service: u8,
_header: &SpHeader,
pus_tc: &PusTc,
) -> Result<(), Self::Error> {
let init_token = self.verif_reporter.add_tc(pus_tc);
2022-11-27 14:30:29 +01:00
self.update_time_stamp();
let accepted_token = self
.verif_reporter
2023-01-21 12:19:05 +01:00
.acceptance_success(init_token, Some(&self.time_stamp))
2022-09-10 20:18:19 +02:00
.expect("Acceptance success failure");
2022-09-03 13:47:25 +02:00
if service == 17 {
2022-09-11 14:51:25 +02:00
self.handle_test_service(pus_tc, accepted_token);
2022-11-12 23:13:55 +01:00
} else if service == 5 {
2022-12-19 17:03:26 +01:00
self.handle_event_request(pus_tc, accepted_token);
} else if service == 3 {
self.handle_hk_request(pus_tc, accepted_token);
2023-01-25 10:15:21 +01:00
} else if service == 11 {
self.handle_scheduled_tc(pus_tc, accepted_token);
} else {
2022-11-27 19:24:18 +01:00
self.update_time_stamp();
2022-11-27 22:05:42 +01:00
self.verif_reporter
.start_failure(
accepted_token,
2023-01-21 12:19:05 +01:00
FailParams::new(Some(&self.time_stamp), &tmtc_err::INVALID_PUS_SERVICE, None),
2022-11-27 22:05:42 +01:00
)
2022-11-27 19:24:18 +01:00
.expect("Start failure verification failed")
2022-09-03 13:47:25 +02:00
}
Ok(())
}
}
impl PusReceiver {
2022-11-13 21:07:16 +01:00
fn handle_test_service(&mut self, pus_tc: &PusTc, token: VerificationToken<TcStateAccepted>) {
2022-12-20 15:33:00 +01:00
if PusPacket::subservice(pus_tc) == 1 {
2022-09-03 13:47:25 +02:00
println!("Received PUS ping command TC[17,1]");
println!("Sending ping reply PUS TM[17,2]");
let ping_reply = self.tm_helper.create_pus_tm_timestamp_now(17, 2, None);
2022-09-10 13:34:04 +02:00
let addr = self.tm_store.add_pus_tm(&ping_reply);
let start_token = self
2022-09-11 14:51:25 +02:00
.verif_reporter
2023-01-21 12:19:05 +01:00
.start_success(token, Some(&self.time_stamp))
2022-09-11 14:51:25 +02:00
.expect("Error sending start success");
2022-09-03 13:47:25 +02:00
self.tm_tx
.send(addr)
.expect("Sending TM to TM funnel failed");
self.verif_reporter
2023-01-21 12:19:05 +01:00
.completion_success(start_token, Some(&self.time_stamp))
2022-09-11 14:51:25 +02:00
.expect("Error sending completion success");
} else {
self.update_time_stamp();
self.verif_reporter
.start_failure(
token,
2023-01-21 12:19:05 +01:00
FailParams::new(
Some(&self.time_stamp),
&tmtc_err::INVALID_PUS_SUBSERVICE,
None,
),
)
.expect("Sending start failure TM failed");
2022-09-03 13:47:25 +02:00
}
}
2022-11-19 12:16:51 +01:00
fn update_time_stamp(&mut self) {
self.stamper
.update_from_now()
.expect("Updating timestamp failed");
self.stamper
.write_to_bytes(&mut self.time_stamp)
.expect("Writing timestamp failed");
}
2022-12-20 15:33:00 +01:00
fn handle_hk_request(&mut self, pus_tc: &PusTc, token: VerificationToken<TcStateAccepted>) {
if pus_tc.user_data().is_none() {
self.update_time_stamp();
self.verif_reporter
.start_failure(
token,
2023-01-21 12:19:05 +01:00
FailParams::new(Some(&self.time_stamp), &tmtc_err::NOT_ENOUGH_APP_DATA, None),
2022-12-20 15:33:00 +01:00
)
.expect("Sending start failure TM failed");
2022-12-20 15:45:09 +01:00
return;
2022-12-20 15:33:00 +01:00
}
let user_data = pus_tc.user_data().unwrap();
2022-12-20 15:45:09 +01:00
if user_data.len() < 8 {
let err = if user_data.len() < 4 {
&hk_err::TARGET_ID_MISSING
} else {
&hk_err::UNIQUE_ID_MISSING
};
self.update_time_stamp();
self.verif_reporter
2023-01-21 12:19:05 +01:00
.start_failure(token, FailParams::new(Some(&self.time_stamp), err, None))
2022-12-20 15:45:09 +01:00
.expect("Sending start failure TM failed");
return;
}
2022-12-20 17:23:11 +01:00
let addressable_id = AddressableId::from_raw_be(user_data).unwrap();
2022-12-20 15:45:09 +01:00
if !self.request_map.contains_key(&addressable_id.target_id) {
self.update_time_stamp();
self.verif_reporter
.start_failure(
token,
2023-01-21 12:19:05 +01:00
FailParams::new(Some(&self.time_stamp), &hk_err::UNKNOWN_TARGET_ID, None),
2022-12-20 15:45:09 +01:00
)
.expect("Sending start failure TM failed");
return;
}
2022-12-20 17:23:11 +01:00
let send_request = |request: HkRequest| {
2022-12-20 15:45:09 +01:00
let sender = self.request_map.get(&addressable_id.target_id).unwrap();
sender
2022-12-21 10:23:32 +01:00
.send(RequestWithToken(Request::HkRequest(request), token))
2023-01-26 23:31:09 +01:00
.unwrap_or_else(|_| panic!("Sending HK request {request:?} failed"));
2022-12-20 17:23:11 +01:00
};
if PusPacket::subservice(pus_tc) == hk::Subservice::TcEnableGeneration as u8 {
2022-12-22 09:26:00 +01:00
send_request(HkRequest::Enable(addressable_id));
2022-12-20 15:45:09 +01:00
} else if PusPacket::subservice(pus_tc) == hk::Subservice::TcDisableGeneration as u8 {
2022-12-22 09:26:00 +01:00
send_request(HkRequest::Disable(addressable_id));
2022-12-20 15:45:09 +01:00
} else if PusPacket::subservice(pus_tc) == hk::Subservice::TcGenerateOneShotHk as u8 {
2022-12-22 09:26:00 +01:00
send_request(HkRequest::OneShot(addressable_id));
2022-12-20 15:45:09 +01:00
} else if PusPacket::subservice(pus_tc) == hk::Subservice::TcModifyCollectionInterval as u8
{
2022-12-20 17:41:07 +01:00
if user_data.len() < 12 {
self.update_time_stamp();
self.verif_reporter
.start_failure(
token,
FailParams::new(
2023-01-21 12:19:05 +01:00
Some(&self.time_stamp),
2022-12-20 17:41:07 +01:00
&hk_err::COLLECTION_INTERVAL_MISSING,
None,
),
)
.expect("Sending start failure TM failed");
return;
}
send_request(HkRequest::ModifyCollectionInterval(
2022-12-22 09:26:00 +01:00
addressable_id,
2022-12-20 17:41:07 +01:00
CollectionIntervalFactor::from_be_bytes(user_data[8..12].try_into().unwrap()),
));
2022-12-20 15:33:00 +01:00
}
}
2023-01-25 10:15:21 +01:00
2022-12-19 17:03:26 +01:00
fn handle_event_request(&mut self, pus_tc: &PusTc, token: VerificationToken<TcStateAccepted>) {
let send_start_failure = |verif_reporter: &mut StdVerifReporterWithSender,
2022-11-19 12:16:51 +01:00
timestamp: &[u8; 7],
2022-11-27 19:24:18 +01:00
failure_code: &ResultU16,
2022-11-19 12:16:51 +01:00
failure_data: Option<&[u8]>| {
verif_reporter
.start_failure(
token,
2023-01-21 12:19:05 +01:00
FailParams::new(Some(timestamp), failure_code, failure_data),
2022-11-19 12:16:51 +01:00
)
.expect("Sending start failure TM failed");
};
let send_start_acceptance = |verif_reporter: &mut StdVerifReporterWithSender,
2022-11-19 12:16:51 +01:00
timestamp: &[u8; 7]| {
verif_reporter
2023-01-21 12:19:05 +01:00
.start_success(token, Some(timestamp))
2022-11-19 12:16:51 +01:00
.expect("Sending start success TM failed")
};
if pus_tc.user_data().is_none() {
self.update_time_stamp();
send_start_failure(
&mut self.verif_reporter,
&self.time_stamp,
2022-12-20 15:45:09 +01:00
&tmtc_err::NOT_ENOUGH_APP_DATA,
2022-11-19 12:16:51 +01:00
None,
);
return;
}
let app_data = pus_tc.user_data().unwrap();
if app_data.len() < 4 {
self.update_time_stamp();
send_start_failure(
&mut self.verif_reporter,
&self.time_stamp,
2022-12-20 15:45:09 +01:00
&tmtc_err::NOT_ENOUGH_APP_DATA,
2022-11-19 12:16:51 +01:00
None,
);
return;
}
let event_id = EventU32::from(u32::from_be_bytes(app_data.try_into().unwrap()));
match PusPacket::subservice(pus_tc).try_into() {
Ok(Subservices::TcEnableEventGeneration) => {
self.update_time_stamp();
let start_token = send_start_acceptance(&mut self.verif_reporter, &self.time_stamp);
self.event_request_tx
.send(EventRequestWithToken {
request: EventRequest::Enable(event_id),
token: start_token,
})
.expect("Sending event request failed");
}
Ok(Subservices::TcDisableEventGeneration) => {
self.update_time_stamp();
let start_token = send_start_acceptance(&mut self.verif_reporter, &self.time_stamp);
self.event_request_tx
.send(EventRequestWithToken {
request: EventRequest::Disable(event_id),
token: start_token,
})
.expect("Sending event request failed");
}
_ => {
self.update_time_stamp();
send_start_failure(
&mut self.verif_reporter,
&self.time_stamp,
2022-12-20 15:45:09 +01:00
&tmtc_err::INVALID_PUS_SUBSERVICE,
2022-11-19 12:16:51 +01:00
None,
);
}
}
}
2023-01-25 10:15:21 +01:00
fn handle_scheduled_tc(&mut self, pus_tc: &PusTc, token: VerificationToken<TcStateAccepted>) {
self.update_time_stamp();
match pus_tc.subservice() {
1 => {
let start_token = self
.verif_reporter
.start_success(token, Some(&self.time_stamp))
.expect("Error sending start success");
2023-01-26 10:58:44 +01:00
2023-01-27 14:02:46 +01:00
let mut scheduler = self.scheduler.borrow_mut();
2023-01-26 10:58:44 +01:00
scheduler.enable();
if scheduler.is_enabled() {
2023-01-25 10:15:21 +01:00
self.verif_reporter
.completion_success(start_token, Some(&self.time_stamp))
.expect("Error sending completion success");
} else {
2023-01-26 10:58:44 +01:00
panic!("Failed to enable scheduler");
2023-01-25 10:15:21 +01:00
}
2023-01-26 10:58:44 +01:00
}
2023-01-25 10:15:21 +01:00
2 => {
let start_token = self
2023-01-26 10:58:44 +01:00
.verif_reporter
.start_success(token, Some(&self.time_stamp))
.expect("Error sending start success");
2023-01-27 14:02:46 +01:00
let mut scheduler = self.scheduler.borrow_mut();
2023-01-26 10:58:44 +01:00
scheduler.disable();
if !scheduler.is_enabled() {
2023-01-25 10:15:21 +01:00
self.verif_reporter
.completion_success(start_token, Some(&self.time_stamp))
.expect("Error sending completion success");
} else {
2023-01-26 10:58:44 +01:00
panic!("Failed to disable scheduler");
2023-01-25 10:15:21 +01:00
}
2023-01-26 10:58:44 +01:00
}
2023-01-25 10:15:21 +01:00
3 => {
let start_token = self
.verif_reporter
.start_success(token, Some(&self.time_stamp))
.expect("Error sending start success");
2023-01-27 14:02:46 +01:00
let mut scheduler = self.scheduler.borrow_mut();
let mut pool = self
.tc_source
.tc_store
.pool
.write()
.expect("Locking pool failed");
scheduler
.reset(pool.as_mut())
.expect("Error resetting TC Pool");
self.verif_reporter
.completion_success(start_token, Some(&self.time_stamp))
.expect("Error sending completion success");
2023-01-26 10:58:44 +01:00
}
2023-01-25 10:15:21 +01:00
4 => {
2023-01-26 10:58:44 +01:00
let start_token = self
.verif_reporter
.start_success(token, Some(&self.time_stamp))
.expect("Error sending start success");
2023-01-27 14:02:46 +01:00
let mut scheduler = self.scheduler.borrow_mut();
let mut pool = self
.tc_source
.tc_store
.pool
.write()
.expect("Locking pool failed");
scheduler
.insert_wrapped_tc::<spacepackets::time::cds::TimeProvider>(
pus_tc,
pool.as_mut(),
)
.expect("TODO: panic message");
self.verif_reporter
.completion_success(start_token, Some(&self.time_stamp))
.expect("Error sending completion success");
2023-01-26 10:58:44 +01:00
//let addr = self.tc_source.tc_store.add_pus_tc().unwrap();
//let unix_time = UnixTimestamp::new_only_seconds(self.stamper.unix_seconds());
//let worked = self.scheduler.insert_tc(unix_time, );
}
2023-01-25 10:15:21 +01:00
_ => {
self.verif_reporter
2023-01-26 10:58:44 +01:00
.start_failure(
token,
FailParams::new(
Some(&self.time_stamp),
&tmtc_err::NOT_ENOUGH_APP_DATA,
None,
),
)
.expect("Sending start failure TM failed");
2023-01-25 10:15:21 +01:00
return;
}
}
}
2022-09-03 13:47:25 +02:00
}