dread-trace 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ad1776670d14c7eabfd49e22c023ce3d76f8bc7
+  data.tar.gz: 2c0293ad52bdb96810c7b146583cd0d38cc161ec
+SHA512:
+  metadata.gz: a5d057cd105edabff576fb7b2c4253e5d20bd9abd9b272202adebf53368a4b319145c7ae7218248ddddcd5360298df86d4256060a35144e1b59049a22398d97f
+  data.tar.gz: 576ee309c8d07cbf342057645e20c25abcd5aac9c079a1faab3d7cfafbdeaa2d5837e5bd1799d033e933dc69b4c152d9b135548312cba989e1d3e4c6e39d7c6f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at felipe.balbi@linux.intel.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dread.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Felipe Balbi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# Dread
+
+Dread is a decode for DWC3 Tracepoint Output.
+
+## Installation
+
+You can install the gem from rubygems.org with:
+
+```
+$ gem install dread
+```
+
+Alternatively, you can clone the repository:
+
+```
+$ git clone https://github.com/felipebalbi/dread.git
+$ cd dread
+```
+
+Build and install the gem:
+
+```
+$ rake install
+```
+
+## Usage
+
+You can either pipe strings to dread's STDIN:
+
+```
+$ dread < file
+```
+
+Or you can pass a file as argument:
+
+```
+$ dread file.txt
+```
+
+This is good if you wanna build pipelines.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. Then, run `rake spec` to run the tests. You can also run
+`bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake
+install`. To release a new version, update the version number in
+`version.rb`, 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/felipebalbi/dread. 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
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dread"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

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/dread.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dread/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dread-trace"
+  spec.version       = Dread::VERSION
+  spec.authors       = ["Felipe Balbi"]
+  spec.email         = ["felipe.balbi@linux.intel.com"]
+
+  spec.summary       = %q{Dwc3 Register and Event Advanced Decoder}
+  spec.description   = %q{Decodes DWC3 Trace output into human readable strings}
+  spec.homepage      = "https://github.com/felipebalbi/dread"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/exe/dread

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "dread"
+
+runner = Dread::Runner.new(ARGF)
+runner.run!

data/lib/dread/bitfield.rb

@@ -0,0 +1,9 @@
+require 'dread'
+
+module Dread
+  module Bitfield
+    def field(data, a, b = nil)
+      a.downto(b).map { |n| data[n] }.join.to_i(2)
+    end
+  end
+end

data/lib/dread/endpoint_event.rb

@@ -0,0 +1,136 @@
+# coding: utf-8
+require 'dread'
+
+module Dread
+  class EndpointEvent < Event
+    attr_reader    :epnum
+    attr_reader    :type
+    attr_reader    :status
+    attr_reader    :parameters
+
+    DEPEVT_XFERCOMPLETE = 0x01
+    DEPEVT_XFERINPROGRESS = 0x02
+    DEPEVT_XFERNOTREADY = 0x03
+    DEPEVT_RXTXFIFOEVT = 0x04
+    DEPEVT_STREAMEVT = 0x06
+    DEPEVT_EPCMDCMPLT = 0x07
+
+    STREAMEVT_FOUND = 1
+    STREAMEVT_NOTFOUND = 2
+
+    CONTROL_DATA = (1 << 0)
+    CONTROL_STATUS = (2 << 0)
+    
+    TRANSFER_ACTIVE = (1 << 3)
+
+    XFERCOMPLETE_LST = (1 << 3)
+    XFERCOMPLETE_IOC = (1 << 2)
+    XFERCOMPLETE_SHORT = (1 << 1)
+
+    def initialize(line)
+      super
+
+      @event_type = {
+        DEPEVT_XFERCOMPLETE => "Transfer Complete",
+        DEPEVT_XFERINPROGRESS => "Transfer In Progress",
+        DEPEVT_XFERNOTREADY => "Transfer Not Ready",
+        DEPEVT_RXTXFIFOEVT => "FIFO Event",
+        DEPEVT_STREAMEVT => "Stream",
+        DEPEVT_EPCMDCMPLT => "Command Complete",
+      }
+
+      decode
+    end
+
+    def decode
+      @event_data = super
+
+      @epnum = field(@event_data, 5, 1)
+      @type = field(@event_data, 9, 6)
+      @status = field(@event_data, 15, 12)
+      @parameters = field(@event_data, 31, 16)
+    end
+
+    def to_s
+      str = super
+
+      str += ": #{endpoint}: "
+      str += @event_type[@type]
+
+      case @type
+      when DEPEVT_XFERCOMPLETE
+        str += xfer_complete_status
+      when DEPEVT_XFERNOTREADY
+        str += xfer_not_ready_status
+      when DEPEVT_STREAMEVT
+        str += stream_extras
+      end
+
+      str
+    end
+
+    def endpoint
+      num = @epnum >> 1
+      dir = (@epnum & 1) == 1 ? "in" : "out"
+
+      "ep#{num}#{dir}"
+    end
+
+    private
+
+    def xfer_complete_status
+      str = " ["
+
+      if ((@status & XFERCOMPLETE_SHORT) == XFERCOMPLETE_SHORT)
+        str += "S"
+      else
+        str += "s"
+      end
+
+      if ((@status & XFERCOMPLETE_IOC) == XFERCOMPLETE_IOC)
+        str += "I"
+      else
+        str += 'i'
+      end
+
+      if ((@status & XFERCOMPLETE_LST) == XFERCOMPLETE_LST)
+        str += "L"
+      else
+        str += "l"
+      end
+
+      str += "] "
+      str
+    end
+
+    def xfer_not_ready_status
+      str = ""
+
+      if ((@status & TRANSFER_ACTIVE) == TRANSFER_ACTIVE)
+        str += " (Active)"
+      else
+        str += " (Not Active)"
+      end
+
+      if @epnum == 0 || @epnum == 1
+        case (@status & (3 << 0))
+        when CONTROL_DATA
+          str += " [ Data Phase ]"
+        when CONTROL_STATUS
+          str += " [ Status Phase ]"
+        end
+      end
+
+      str
+    end
+
+    def stream_extras
+      case @status
+      when STREAMEVT_FOUND
+        "#{@parameters} Found"
+      when STREAMEVT_NOTFOUND
+        "#{@parameters} Not Found"
+      end
+    end
+  end
+end

