Skip to content

Commit

Permalink
Merge pull request #24 from geddy11/issue23
Browse files Browse the repository at this point in the history
Issue23
  • Loading branch information
geddy11 authored Oct 13, 2023
2 parents 5948438 + 08a16b4 commit 6771e94
Show file tree
Hide file tree
Showing 10 changed files with 659 additions and 7 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
docs
html
_NVC_LIB
*~
script/*
!script/ghdl_run_all.sh
Expand Down
12 changes: 9 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,27 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.3.0] - 2023-10-13

### Added
- nw_codec: Hamming encoder/decoder, odd/even parity function
- nw_util: Pointer type to t_slv_arr

## [1.2.1] - 2023-06-26

### Fixed
- ARP documentation
- nw_ethernet: ARP documentation
- Deployment to gh-pages

## [1.2.0] - 2023-05-31

### Added
- USB library
- nw_usb: USB library

## [1.1.0] - 2023-02-25

### Added
- Bit-stuffing codec
- nw_codec: Bit-stuffing codec

## [1.0.0] - 2023-02-20

Expand Down
5 changes: 3 additions & 2 deletions readme.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
![GitHub top language](https://img.shields.io/github/languages/top/geddy11/netwiz?style=plastic)

## Intro
NetWiz is a stand-alone VHDL library for network protocol packet generation and manipulation. NetWiz offers a stateless and functional **[API](https://geddy11.github.io/netwiz/functions_func.html)**.
NetWiz is a stand-alone VHDL library for network protocol packet generation and manipulation. NetWiz offers a stateless and functional [**API**](https://geddy11.github.io/netwiz/functions_func.html).

NetWiz requires VHDL 2008 and is designed for test bench use only, synthesis is not supported. NetWiz is licensed under the MIT license.

Expand All @@ -18,6 +18,7 @@ Netwiz consists of several libraries. Libraries not related to a specific networ
* [nw_cobs](@ref nw_cobs): Consistent Overhead Byte Stuffing
* [nw_bitstuff](@ref nw_bstuff): Bit stuffing
* [nw_base](@ref nw_base): Base64/32/16 codec
* [nw_hamming](@ref nw_hamming): Hamming encoding/decoding
* nw_pcap:
* [nw_pcap](@ref nw_pcap): Read network packets from PCAP/PCAPNG files (produced by Wireshark, tcmpdump et.al.)
* nw_util:
Expand Down Expand Up @@ -48,5 +49,5 @@ Netwiz consists of several libraries. Libraries not related to a specific networ
Additional protocol libraries are expected to be added in the future.

## Documentation
The NetWiz API is **[documented here](https://geddy11.github.io/netwiz/)**.
The NetWiz API is [**documented here**](https://geddy11.github.io/netwiz/).

1 change: 1 addition & 0 deletions nw_codec/src/nw_codec_context.vhd
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,5 @@ context nw_codec_context is
use nw_codec.nw_cobs_pkg.all;
use nw_codec.nw_base_pkg.all;
use nw_codec.nw_bitstuff_pkg.all;
use nw_codec.nw_hamming_pkg.all;
end context nw_codec_context;
Loading

0 comments on commit 6771e94

Please # to comment.