aboutsummaryrefslogblamecommitdiff
path: root/scripts/format-attribute-comments
blob: 5911f0e06e56c8c112d8209cb0deea42b6bd9824 (plain) (tree) 
0c8d1d7










715c5fb



















0c8d1d7

715c5fb




0c8d1d7



















































1
2
3
4
5
6
7
8
9
10

11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

30

31
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85










                                                                     


















                                                                      
                                                                  



                                                                  


















































                                                                  
#!/bin/sh -
#
# Script to extract tables from the PKCS #11 specification and format
# them as YAML comment blocks.
#
# This isn't even half-assed, more like quarter-assed.  If I thought
# we'd be using it a lot I'd rewrite it in Python.
#
# Author: Rob Austein
# Copyright (c) 2015, SUNET
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#
# 2. 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.
#
# 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 OWNER 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.

url=http://www.cryptsoft.com/pkcs11doc/download/pkcs11doc-v230.tgz

tar=${url##*/}

test -r $tar ||
wget $url ||
exit

tar -tf $tar |

awk '
  /group__SEC__(9|11)__.*\.html/ {

    n = split($0, a, "[/.]");
    title = a[n-1];

    n = split($0, a, /__/);
    s1 = a[3];
    s2 = (a[4] ~ /^[0-9]+$/) ? a[4] : 0;
    s3 = (a[5] ~ /^[0-9]+$/) ? a[5] : 0;
    idx = sprintf("%04d%04d%04d", s1, s2, s3);

    print idx, $0, title;
  }
' |

sort -n |

while read idx fn title
do

  tar -xOf $tar $fn |

  w3m -dump -O us-ascii -T text/html |

  awk -v title=$title '
    BEGIN {
      print "";
      print "###";
      print "#", title;
      print "###";
      print "";
    }
    /^[|+]/ {
      print "#", $0;
    }
  '

done
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-20 02:40:07 +0000
6-06-02 14:56:56 +0200 Use DMA for UART RX instead of interrupts.' href='/sw/stm32/commit/projects/cli-test/mgmt-cli.c?h=fmc_clk&id=ae1ecf87f6b8d7c34b32af0547f118ff7697c2ef'>ae1ecf8 
e3fe7d8

257ac2f

e3fe7d8


257ac2f



556dccb

257ac2f

e3fe7d8

257ac2f

556dccb





d5f67d0

556dccb

d5f67d0

556dccb






e3fe7d8



556dccb

e3fe7d8






556dccb


e3fe7d8





556dccb







1
2
3
4
5

6

7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
62
63
64
65

66

67
68
69
70

71

72
73
74
75
76
77
78
79
80
81
82

83

84
85
86
87
88
89

90

91

92

93
94

95

96
97
98
99
100

101
102
103

104
105
106
107
108
109

110

111

112

113
114

115

116

117
118

119

120
121

122

123
124

125

126
127
128

129
130

131
132
133
134

135

136
137
138
139
140
141

142

143

144
145

146
147
148

149

150

151

152

153
154
155
156
157

158

159

160

161
162
163
164
165
166

167
168
169

170

171
172
173
174
175
176

177
178

179
180
181
182
183

184
185
186
187
188
189
190





                       
                                                             


























                                                                           




                                                                
                     
                     
                    
 
                     





















                                       
 



                                       
 










                                                       
 





                                                        
 
                              
 

                                          
 




                                                        


                                                                                         





                                           
                                                                                                   
 
                                     

                                                                             
     
                          

 
                                                                                                          

                                                           
                          

 
                                                        


                                                    

                                                           



                                                 
                                                                    





                                            
                                          
 

                        


                                            
                                                   
                                      
               
 




                                                                 
                                    
                         
                                    





                         


                                           
 





                                 

               




                                                                    






                             
/*
 * mgmt-cli.c
 * ---------
 * Management CLI code.
 *
 * Copyright (c) 2016-2017, 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 <string.h>

/* Rename both CMSIS HAL_OK and libhal HAL_OK to disambiguate */
#define HAL_OK CMSIS_HAL_OK
#include "stm-init.h"
#include "stm-uart.h"
#include "stm-led.h"

#include "mgmt-cli.h"
#include "mgmt-fpga.h"
#include "mgmt-misc.h"
#include "mgmt-show.h"
#include "mgmt-test.h"
#include "mgmt-keystore.h"
#include "mgmt-masterkey.h"

#undef HAL_OK
#define HAL_OK LIBHAL_OK
#include "hal.h"
#undef HAL_OK

#ifndef CLI_UART_RECVBUF_SIZE
#define CLI_UART_RECVBUF_SIZE  256
#endif

typedef struct {
    int ridx;
    volatile int widx;
    mgmt_cli_dma_state_t rx_state;
    uint8_t buf[CLI_UART_RECVBUF_SIZE];
} ringbuf_t;

inline void ringbuf_init(ringbuf_t *rb)
{
    memset(rb, 0, sizeof(*rb));
}

/* return number of characters read */
inline int ringbuf_read_char(ringbuf_t *rb, uint8_t *c)
{
    if (rb->ridx != rb->widx) {
        *c = rb->buf[rb->ridx];
        if (++rb->ridx >= sizeof(rb->buf))
            rb->ridx = 0;
        return 1;
    }
    return 0;
}

inline void ringbuf_write_char(ringbuf_t *rb, uint8_t c)
{
    rb->buf[rb->widx] = c;
    if (++rb->widx >= sizeof(rb->buf))
        rb->widx = 0;
}

static ringbuf_t uart_ringbuf;

/* current character received from UART */
static uint8_t uart_rx;

/* Callback for HAL_UART_Receive_DMA().
 */
void HAL_UART1_RxCpltCallback(UART_HandleTypeDef *huart)
{
    ringbuf_write_char(&uart_ringbuf, uart_rx);
}

static void uart_cli_print(struct cli_def *cli __attribute__ ((unused)), const char *buf)
{
    char crlf[] = "\r\n";
    uart_send_string2(STM_UART_MGMT, buf);
    uart_send_string2(STM_UART_MGMT, crlf);
}

static ssize_t uart_cli_read(struct cli_def *cli __attribute__ ((unused)), void *buf, size_t count)
{
    for (int i = 0; i < count; ++i) {
        while (ringbuf_read_char(&uart_ringbuf, (uint8_t *)(buf + i)) == 0) {
	}
    }
    return (ssize_t)count;
}

static ssize_t uart_cli_write(struct cli_def *cli __attribute__ ((unused)), const void *buf, size_t count)
{
    uart_send_bytes(STM_UART_MGMT, (uint8_t *) buf, count);
    return (ssize_t)count;
}

int control_mgmt_uart_dma_rx(mgmt_cli_dma_state_t state)
{
    if (state == DMA_RX_START) {
	if (uart_ringbuf.rx_state != DMA_RX_START) {
            ringbuf_init(&uart_ringbuf);
	    HAL_UART_Receive_DMA(&huart_mgmt, &uart_rx, 1);
	    uart_ringbuf.rx_state = DMA_RX_START;
	}
	return 1;
    } else if (state == DMA_RX_STOP) {
	if (HAL_UART_DMAStop(&huart_mgmt) != CMSIS_HAL_OK) return 0;
	uart_ringbuf.rx_state = DMA_RX_STOP;
	return 1;
    }
    return 0;
}

static struct cli_def *mgmt_cli_init(void)
{
    struct cli_def *cli;
    cli = cli_init();
    cli_read_callback(cli, uart_cli_read);
    cli_write_callback(cli, uart_cli_write);
    cli_print_callback(cli, uart_cli_print);
    cli_set_banner(cli, "Cryptech Alpha test CLI");
    cli_set_hostname(cli, "cryptech");
    return cli;
}

hal_user_t user;

static int check_auth(const char *username, const char *password)
{
    if (strcmp(username, "ct") != 0)
	return CLI_ERROR;
    if (strcmp(password, "ct") != 0)
	return CLI_ERROR;
    return CLI_OK;
}

int cli_main(void)
{
    struct cli_def *cli;
    cli = mgmt_cli_init();
    cli_set_auth_callback(cli, check_auth);

    configure_cli_show(cli);
    configure_cli_fpga(cli);
    configure_cli_misc(cli);
    configure_cli_test(cli);
    configure_cli_keystore(cli);
    configure_cli_masterkey(cli);

    while (1) {
        control_mgmt_uart_dma_rx(DMA_RX_START);

        cli_loop(cli, 0);
        /* cli_loop returns when the user enters 'quit' or 'exit' */
        cli_print(cli, "\nLogging out...\n");
        user = HAL_USER_NONE;
    }

    /*NOTREACHED*/
    return -1;
}
generated by cgit v1.2.3 (git 2.25.1) at 2024-09-20 02:40:07 +0000