cosmos-ccsds_transfer_frames 0.1.1

data/README.md

@@ -0,0 +1,81 @@
+# Cosmos::CcsdsTransferFrames
+
+This gem contains a CCSDS transfer frame protocol for use with the Ball Aerospace COSMOS application.
+
+The protocol extracts CCSDS space packets from CCSDS transfer frames, optionally prefixing each packet with the transfer frame headers of the frame where it started.
+
+## Installation
+
+This gem is intended to be installed as a 'gem based target/tool' (see http://cosmosrb.com/docs/gemtargets/) in COSMOS and made available for use as a normal protocol in a target command and telemetry server configuration. Note that the protocol provided in this gem is neither a target nor a tool in the COSMOS sense.
+
+In order to make this protocol available for use in your COSMOS targets, add this line to the Gemfile of your COSMOS project:
+
+```ruby
+gem 'cosmos-ccsds_transfer_frames'
+```
+
+and then execute
+
+```sh
+$ bundle
+```
+
+## Usage
+
+In order to use this protocol in your COSMOS target first make sure to add the following to the `target.txt` file for your target:
+
+```
+REQUIRE cosmos/ccsds_transfer_frames
+```
+
+Then add the protocol in the command and telemetry server configuration in an interface definition as usual. The full explicit module namespace is necessary, for example:
+
+```
+INTERFACE INTERFACE_NAME tcpip_client_interface.rb localhost 12345 12345 10.0 nil
+  PROTOCOL Cosmos::CcsdsTransferFrames::CcsdsTranferFrameProtocol 1115 0 true true
+  TARGET TARGET_NAME
+```
+
+This would set up the protocol to expect transfer frames with:
+
+* A total size of 1115 bytes.
+* No secondary header.
+* Operational control field.
+* Frame error control field.
+* No prefixing of packets (default).
+* Discarding of idle packets (default).
+
+For detailed information about the available configuration parameters for the protocol, please consult the yard inline source code documentation in `lib/cosmos/ccsds_transfer_frames/ccsds_transfer_frame_protocol.rb`
+
+## Development
+
+[![Build Status](https://travis-ci.org/ienorand/cosmos-ccsds_transfer_frames.svg?branch=master)](https://travis-ci.org/ienorand/cosmos-ccsds_transfer_frames)
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in the gemspec file, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ienorand/cosmos-ccsds_transfer_frames. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+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 <https://www.gnu.org/licenses/>.
+
+A copy of the GPLv3.0 is provided in [LICENSE.txt](LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the Cosmos::CcsdsTransferFrames project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ienorand/cosmos-ccsds_transfer_frames/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cosmos-ccsds_transfer_frames.gemspec

@@ -0,0 +1,35 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cosmos/ccsds_transfer_frames/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cosmos-ccsds_transfer_frames"
+  spec.version       = Cosmos::CcsdsTransferFrames::VERSION
+  spec.authors       = ["Martin Erik Werner"]
+  spec.email         = ["martinerikwerner@gmail.com"]
+
+  spec.summary       = "CCSDS transfer frame protocol for use in COSMOS"
+  spec.description   = <<-EOF
+    A Ball Aerospace COSMOS 'tool' gem which provides a read-only protocol
+    for extracting CCSDS space packets from CCSDS transfer frames, optionally
+    prefixing each packet, with the transfer frame headers of the frame where
+    it started.
+  EOF
+  spec.homepage      = "https://github.com/ienorand/cosmos-ccsds_transfer_frames"
+  spec.license       = "GPL-3.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "cosmos", "~> 4"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "ruby-termios", "~> 0.9"
+end

data/lib/cosmos/ccsds_transfer_frames.rb

@@ -0,0 +1,2 @@
+require "cosmos/ccsds_transfer_frames/ccsds_transfer_frame_protocol"
+require "cosmos/ccsds_transfer_frames/version.rb"

data/lib/cosmos/ccsds_transfer_frames/ccsds_transfer_frame_protocol.rb

@@ -0,0 +1,316 @@
+# encoding: ascii-8bit
+
+# Copyright 2018 Fredrik Persson <u.fredrik.persson@gmail.com>
+#                Martin Erik Werner <martinerikwerner@gmail.com>
+#
+# 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/>.
+
+require 'cosmos/config/config_parser'
+require 'cosmos/packets/binary_accessor'
+require 'cosmos/interfaces/protocols/protocol'
+require 'thread'
+
+module Cosmos
+  module CcsdsTransferFrames
+    # Given a stream of ccsds transfer frames, extract ccsds space packets based
+    # on the first header pointer and packet lengths.
+    #
+    # Only read is supported.
+    class CcsdsTransferFrameProtocol < Protocol
+      FRAME_PRIMARY_HEADER_LENGTH = 6
+      FIRST_HEADER_POINTER_OFFSET = 4
+      # last 11 bits
+      FIRST_HEADER_POINTER_MASK = [0b00000111, 0b11111111]
+      IDLE_FRAME_FIRST_HEADER_POINTER = 0b11111111110
+      NO_PACKET_START_FIRST_HEADER_POINTER = 0b11111111111
+      FRAME_VIRTUAL_CHANNEL_BIT_OFFSET = 12
+      FRAME_VIRTUAL_CHANNEL_BITS = 3
+      VIRTUAL_CHANNEL_COUNT = 8
+      FRAME_OPERATIONAL_CONTROL_FIELD_LENGTH = 4
+      FRAME_ERROR_CONTROL_FIELD_LENGTH = 2
+      SPACE_PACKET_HEADER_LENGTH = 6
+      SPACE_PACKET_LENGTH_BIT_OFFSET = 4 * 8
+      SPACE_PACKET_LENGTH_BITS = 2 * 8
+      SPACE_PACKET_APID_BITS = 14
+      SPACE_PACKET_APID_BIT_OFFSET = 2 * 8 - SPACE_PACKET_APID_BITS
+      IDLE_PACKET_APID = 0b11111111111111
+
+      # @param transfer_frame_length [Integer] Length of transfer frame in bytes
+      # @param transfer_frame_secondary_header_length [Integer] Length of
+      #        transfer frame secondary header in bytes
+      # @param transfer_frame_has_operational_control_field [Boolean] Flag
+      #        indicating if the transfer frame operational control field is
+      #        present or not
+      # @param transfer_frame_has_frame_error_control_field [Boolean] Flag
+      #        indicating if the transfer frame error control field is present or
+      #        not
+      # @param prefix_packets [Boolean] Flag indicating if each space packet should
+      #        be prefixed with the transfer frame headers from the frame where
+      #        it started.
+      # @param include_idle_packets [Boolean] Flag indicating if idle packets
+      #        should be included or discarded.
+      # @param allow_empty_data [true/false/nil] See Protocol#initialize
+      def initialize(
+        transfer_frame_length,
+        transfer_frame_secondary_header_length,
+        transfer_frame_has_operational_control_field,
+        transfer_frame_has_frame_error_control_field,
+        prefix_packets = false,
+        include_idle_packets = false,
+        allow_empty_data = nil)
+        super(allow_empty_data)
+
+        @frame_length = Integer(transfer_frame_length)
+
+        @frame_headers_length = FRAME_PRIMARY_HEADER_LENGTH + Integer(transfer_frame_secondary_header_length)
+
+        @frame_trailer_length = 0
+        has_ocf = ConfigParser.handle_true_false(transfer_frame_has_operational_control_field)
+        @frame_trailer_length += FRAME_OPERATIONAL_CONTROL_FIELD_LENGTH if has_ocf
+        has_fecf = ConfigParser.handle_true_false(transfer_frame_has_frame_error_control_field)
+        @frame_trailer_length += FRAME_ERROR_CONTROL_FIELD_LENGTH if has_fecf
+
+        @frame_data_field_length = @frame_length - @frame_headers_length - @frame_trailer_length
+
+        @packet_prefix_length = 0
+        @prefix_packets = ConfigParser.handle_true_false(prefix_packets)
+        @packet_prefix_length += @frame_headers_length if @prefix_packets
+
+        @include_idle_packets = ConfigParser.handle_true_false(include_idle_packets)
+      end
+
+      def reset
+        super()
+        @data = ''
+        @virtual_channels = Array.new(VIRTUAL_CHANNEL_COUNT) { VirtualChannel.new }
+      end
+
+      def read_data(data)
+        @data << data
+
+        if (@data.length >= @frame_length)
+          frame = @data.slice!(0, @frame_length)
+          process_frame(frame)
+        end
+
+        packet_data = get_packet()
+
+        # Potentially allow blank string to be sent to other protocols if no
+        # packet is ready in this one
+        if (Symbol === packet_data && packet_data == :STOP && data.length <= 0)
+          return super(data)
+        end
+
+        return packet_data
+      end
+
+      private
+
+      VirtualChannel = Struct.new(:packet_queue, :pending_incomplete_packet_bytes_left) do
+        def initialize(packet_queue: [], pending_incomplete_packet_bytes_left: 0)
+          super(packet_queue, pending_incomplete_packet_bytes_left)
+        end
+      end
+
+      # Get a packet from the virtual channel packet queues of stored packets
+      # from processed frames.
+      #
+      # If idle packets are not included, extracted idle packets are discarded
+      # and extraction is retried until a non-idle packet is found or no more
+      # complete packets are left in any of the virtual channel packet queues.
+      #
+      # @return [String] Packet data, if the queues contained at least one
+      #   complete packet.
+      # @return [Symbol] :STOP, if the queues does not contain any complete
+      #   packets.
+      def get_packet
+        @virtual_channels.each do |vc|
+          loop do
+            # Skip if there's only a single incomplete packet in the queue.
+            break if (vc.packet_queue.length == 1 &&
+                      vc.pending_incomplete_packet_bytes_left > 0)
+
+            packet_data = vc.packet_queue.shift
+
+            break if packet_data.nil?
+
+            return packet_data if @include_idle_packets
+
+            apid = get_space_packet_apid(packet_data[@packet_prefix_length, SPACE_PACKET_HEADER_LENGTH])
+            return packet_data unless (apid == IDLE_PACKET_APID)
+          end
+        end
+        # If the packet queues contains any more whole packets they will be
+        # handled in subsequent calls to this method. Cosmos will ensure that
+        # read_data() is called until it returns :STOP, which allows us to
+        # clear all whole packets.
+
+        # no complete packet for any virtual channel
+        return :STOP
+      end
+
+      # Extract packets from a transfer frame and store them in the packet queue.
+      #
+      # First handles packet continuation of any incomplete packet and then
+      # handles the rest of the packets in the frame.
+      #
+      # @param frame [String] Transfer frame data.
+      def process_frame(frame)
+        first_header_pointer =
+          ((frame.bytes[FIRST_HEADER_POINTER_OFFSET] & FIRST_HEADER_POINTER_MASK[0]) << 8) |
+          (frame.bytes[FIRST_HEADER_POINTER_OFFSET + 1] & FIRST_HEADER_POINTER_MASK[1])
+
+        return if (first_header_pointer == IDLE_FRAME_FIRST_HEADER_POINTER)
+
+        virtual_channel = BinaryAccessor.read(
+          FRAME_VIRTUAL_CHANNEL_BIT_OFFSET,
+          FRAME_VIRTUAL_CHANNEL_BITS,
+          :UINT,
+          frame,
+          :BIG_ENDIAN)
+
+        frame_data_field = frame[@frame_headers_length, @frame_data_field_length]
+
+        status = handle_packet_continuation(virtual_channel, frame_data_field, first_header_pointer)
+        return if (Symbol === status && status == :STOP)
+
+        if (frame_data_field.length == @frame_data_field_length)
+          # No continuation packet was completed, and a packet starts in this
+          # frame. Utilise the first header pointer to re-sync to a packet start.
+          frame_data_field.replace(frame_data_field[first_header_pointer..-1])
+        end
+
+        frame_headers = frame[0, @frame_headers_length].clone
+        store_packets(virtual_channel, frame_headers, frame_data_field)
+      end
+
+      # Handle packet continuation when processing a transfer frame.
+      #
+      # Ensures that any incomplete packet first has enough data for the packet
+      # header to determine its length and then ensures that it has enough data
+      # to be complete based on its length.
+      #
+      # @param virtual_channel [Int] Transfer frame virtual channel.
+      # @param frame_data_field [String] Transfer frame data field.
+      # @param first_header_pointer [Int] First header pointer value.
+      def handle_packet_continuation(virtual_channel, frame_data_field, first_header_pointer)
+        vc = @virtual_channels[virtual_channel]
+        if (vc.packet_queue.length > 0 &&
+            vc.packet_queue[-1].length < @packet_prefix_length + SPACE_PACKET_HEADER_LENGTH)
+          # pending incomplete packet does not have header yet
+          rest_of_packet_header_length = @packet_prefix_length + SPACE_PACKET_HEADER_LENGTH - vc.packet_queue[-1].length
+          vc.packet_queue[-1] << frame_data_field.slice!(0, rest_of_packet_header_length)
+
+          space_packet_length = get_space_packet_length(vc.packet_queue[-1][@packet_prefix_length..-1])
+          throw "failed to get space packet length" if Symbol === space_packet_length && space_packet_length == :STOP
+
+          vc.pending_incomplete_packet_bytes_left = space_packet_length - SPACE_PACKET_HEADER_LENGTH
+        end
+
+        if (vc.pending_incomplete_packet_bytes_left >= frame_data_field.length)
+          # continuation of a packet
+          vc.packet_queue[-1] << frame_data_field
+          vc.pending_incomplete_packet_bytes_left -= frame_data_field.length
+          return :STOP
+        end
+
+        if (first_header_pointer == NO_PACKET_START_FIRST_HEADER_POINTER)
+          # This was not a continuation of a packet (or it was a continuation of
+          # an ignored idle packet), wait for another frame to find a packet
+          # start.
+          return :STOP
+        end
+
+        if (vc.pending_incomplete_packet_bytes_left > 0)
+          rest_of_packet = frame_data_field.slice!(0, vc.pending_incomplete_packet_bytes_left)
+          vc.packet_queue[-1] << rest_of_packet
+          vc.pending_incomplete_packet_bytes_left = 0
+        end
+      end
+
+      # Extract all packets from the remaining frame data field, and store them
+      # in the packet queue.
+      #
+      # It is assumed that packet continuation data from any previously
+      # unfinished packets has been removed from the frame data field prior, and
+      # hence that the given remaining frame data field starts at a space packet
+      # header.
+      #
+      # Handles both complete packets and unfinished packets which will be
+      # finished in a later frame via handle_packet_continuation().
+      #
+      # @param virtual_channel [Int] Transfer frame virtual channel.
+      # @param frame_headers [String] Transfer frame headers, only used if prefixing packets.
+      # @param frame_data_field [String] (Remaining) transfer frame data field.
+      def store_packets(virtual_channel, frame_headers, frame_data_field)
+        vc = @virtual_channels[virtual_channel]
+        while (frame_data_field.length > 0) do
+          if (@prefix_packets)
+            vc.packet_queue << frame_headers.clone
+          else
+            vc.packet_queue << ""
+          end
+
+          if (frame_data_field.length < SPACE_PACKET_HEADER_LENGTH)
+            vc.packet_queue[-1] << frame_data_field
+            vc.pending_incomplete_packet_bytes_left = SPACE_PACKET_HEADER_LENGTH - frame_data_field.length
+            return
+          end
+
+          space_packet_length = get_space_packet_length(frame_data_field)
+          throw "failed to get space packet length" if Symbol === space_packet_length && space_packet_length == :STOP
+
+          if (space_packet_length > frame_data_field.length)
+            vc.packet_queue[-1] << frame_data_field
+            vc.pending_incomplete_packet_bytes_left = space_packet_length - frame_data_field.length
+            return
+          end
+
+          vc.packet_queue[-1] << frame_data_field.slice!(0, space_packet_length)
+        end
+      end
+
+      def get_space_packet_length(space_packet)
+        # signal more data needed if we do not have enough to determine the
+        # length of the space packet
+        return :STOP if (space_packet.length < SPACE_PACKET_HEADER_LENGTH)
+
+        # actual length in ccsds space packet is stored value plus one
+        space_packet_data_field_length = BinaryAccessor.read(
+          SPACE_PACKET_LENGTH_BIT_OFFSET,
+          SPACE_PACKET_LENGTH_BITS,
+          :UINT,
+          space_packet,
+          :BIG_ENDIAN) + 1
+        space_packet_length = SPACE_PACKET_HEADER_LENGTH + space_packet_data_field_length
+        return space_packet_length
+      end
+
+      def get_space_packet_apid(space_packet)
+        # signal more data needed if we do not have enough of the header to
+        # determine the apid of the space packet
+        return :STOP if (space_packet.length < (SPACE_PACKET_APID_BIT_OFFSET + SPACE_PACKET_APID_BITS) / 8)
+
+        # actual length in ccsds space packet is stored value plus one
+        space_packet_apid = BinaryAccessor.read(
+          SPACE_PACKET_APID_BIT_OFFSET,
+          SPACE_PACKET_APID_BITS,
+          :UINT,
+          space_packet,
+          :BIG_ENDIAN)
+        return space_packet_apid
+      end
+    end
+  end
+end