data/lib/dread/event.rb

@@ -0,0 +1,19 @@
+require "dread"
+
+module Dread
+  class Event < Trace
+    include Bitfield
+
+    def gadget?
+      (decode & 1) == 1
+    end
+
+    def endpoint?
+      (decode & 1) == 0
+    end
+
+    def decode
+      data.split.last.to_i(16)
+    end
+  end
+end

data/lib/dread/factories/event_factory.rb

@@ -0,0 +1,20 @@
+require 'dread'
+
+module Dread
+  module EventFactory
+    def self.build(line)
+      re = /event ([0-9a-f]{8})$/
+      md = line.match(re)
+      type = md[0].split.last.to_i(16)
+
+      case (type & 1)
+      when 1
+        GadgetEvent.new(line)
+      when 0
+        EndpointEvent.new(line)
+      else
+        e
+      end
+    end
+  end
+end

data/lib/dread/factories/trace_factory.rb

@@ -0,0 +1,14 @@
+require 'dread'
+
+module Dread
+  module TraceFactory
+    def self.build(line)
+      case line
+      when /dwc3_event:/
+        EventFactory.build(line)
+      else
+        Trace.new(line)
+      end
+    end
+  end
+end

data/lib/dread/gadget_event.rb

@@ -0,0 +1,91 @@
+require 'dread'
+
+module Dread
+  class GadgetEvent < Event
+    attr_reader    :link
+    attr_reader    :type
+
+    LINK_STATE_U0            = 0
+    LINK_STATE_U1            = 1
+    LINK_STATE_U2            = 2
+    LINK_STATE_U3            = 3
+    LINK_STATE_SS_DIS        = 4
+    LINK_STATE_RX_DET        = 5
+    LINK_STATE_SS_INACT      = 6
+    LINK_STATE_POLL          = 7
+    LINK_STATE_RECOV         = 8
+    LINK_STATE_HRESET        = 9
+    LINK_STATE_CMPLY         = 10
+    LINK_STATE_LPBK          = 11
+    LINK_STATE_RESET         = 14
+    LINK_STATE_RESUME        = 15
+
+    EVENT_DISCONNECT         = 0
+    EVENT_RESET              = 1
+    EVENT_CONNECT_DONE       = 2
+    EVENT_LINK_STATE_CHANGE  = 3
+    EVENT_WAKEUP             = 4
+    EVENT_HIBER_REQ          = 5
+    EVENT_EOPF               = 6
+    EVENT_SOF                = 7
+    EVENT_L1SUSP             = 8
+    EVENT_ERRATIC_ERROR      = 9
+    EVENT_CMD_CMPL           = 10
+    EVENT_OVERFLOW           = 11
+    EVENT_VNDRDEVTSTRCVED    = 12
+    EVENT_STOPPEDONDISCONNECT= 13
+    EVENT_L1RESUME           = 14
+
+    def initialize(line)
+      super
+
+      @event_type = {
+        EVENT_DISCONNECT => "Disconnect",
+        EVENT_RESET => "Reset",
+        EVENT_CONNECT_DONE => "Connect Done",
+        EVENT_LINK_STATE_CHANGE => "Link State Change",
+        EVENT_WAKEUP => "Wakeup",
+        EVENT_HIBER_REQ => "Hibernation Request",
+        EVENT_EOPF => "End Of Packet Frame",
+        EVENT_SOF => "Start Of Frame",
+        EVENT_L1SUSP => "L1 Suspend",
+        EVENT_ERRATIC_ERROR => "Erratic Error",
+        EVENT_CMD_CMPL => "Command Complete",
+        EVENT_OVERFLOW => "Overflow",
+        EVENT_VNDRDEVTSTRCVED => "Vendor Device Test LMP Received",
+        EVENT_STOPPEDONDISCONNECT => "Stopped On Disconnect",
+        EVENT_L1RESUME => "L1 Resume / Remote Wake",
+      }
+
+      @link_state = {
+        LINK_STATE_U0 => "U0",
+        LINK_STATE_U1 => "U1",
+        LINK_STATE_U2 => "U2",
+        LINK_STATE_U3 => "U3",
+        LINK_STATE_SS_DIS => "SS.Disconnect",
+        LINK_STATE_RX_DET => "Rx.Detect",
+        LINK_STATE_SS_INACT => "SS.Inactive",
+        LINK_STATE_POLL => "Polling",
+        LINK_STATE_RECOV => "Recovery",
+        LINK_STATE_HRESET => "Hot Reset",
+        LINK_STATE_CMPLY => "Compliance",
+        LINK_STATE_LPBK => "Loopback",
+        LINK_STATE_RESET => "Reset",
+        LINK_STATE_RESUME => "Resume",
+      }
+
+      decode
+    end
+
+    def decode
+      @event_data = super
+
+      @type = field(@event_data, 11, 8)
+      @link = field(@event_data, 19, 16)
+    end
+
+    def to_s
+      super + ": #{@event_type[@type]} [#{@link_state[@link]}]"
+    end
+  end
+end

