/* * slip.c * ------ * SLIP send/recv code, based on RFC 1055 * * Copyright (c) 2016, NORDUnet A/S All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are * met: * - Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * - Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * - Neither the name of the NORDUnet nor the names of its contributors may * be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #include "slip_internal.h" /* SLIP special character codes */ #define END 0300 /* indicates end of packet */ #define ESC 0333 /* indicates byte stuffing */ #define ESC_END 0334 /* ESC ESC_END means END data byte */ #define ESC_ESC 0335 /* ESC ESC_ESC means ESC data byte */ #ifndef HAL_SLIP_DEBUG #define HAL_SLIP_DEBUG 0 #endif #if HAL_SLIP_DEBUG #include #define check(op) do { const hal_error_t _err_ = (op); if (_err_ != HAL_OK) { hal_log(HAL_LOG_DEBUG, "%s returned %d (%s)", #op, _err_, hal_error_string(_err_)); return _err_; } } while (0) #else #define check(op) do { const hal_error_t _err_ = (op); if (_err_ != HAL_OK) { return _err_; } } while (0) #endif /* Send a single character with SLIP escaping. */ hal_error_t hal_slip_send_char(const uint8_t c) { switch (c) { case END: check(hal_serial_send_char(ESC)); check(hal_serial_send_char(ESC_END)); break; case ESC: check(hal_serial_send_char(ESC)); check(hal_serial_send_char(ESC_ESC)); break; default: check(hal_serial_send_char(c)); } return HAL_OK; } /* Send a message with SLIP framing. */ hal_error_t hal_slip_send(const uint8_t * const buf, const size_t len) { /* send an initial END character to flush out any data that may * have accumulated in the receiver due to line noise */ check(hal_serial_send_char(END)); /* for each byte in the packet, send the appropriate character * sequence */ for (size_t i = 0; i < len; ++i) { hal_error_t ret; if ((ret = hal_slip_send_char(buf[i])) != HAL_OK) return ret; } /* tell the receiver that we're done sending the packet */ check(hal_serial_send_char(END)); return HAL_OK; } /* Receive a single character into a buffer, with SLIP un-escaping */ hal_error_t hal_slip_process_char(uint8_t c, uint8_t * const buf, size_t * const len, const size_t maxlen, int * const complete) { #define buf_push(c) do { if (*len < maxlen) buf[(*len)++] = c; } while (0) static int esc_flag = 0; *complete = 0; switch (c) { case END: if (*len) *complete = 1; break; case ESC: esc_flag = 1; break; default: if (esc_flag) { esc_flag = 0; switch (c) { case ESC_END: buf_push(END); break; case ESC_ESC: buf_push(ESC); break; default: buf_push(c); } } else { buf_push(c); } break; } return HAL_OK; } hal_error_t hal_slip_recv_char(uint8_t * const buf, size_t * const len, const size_t maxlen, int * const complete) { uint8_t c; check(hal_serial_recv_char(&c)); return hal_slip_process_char(c, buf, len, maxlen, complete); } /* Receive a message with SLIP framing, blocking mode. */ hal_error_t hal_slip_recv(uint8_t * const buf, size_t * const len, const size_t maxlen) { int complete; hal_error_t ret; while (1) { ret = hal_slip_recv_char(buf, len, maxlen, &complete); if ((ret != HAL_OK) || complete) return ret; } } >32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 




























































                                                                                                                                                 
{{{
#!htmlcomment

This page is maintained automatically by a script.  Don't modify this page by hand,
your changes will just be overwritten the next time the script runs.  Talk to your
Friendly Neighborhood Repository Maintainer if you need to change something here.

}}}

{{{
#!html
<h1>design documentation</h1>

<p>This repo contains a number of documents used during development of
various parts the Cryptech design. Note that the directory contains
source files (for example in OmniGraffle, Open Document file formats) as
well as final documents (normally in PFF file format).</p>

<ul>
<li><p>Alpha_board_drawing
A drawing/diagram that shows the functional components and their
functional connectivities for the Cryptech Alpha board being
developed. The drawing is not formal schematics for the Alpha board.</p></li>
<li><p>Novena-entropy-board
Sub directory with schematics as well as layout with silk screen for
the Cryptech Noise board designed to be used as external entropy
source on the Novena.</p></li>
<li><p>alpha_board_config
Configuration file for setting up the I/Os and functionality of the
STM32 microcontroller on the Alpha board. The config file is used by
the tool [STM32CubeMX][http://www.st.com/web/catalog/tools/FM147/CL1794/SC961/SS1743/PF259242?sc=microxplorer] from ST Microelectronics.</p></li>
<li><p>application-aware-signing
A drawing that shows a proposed mechanism with data and command flows
for doing application based (application aware) signing.</p></li>
<li><p>fpga_estimates
A document that tracks the FPGA resources and performance of the
different Cryptech cores in different FPGA technologies. The document
also includes estimates for cores not yet designed or completed. The
purpose of the document is to provide estimates of FPGA devices needed
to implement different use cases.</p></li>
<li><p>hsm-board
A high level functional diagram of the Cryptech HSM board that shows
the major functional blocks. Used during development of the Alpha
board to see what components are needed to realise the functionality
of the blocks. The Alpha_board_drawing is the concrete functional
realisation of this diagram.</p></li>
<li><p>hsm-keys
A document that includes diagrams that shows proposed mechanisms for
handling keys including managament, protection and migration of
wrapped keys.</p></li>
<li><p>novena-memory-map
This document contains information about the memory map of the
Cryptech FPGA design with the specific memory maps of each core as
well as how the cores are addressed and accessed from SW via different
interfaces.</p></li>
</ul>
}}}

[[RepositoryIndex(format=table,glob=doc/design)]]

|| Clone `https://git.cryptech.is/doc/design.git` ||
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-21 08:43:35 +0000