/* * Copyright (C) 2014 Pavel Kirienko */ #include #include #include namespace uavcan { /** * Frame */ int Frame::getMaxPayloadLen() const { switch (getTransferType()) { case TransferTypeMessageBroadcast: { return int(sizeof(payload_)); } case TransferTypeServiceResponse: case TransferTypeServiceRequest: case TransferTypeMessageUnicast: { return int(sizeof(payload_)) - 1; } default: { UAVCAN_ASSERT(0); return -ErrLogic; } } } int Frame::setPayload(const uint8_t* data, unsigned len) { const int maxlen = getMaxPayloadLen(); if (maxlen < 0) { return maxlen; } len = min(unsigned(maxlen), len); (void)copy(data, data + len, payload_); payload_len_ = uint_fast8_t(len); return int(len); } template inline static uint32_t bitunpack(uint32_t val) { return (val >> OFFSET) & ((1UL << WIDTH) - 1); } bool Frame::parse(const CanFrame& can_frame) { if (can_frame.isErrorFrame() || can_frame.isRemoteTransmissionRequest() || !can_frame.isExtended()) { return false; } if (can_frame.dlc > sizeof(can_frame.data)) { UAVCAN_ASSERT(0); // This is not a protocol error, so UAVCAN_ASSERT() is ok return false; } /* * CAN ID parsing */ const uint32_t id = can_frame.id & CanFrame::MaskExtID; transfer_id_ = uint8_t(bitunpack<0, 3>(id)); last_frame_ = bitunpack<3, 1>(id) != 0; frame_index_ = uint8_t(bitunpack<4, 6>(id)); src_node_id_ = uint8_t(bitunpack<10, 7>(id)); transfer_type_ = TransferType(bitunpack<17, 2>(id)); data_type_id_ = uint16_t(bitunpack<19, 10>(id)); /* * CAN payload parsing */ switch (transfer_type_) { case TransferTypeMessageBroadcast: { dst_node_id_ = NodeID::Broadcast; payload_len_ = can_frame.dlc; (void)copy(can_frame.data, can_frame.data + can_frame.dlc, payload_); break; } case TransferTypeServiceResponse: case TransferTypeServiceRequest: case TransferTypeMessageUnicast: { if (can_frame.dlc < 1) { return false; } if (can_frame.data[0] & 0x80) // RESERVED, must be zero { return false; } dst_node_id_ = can_frame.data[0] & 0x7F; payload_len_ = uint8_t(can_frame.dlc - 1); (void)copy(can_frame.data + 1, can_frame.data + can_frame.dlc, payload_); break; } default: { return false; } } return isValid(); } template inline static uint32_t bitpack(uint32_t field) { return uint32_t((field & ((1UL << WIDTH) - 1)) << OFFSET); } bool Frame::compile(CanFrame& out_can_frame) const { if (!isValid()) { UAVCAN_ASSERT(0); // This is an application error, so we need to maximize it. return false; } out_can_frame.id = CanFrame::FlagEFF | bitpack<0, 3>(transfer_id_.get()) | bitpack<3, 1>(last_frame_) | bitpack<4, 6>(frame_index_) | bitpack<10, 7>(src_node_id_.get()) | bitpack<17, 2>(transfer_type_) | bitpack<19, 10>(data_type_id_.get()); switch (transfer_type_) { case TransferTypeMessageBroadcast: { out_can_frame.dlc = uint8_t(payload_len_); (void)copy(payload_, payload_ + payload_len_, out_can_frame.data); break; } case TransferTypeServiceResponse: case TransferTypeServiceRequest: case TransferTypeMessageUnicast: { UAVCAN_ASSERT((payload_len_ + 1U) <= sizeof(out_can_frame.data)); out_can_frame.data[0] = dst_node_id_.get(); out_can_frame.dlc = uint8_t(payload_len_ + 1); (void)copy(payload_, payload_ + payload_len_, out_can_frame.data + 1); break; } default: { UAVCAN_ASSERT(0); return false; } } return true; } bool Frame::isValid() const { // Refer to the specification for the detailed explanation of the checks const bool invalid = (frame_index_ > MaxIndex) || ((frame_index_ == MaxIndex) && !last_frame_) || (!src_node_id_.isValid()) || (!dst_node_id_.isValid()) || (src_node_id_.isUnicast() ? (src_node_id_ == dst_node_id_) : false) || (src_node_id_.isBroadcast() ? (!last_frame_ || (frame_index_ > 0) || (transfer_type_ != TransferTypeMessageBroadcast)) : false) || ((transfer_type_ == TransferTypeMessageBroadcast) != dst_node_id_.isBroadcast()) || (transfer_type_ >= NumTransferTypes) || (static_cast(payload_len_) > getMaxPayloadLen()) || (!data_type_id_.isValid()); return !invalid; } bool Frame::operator==(const Frame& rhs) const { return (transfer_type_ == rhs.transfer_type_) && (data_type_id_ == rhs.data_type_id_) && (src_node_id_ == rhs.src_node_id_) && (dst_node_id_ == rhs.dst_node_id_) && (frame_index_ == rhs.frame_index_) && (transfer_id_ == rhs.transfer_id_) && (last_frame_ == rhs.last_frame_) && (payload_len_ == rhs.payload_len_) && equal(payload_, payload_ + payload_len_, rhs.payload_); } #if UAVCAN_TOSTRING std::string Frame::toString() const { /* * Frame ID fields, according to UAVCAN specs: * - Data Type ID * - Transfer Type * - Source Node ID * - Frame Index * - Last Frame * - Transfer ID */ static const int BUFLEN = 100; char buf[BUFLEN]; int ofs = snprintf(buf, BUFLEN, "dtid=%i tt=%i snid=%i dnid=%i idx=%i last=%i tid=%i payload=[", int(data_type_id_.get()), int(transfer_type_), int(src_node_id_.get()), int(dst_node_id_.get()), int(frame_index_), int(last_frame_), int(transfer_id_.get())); for (unsigned i = 0; i < payload_len_; i++) { ofs += snprintf(buf + ofs, unsigned(BUFLEN - ofs), "%02x", payload_[i]); if ((i + 1) < payload_len_) { ofs += snprintf(buf + ofs, unsigned(BUFLEN - ofs), " "); } } (void)snprintf(buf + ofs, unsigned(BUFLEN - ofs), "]"); return std::string(buf); } #endif /** * RxFrame */ bool RxFrame::parse(const CanRxFrame& can_frame) { if (!Frame::parse(can_frame)) { return false; } if (can_frame.ts_mono.isZero()) // Monotonic timestamps are mandatory. { UAVCAN_ASSERT(0); // If it is not set, it's a driver failure. return false; } ts_mono_ = can_frame.ts_mono; ts_utc_ = can_frame.ts_utc; iface_index_ = can_frame.iface_index; return true; } #if UAVCAN_TOSTRING std::string RxFrame::toString() const { std::string out = Frame::toString(); out.reserve(128); out += " ts_m=" + ts_mono_.toString(); out += " ts_utc=" + ts_utc_.toString(); out += " iface="; out += char('0' + iface_index_); return out; } #endif }