data/lib/dread/runner.rb

@@ -0,0 +1,27 @@
+require 'dread'
+
+module Dread
+  class Runner
+    def initialize(argf)
+      @argf = argf
+    end
+
+    def run!
+      argf.each_line do |line|
+        next if comment?(line)
+
+        t = TraceFactory.build(line)
+        puts t
+        #t.format_output if t
+      end
+    end
+
+    private
+
+    def comment?(line)
+      line =~ /^#/
+    end
+
+    attr_reader :argf
+  end
+end

data/lib/dread/trace.rb

@@ -0,0 +1,49 @@
+require 'dread'
+
+module Dread
+  class Trace
+    attr_reader :cpu
+    attr_reader :data
+    attr_reader :function
+    attr_reader :pid
+    attr_reader :task
+    attr_reader :timestamp
+
+    def initialize(line)
+      @line = line
+      @task = ''
+      @pid = 0
+      @cpu = 0
+      @timestamp = 0
+      @function = ''
+      @data = ''
+
+      parse!
+    end
+
+    def to_s
+      "#{'%.9f' % timestamp}: #{task}-#{pid} [#{cpu}] #{function}: #{data}"
+    end
+
+    protected
+
+    def parse!
+      md = @line.match(re)
+
+      raise "Can't parse '#{@line}'" unless md
+
+      @cpu = md[:cpu].to_i
+      @data = md[:data]
+      @function = md[:function]
+      @pid = md[:pid].to_i
+      @task = md[:task]
+      @timestamp = md[:timestamp].to_f
+    end
+
+    def re
+      /(?<task>[a-z0-9\/-]+)-(?<pid>\d+)\s+\[(?<cpu>\d+)\]\s+....\s+(?<timestamp>[0-9.]+):\s+(?<function>\w+):\s+(?<data>.*)$/
+    end
+
+    attr_reader :line
+  end
+end

data/lib/dread/version.rb

@@ -0,0 +1,3 @@
+module Dread
+  VERSION = "0.1.1"
+end

data/lib/dread.rb

@@ -0,0 +1,13 @@
+require "dread/bitfield"
+require "dread/trace"
+require "dread/event"
+require "dread/endpoint_event"
+require "dread/gadget_event"
+require "dread/runner"
+require "dread/version"
+
+require "dread/factories/event_factory"
+require "dread/factories/trace_factory"
+
+module Dread
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: dread-trace
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Felipe Balbi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Decodes DWC3 Trace output into human readable strings
+email:
+- felipe.balbi@linux.intel.com
+executables:
+- dread
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dread.gemspec
+- exe/dread
+- lib/dread.rb
+- lib/dread/bitfield.rb
+- lib/dread/endpoint_event.rb
+- lib/dread/event.rb
+- lib/dread/factories/event_factory.rb
+- lib/dread/factories/trace_factory.rb
+- lib/dread/gadget_event.rb
+- lib/dread/runner.rb
+- lib/dread/trace.rb
+- lib/dread/version.rb
+homepage: https://github.com/felipebalbi/dread
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Dwc3 Register and Event Advanced Decoder
+test_files: []