├── src ├── SConscript └── agile_telnet.c ├── SConscript ├── .gitignore ├── inc └── agile_telnet.h ├── README.md └── LICENSE /src/SConscript: -------------------------------------------------------------------------------- 1 | from building import * 2 | 3 | cwd = GetCurrentDir() 4 | src = Glob('*.c') + Glob('*.cpp') 5 | CPPPATH = [cwd + '/../inc'] 6 | 7 | group = DefineGroup('agile_telnet', src, depend = ['PKG_USING_AGILE_TELNET'], CPPPATH = CPPPATH) 8 | 9 | Return('group') 10 | -------------------------------------------------------------------------------- /SConscript: -------------------------------------------------------------------------------- 1 | # RT-Thread building script for bridge 2 | 3 | import os 4 | from building import * 5 | 6 | cwd = GetCurrentDir() 7 | objs = [] 8 | list = os.listdir(cwd) 9 | 10 | if GetDepend('PKG_USING_AGILE_TELNET'): 11 | for d in list: 12 | path = os.path.join(cwd, d) 13 | if os.path.isfile(os.path.join(path, 'SConscript')): 14 | objs = objs + SConscript(os.path.join(d, 'SConscript')) 15 | 16 | Return('objs') 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Prerequisites 2 | *.d 3 | 4 | # Object files 5 | *.o 6 | *.ko 7 | *.obj 8 | *.elf 9 | 10 | # Linker output 11 | *.ilk 12 | *.map 13 | *.exp 14 | 15 | # Precompiled Headers 16 | *.gch 17 | *.pch 18 | 19 | # Libraries 20 | *.lib 21 | *.a 22 | *.la 23 | *.lo 24 | 25 | # Shared objects (inc. Windows DLLs) 26 | *.dll 27 | *.so 28 | *.so.* 29 | *.dylib 30 | 31 | # Executables 32 | *.exe 33 | *.out 34 | *.app 35 | *.i*86 36 | *.x86_64 37 | *.hex 38 | 39 | # Debug files 40 | *.dSYM/ 41 | *.su 42 | *.idb 43 | *.pdb 44 | .vscode 45 | 46 | # Kernel Module Compile Results 47 | *.mod* 48 | *.cmd 49 | .tmp_versions/ 50 | modules.order 51 | Module.symvers 52 | Mkfile.old 53 | dkms.conf 54 | -------------------------------------------------------------------------------- /inc/agile_telnet.h: -------------------------------------------------------------------------------- 1 | #ifndef __PKG_AGILE_TELNET_H 2 | #define __PKG_AGILE_TELNET_H 3 | 4 | #ifdef __cplusplus 5 | extern "C" { 6 | #endif 7 | 8 | #include 9 | #include 10 | #include 11 | 12 | #ifdef PKG_AGILE_TELNET_USING_AUTH 13 | enum agile_telnet_state { 14 | AGILE_TELNET_STATE_USER = 0, 15 | AGILE_TELNET_STATE_PASSWORD, 16 | AGILE_TELNET_STATE_PROCESS 17 | }; 18 | #endif 19 | 20 | struct agile_telnet { 21 | uint8_t isconnected; 22 | int server_fd; 23 | int client_fd; 24 | int client_timeout; 25 | rt_device_t tlnt_dev; 26 | int tx_fd; 27 | 28 | #ifdef PKG_AGILE_TELNET_USING_AUTH 29 | enum agile_telnet_state state; 30 | char username[50]; 31 | char password[50]; 32 | #endif 33 | 34 | struct rt_ringbuffer *rx_rb; 35 | struct rt_ringbuffer *tx_rb; 36 | }; 37 | 38 | #ifdef __cplusplus 39 | } 40 | #endif 41 | 42 | #endif 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Agile Telnet 2 | 3 | ## 1、介绍 4 | 5 | - 从2.0开始`agile_telnet`作为[agile_console](https://github.com/loogg/agile_console)的插件使用。 6 | 7 | - 如果只想使用telnet作为console设备，请访问[v1.0.0](https://github.com/loogg/agile_telnet/tree/v1.0.0)。 8 | 9 | ### 1.1 目录结构 10 | 11 | | 名称 | 说明 | 12 | | ---- | ---- | 13 | | inc | 头文件目录 | 14 | | src | 源代码目录 | 15 | 16 | ### 1.2 许可证 17 | 18 | `agile_telnet` package 遵循 LGPLv2.1 许可，详见 `LICENSE` 文件。 19 | 20 | ### 1.3 依赖 21 | 22 | - RT-Thread 3.0+ 23 | - SAL 24 | - POSIX 25 | - DFS 26 | - agile_console 27 | 28 | ## 2、如何打开 agile_telnet 29 | 30 | 使用 `agile_telnet` package 需要在 RT-Thread 的包管理器中选择它，具体路径如下： 31 | 32 | ``` 33 | RT-Thread online packages 34 | IoT - internet of things ---> 35 | [*] agile_telnet: TCP debug for Ethernet ---> 36 | (2048) Set agile_telnet thread stack size 37 | (26) Set agile_telnet thread priority 38 | (23) Set agile_telnet listen port 39 | (256) Set agile_telnet rx buffer size 40 | (2048) Set agile_telnet tx buffer size 41 | (3) Set agile_telnet client timeout(min) 42 | Version (latest) ---> 43 | ``` 44 | 45 | - **Set agile_telnet thread stack size**：`agile_telnet`线程堆栈大小 46 | - **Set agile_telnet thread priority**：`agile_telnet`线程优先级 47 | - **Set agile_telnet listen port**：`agile_telnet`监听端口号 48 | - **Set agile_telnet rx buffer size**：`agile_telnet`接收环形缓冲区大小 49 | - **Set agile_telnet tx buffer size**：`agile_telnet`发送环形缓冲区大小 50 | - **Set agile_telnet client timeout(min)**：`agile_telnet`客户端默认超时时间(3分钟) 51 | - **Version**：大于`v1.0.0`版本会强制选中`agile_console`软件包，并作为其插件使用 52 | 53 | 然后让 RT-Thread 的包管理器自动更新，或者使用 `pkgs --update` 命令更新包到 BSP 中。 54 | 55 | ## 3、使用 agile_telnet 56 | 57 | 在打开 `agile_telnet` package 后，当进行 bsp 编译时，它会被加入到 bsp 工程中进行编译。 58 | 59 | 该软件包作为[agile_console](https://github.com/loogg/agile_console)的插件使用。 60 | 61 | ## 4、注意事项 62 | 63 | - 使用以太网设备请使能以太网设备和`lwip`，这些`agile_telnet`不会强制打开，只强制选中到`SAL`层。 64 | 65 | ## 5、联系方式 & 感谢 66 | 67 | - 维护：malongwei 68 | - 主页： 69 | - 邮箱：<2544047213@qq.com> 70 | -------------------------------------------------------------------------------- /src/agile_telnet.c: -------------------------------------------------------------------------------- 1 | /************************************************* 2 | All rights reserved. 3 | File name: agile_telnet.c 4 | Description: agile_telnet源码 5 | *************************************************/ 6 | 7 | #include 8 | 9 | #ifdef PKG_USING_AGILE_TELNET 10 | 11 | #if (RT_VER_NUM < 0x40003) || (RT_VER_NUM == 0x40004) 12 | #error "Not support." 13 | #endif 14 | 15 | #ifndef PKG_USING_AGILE_CONSOLE 16 | #error "Please enable agile_console package" 17 | #endif 18 | 19 | #include 20 | #include 21 | 22 | #if RT_VER_NUM < 0x40100 23 | #include 24 | #include 25 | #else 26 | #include 27 | #include 28 | #include 29 | #endif 30 | #include 31 | #include 32 | #include 33 | 34 | /* 线程堆栈大小 */ 35 | #ifndef PKG_AGILE_TELNET_THREAD_STACK_SIZE 36 | #define PKG_AGILE_TELNET_THREAD_STACK_SIZE 2048 37 | #endif 38 | 39 | /* 线程优先级 */ 40 | #ifndef PKG_AGILE_TELNET_THREAD_PRIORITY 41 | #define PKG_AGILE_TELNET_THREAD_PRIORITY RT_THREAD_PRIORITY_MAX - 6 42 | #endif 43 | 44 | /* 监听端口 */ 45 | #ifndef PKG_AGILE_TELNET_PORT 46 | #define PKG_AGILE_TELNET_PORT 23 47 | #endif 48 | 49 | /* 接收缓冲区大小 */ 50 | #ifndef PKG_AGILE_TELNET_RX_BUFFER_SIZE 51 | #define PKG_AGILE_TELNET_RX_BUFFER_SIZE 256 52 | #endif 53 | 54 | /* 发送缓冲区大小 */ 55 | #ifndef PKG_AGILE_TELNET_TX_BUFFER_SIZE 56 | #define PKG_AGILE_TELNET_TX_BUFFER_SIZE 2048 57 | #endif 58 | 59 | /* 客户端空闲超时时间(单位：min) */ 60 | #ifndef PKG_AGILE_TELNET_CLIENT_DEFAULT_TIMEOUT 61 | #define PKG_AGILE_TELNET_CLIENT_DEFAULT_TIMEOUT 3 62 | #endif 63 | 64 | /* 登录验证 */ 65 | #ifdef PKG_AGILE_TELNET_USING_AUTH 66 | #ifndef PKG_AGILE_TELNET_USERNAME 67 | #define PKG_AGILE_TELNET_USERNAME "loogg" 68 | #endif 69 | #ifndef PKG_AGILE_TELNET_PASSWORD 70 | #define PKG_AGILE_TELNET_PASSWORD "loogg" 71 | #endif 72 | #endif 73 | 74 | static struct agile_telnet telnet = {0}; 75 | static struct agile_console_backend telnet_backend = {0}; 76 | 77 | #if RT_VER_NUM >= 0x50000 78 | rt_weak rt_size_t rt_ringbuffer_peak(struct rt_ringbuffer *rb, rt_uint8_t **ptr) 79 | #else 80 | RT_WEAK rt_size_t rt_ringbuffer_peak(struct rt_ringbuffer *rb, rt_uint8_t **ptr) 81 | #endif 82 | { 83 | RT_ASSERT(rb != RT_NULL); 84 | 85 | *ptr = RT_NULL; 86 | 87 | /* whether has enough data */ 88 | rt_size_t size = rt_ringbuffer_data_len(rb); 89 | 90 | /* no data */ 91 | if (size == 0) 92 | return 0; 93 | 94 | *ptr = &rb->buffer_ptr[rb->read_index]; 95 | 96 | if (rb->buffer_size - rb->read_index > size) { 97 | rb->read_index += size; 98 | return size; 99 | } 100 | 101 | size = rb->buffer_size - rb->read_index; 102 | 103 | /* we are going into the other side of the mirror */ 104 | rb->read_mirror = ~rb->read_mirror; 105 | rb->read_index = 0; 106 | 107 | return size; 108 | } 109 | 110 | #ifdef PKG_AGILE_TELNET_USING_AUTH 111 | static void telnet_client_process(rt_uint8_t *recv_buf, int recv_len) 112 | { 113 | static rt_uint16_t index = 0; 114 | 115 | switch (telnet.state) { 116 | case AGILE_TELNET_STATE_USER: { 117 | if (telnet.username[0] == '\0') 118 | index = 0; 119 | 120 | rt_uint8_t change = 0; 121 | for (int i = 0; i < recv_len; i++) { 122 | if (recv_buf[i] == '\r') { 123 | change = 1; 124 | break; 125 | } 126 | 127 | if (index == sizeof(telnet.username) - 1) 128 | break; 129 | telnet.username[index++] = recv_buf[i]; 130 | } 131 | 132 | if (change) { 133 | index = 0; 134 | telnet.state = AGILE_TELNET_STATE_PASSWORD; 135 | const char *format = "\r\npassword:"; 136 | send(telnet.client_fd, format, strlen(format), 0); 137 | } 138 | } break; 139 | 140 | case AGILE_TELNET_STATE_PASSWORD: { 141 | rt_uint8_t change = 0; 142 | for (int i = 0; i < recv_len; i++) { 143 | if (recv_buf[i] == '\r') { 144 | change = 1; 145 | break; 146 | } 147 | 148 | if (index == sizeof(telnet.password) - 1) 149 | break; 150 | telnet.password[index++] = recv_buf[i]; 151 | } 152 | 153 | if (change) { 154 | int result = -RT_ERROR; 155 | do { 156 | if (rt_strcmp(telnet.username, PKG_AGILE_TELNET_USERNAME)) 157 | break; 158 | if (rt_strcmp(telnet.password, PKG_AGILE_TELNET_PASSWORD)) 159 | break; 160 | 161 | result = RT_EOK; 162 | } while (0); 163 | 164 | if (result != RT_EOK) { 165 | telnet.state = AGILE_TELNET_STATE_USER; 166 | rt_memset(telnet.username, 0, sizeof(telnet.username)); 167 | rt_memset(telnet.password, 0, sizeof(telnet.password)); 168 | 169 | const char *format = "\r\nAuth failed!\r\n\r\nusername:"; 170 | send(telnet.client_fd, format, strlen(format), 0); 171 | } else { 172 | telnet.state = AGILE_TELNET_STATE_PROCESS; 173 | rt_base_t level = rt_hw_interrupt_disable(); 174 | rt_ringbuffer_reset(telnet.tx_rb); 175 | rt_hw_interrupt_enable(level); 176 | 177 | telnet.isconnected = 1; 178 | 179 | const char *format = "\r\nLogin Successful.\r\n"; 180 | send(telnet.client_fd, format, strlen(format), 0); 181 | } 182 | } 183 | } break; 184 | 185 | default: 186 | break; 187 | } 188 | } 189 | #endif 190 | 191 | /* telnet server thread entry */ 192 | static void telnet_thread(void *parameter) 193 | { 194 | #define RECV_BUF_LEN 64 195 | 196 | int enable = 1; 197 | int flags; 198 | struct sockaddr_in addr; 199 | rt_uint8_t recv_buf[RECV_BUF_LEN]; 200 | rt_tick_t client_tick_timeout = rt_tick_get(); 201 | 202 | // select使用 203 | fd_set readset, exceptset; 204 | // select超时时间 205 | struct timeval select_timeout; 206 | select_timeout.tv_sec = 10; 207 | select_timeout.tv_usec = 0; 208 | 209 | rt_thread_mdelay(5000); 210 | _telnet_start: 211 | telnet.server_fd = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP); 212 | if (telnet.server_fd < 0) 213 | goto _telnet_restart; 214 | 215 | if (setsockopt(telnet.server_fd, SOL_SOCKET, SO_REUSEADDR, (const void *)&enable, sizeof(enable)) < 0) 216 | goto _telnet_restart; 217 | 218 | rt_memset(&addr, 0, sizeof(addr)); 219 | addr.sin_family = AF_INET; 220 | addr.sin_port = htons(PKG_AGILE_TELNET_PORT); 221 | addr.sin_addr.s_addr = INADDR_ANY; 222 | if (bind(telnet.server_fd, (struct sockaddr *)&addr, sizeof(addr)) < 0) 223 | goto _telnet_restart; 224 | 225 | if (listen(telnet.server_fd, 1) < 0) 226 | goto _telnet_restart; 227 | 228 | flags = fcntl(telnet.server_fd, F_GETFL, 0); 229 | flags |= O_NONBLOCK; 230 | fcntl(telnet.server_fd, F_SETFL, flags); 231 | 232 | while (1) { 233 | FD_ZERO(&readset); 234 | FD_ZERO(&exceptset); 235 | 236 | FD_SET(telnet.server_fd, &readset); 237 | FD_SET(telnet.server_fd, &exceptset); 238 | 239 | int max_fd = telnet.server_fd; 240 | if (telnet.client_fd >= 0) { 241 | FD_SET(telnet.client_fd, &readset); 242 | FD_SET(telnet.client_fd, &exceptset); 243 | 244 | if (max_fd < telnet.client_fd) 245 | max_fd = telnet.client_fd; 246 | } 247 | if (telnet.isconnected) { 248 | FD_SET(telnet.tx_fd, &readset); 249 | 250 | if (max_fd < telnet.tx_fd) 251 | max_fd = telnet.tx_fd; 252 | } 253 | 254 | int rc = select(max_fd + 1, &readset, RT_NULL, &exceptset, &select_timeout); 255 | if (rc < 0) 256 | break; 257 | if (rc > 0) { 258 | //服务器事件 259 | if (FD_ISSET(telnet.server_fd, &exceptset)) 260 | break; 261 | 262 | if (FD_ISSET(telnet.server_fd, &readset)) { 263 | socklen_t addrlen = sizeof(struct sockaddr_in); 264 | int new_s = accept(telnet.server_fd, (struct sockaddr *)&addr, &addrlen); 265 | if (new_s < 0) 266 | break; 267 | 268 | if (telnet.client_fd >= 0) { 269 | telnet.isconnected = 0; 270 | close(telnet.client_fd); 271 | telnet.client_fd = -1; 272 | } 273 | 274 | int option = 1; 275 | setsockopt(new_s, IPPROTO_TCP, TCP_NODELAY, (const void *)&option, sizeof(int)); 276 | struct timeval tv; 277 | tv.tv_sec = 5; 278 | tv.tv_usec = 0; 279 | setsockopt(new_s, SOL_SOCKET, SO_SNDTIMEO, (const void *)&tv, sizeof(struct timeval)); 280 | 281 | telnet.client_fd = new_s; 282 | telnet.client_timeout = PKG_AGILE_TELNET_CLIENT_DEFAULT_TIMEOUT; 283 | client_tick_timeout = rt_tick_get() + rt_tick_from_millisecond(telnet.client_timeout * 60000); 284 | 285 | #ifndef PKG_AGILE_TELNET_USING_AUTH 286 | rt_base_t level = rt_hw_interrupt_disable(); 287 | rt_ringbuffer_reset(telnet.tx_rb); 288 | rt_hw_interrupt_enable(level); 289 | 290 | telnet.isconnected = 1; 291 | 292 | const char *format = "Login Successful.\r\n"; 293 | send(telnet.client_fd, format, strlen(format), 0); 294 | #else 295 | telnet.state = AGILE_TELNET_STATE_USER; 296 | rt_memset(telnet.username, 0, sizeof(telnet.username)); 297 | rt_memset(telnet.password, 0, sizeof(telnet.password)); 298 | 299 | const char *format = "\r\nusername:"; 300 | send(telnet.client_fd, format, strlen(format), 0); 301 | #endif 302 | 303 | continue; 304 | } 305 | 306 | // 客户端事件 307 | if (telnet.client_fd >= 0) { 308 | if (FD_ISSET(telnet.client_fd, &exceptset)) { 309 | telnet.isconnected = 0; 310 | close(telnet.client_fd); 311 | telnet.client_fd = -1; 312 | } else if (FD_ISSET(telnet.client_fd, &readset)) { 313 | int recv_len = recv(telnet.client_fd, recv_buf, RECV_BUF_LEN, MSG_DONTWAIT); 314 | if (recv_len <= 0) { 315 | telnet.isconnected = 0; 316 | close(telnet.client_fd); 317 | telnet.client_fd = -1; 318 | } else { 319 | #ifdef PKG_AGILE_TELNET_USING_AUTH 320 | telnet_client_process(recv_buf, recv_len); 321 | if (telnet.state == AGILE_TELNET_STATE_PROCESS) { 322 | #endif 323 | rt_base_t level = rt_hw_interrupt_disable(); 324 | rt_ringbuffer_put(telnet.rx_rb, recv_buf, recv_len); 325 | rt_hw_interrupt_enable(level); 326 | 327 | agile_console_wakeup(); 328 | #ifdef PKG_AGILE_TELNET_USING_AUTH 329 | } 330 | #endif 331 | 332 | client_tick_timeout = rt_tick_get() + rt_tick_from_millisecond(telnet.client_timeout * 60000); 333 | } 334 | } 335 | } 336 | 337 | if (telnet.isconnected && FD_ISSET(telnet.tx_fd, &readset)) { 338 | rt_uint8_t *send_ptr = RT_NULL; 339 | rt_base_t level = rt_hw_interrupt_disable(); 340 | int send_len = rt_ringbuffer_peak(telnet.tx_rb, &send_ptr); 341 | rt_hw_interrupt_enable(level); 342 | 343 | if (send_len > 0) { 344 | send(telnet.client_fd, send_ptr, send_len, 0); 345 | client_tick_timeout = rt_tick_get() + rt_tick_from_millisecond(telnet.client_timeout * 60000); 346 | } 347 | } 348 | } 349 | 350 | if (telnet.client_fd >= 0) { 351 | if ((rt_tick_get() - client_tick_timeout) < (RT_TICK_MAX / 2)) { 352 | telnet.isconnected = 0; 353 | close(telnet.client_fd); 354 | telnet.client_fd = -1; 355 | } 356 | } 357 | } 358 | 359 | _telnet_restart: 360 | telnet.isconnected = 0; 361 | if (telnet.server_fd >= 0) { 362 | close(telnet.server_fd); 363 | telnet.server_fd = -1; 364 | } 365 | if (telnet.client_fd >= 0) { 366 | close(telnet.client_fd); 367 | telnet.client_fd = -1; 368 | } 369 | 370 | rt_thread_mdelay(10000); 371 | goto _telnet_start; 372 | } 373 | 374 | static void telnet_backend_output(rt_device_t dev, const uint8_t *buf, int len) 375 | { 376 | if (telnet.isconnected == 0) 377 | return; 378 | 379 | int put_len = 0; 380 | 381 | rt_base_t level = rt_hw_interrupt_disable(); 382 | 383 | if (dev->open_flag & RT_DEVICE_FLAG_STREAM) { 384 | while (len > 0) { 385 | if (*buf == '\n') { 386 | if (rt_ringbuffer_putchar(telnet.tx_rb, '\r') == 0) 387 | break; 388 | } 389 | 390 | if (rt_ringbuffer_putchar(telnet.tx_rb, *buf) == 0) 391 | break; 392 | 393 | put_len++; 394 | ++buf; 395 | --len; 396 | } 397 | } else 398 | put_len = rt_ringbuffer_put(telnet.tx_rb, buf, len); 399 | 400 | rt_hw_interrupt_enable(level); 401 | 402 | if (put_len > 0) 403 | rt_wqueue_wakeup(&(telnet.tlnt_dev->wait_queue), (void *)POLLIN); 404 | } 405 | 406 | static int telnet_backend_read(rt_device_t dev, uint8_t *buf, int len) 407 | { 408 | if (telnet.isconnected == 0) 409 | return 0; 410 | 411 | rt_size_t result = 0; 412 | 413 | rt_base_t level = rt_hw_interrupt_disable(); 414 | result = rt_ringbuffer_get(telnet.rx_rb, buf, len); 415 | rt_hw_interrupt_enable(level); 416 | 417 | return result; 418 | } 419 | 420 | #if RT_VER_NUM >= 0x50001 421 | static int tlnt_fops_open(struct dfs_file *fd) 422 | #else 423 | static int tlnt_fops_open(struct dfs_fd *fd) 424 | #endif 425 | { 426 | #if RT_VER_NUM >= 0x50000 427 | rt_device_t device = (rt_device_t)fd->vnode->data; 428 | #else 429 | rt_device_t device = (rt_device_t)fd->data; 430 | #endif 431 | RT_ASSERT(device != RT_NULL); 432 | 433 | device->ref_count++; 434 | 435 | return 0; 436 | } 437 | 438 | #if RT_VER_NUM >= 0x50001 439 | static int tlnt_fops_poll(struct dfs_file *fd, struct rt_pollreq *req) 440 | #else 441 | static int tlnt_fops_poll(struct dfs_fd *fd, struct rt_pollreq *req) 442 | #endif 443 | { 444 | int mask = 0; 445 | #if RT_VER_NUM >= 0x50000 446 | rt_device_t device = (rt_device_t)fd->vnode->data; 447 | #else 448 | rt_device_t device = (rt_device_t)fd->data; 449 | #endif 450 | RT_ASSERT(device != RT_NULL); 451 | 452 | rt_poll_add(&(device->wait_queue), req); 453 | 454 | if (rt_ringbuffer_data_len(telnet.tx_rb) != 0) 455 | mask |= POLLIN; 456 | 457 | return mask; 458 | } 459 | 460 | static const struct dfs_file_ops tlnt_fops = 461 | { 462 | .open = tlnt_fops_open, 463 | .poll = tlnt_fops_poll, 464 | }; 465 | 466 | static int agile_telnet_init(void) 467 | { 468 | telnet.isconnected = 0; 469 | telnet.server_fd = -1; 470 | telnet.client_fd = -1; 471 | telnet.client_timeout = PKG_AGILE_TELNET_CLIENT_DEFAULT_TIMEOUT; 472 | telnet.tx_fd = -1; 473 | 474 | telnet.rx_rb = rt_ringbuffer_create(PKG_AGILE_TELNET_RX_BUFFER_SIZE); 475 | RT_ASSERT(telnet.rx_rb != RT_NULL); 476 | 477 | telnet.tx_rb = rt_ringbuffer_create(PKG_AGILE_TELNET_TX_BUFFER_SIZE); 478 | RT_ASSERT(telnet.tx_rb != RT_NULL); 479 | 480 | telnet.tlnt_dev = rt_malloc(sizeof(struct rt_device)); 481 | rt_memset(telnet.tlnt_dev, 0, sizeof(struct rt_device)); 482 | telnet.tlnt_dev->type = RT_Device_Class_Miscellaneous; 483 | rt_device_register(telnet.tlnt_dev, "tlnt", RT_DEVICE_FLAG_RDWR); 484 | telnet.tlnt_dev->fops = &tlnt_fops; 485 | 486 | telnet.tx_fd = open("/dev/tlnt", O_RDWR, 0); 487 | RT_ASSERT(telnet.tx_fd >= 0); 488 | 489 | rt_thread_t tid = rt_thread_create("telnet", telnet_thread, RT_NULL, PKG_AGILE_TELNET_THREAD_STACK_SIZE, 490 | PKG_AGILE_TELNET_THREAD_PRIORITY, 100); 491 | RT_ASSERT(tid != RT_NULL); 492 | rt_thread_startup(tid); 493 | 494 | telnet_backend.output = telnet_backend_output; 495 | telnet_backend.read = telnet_backend_read; 496 | 497 | agile_console_backend_register(&telnet_backend); 498 | 499 | return RT_EOK; 500 | } 501 | INIT_ENV_EXPORT(agile_telnet_init); 502 | 503 | #ifdef RT_USING_FINSH 504 | #ifdef FINSH_USING_MSH 505 | static int telnet_client_timeout(int argc, char **argv) 506 | { 507 | if (argc == 1) { 508 | rt_kprintf("telnet client timeout:%d min\r\n", telnet.client_timeout); 509 | } else if (argc == 2) { 510 | int timeout = atoi(argv[1]); 511 | if (timeout <= 0) { 512 | rt_kprintf("telnet client timeout must be greater than 0."); 513 | } else { 514 | telnet.client_timeout = timeout; 515 | rt_kprintf("set telnet client timeout success.\r\n"); 516 | } 517 | } else { 518 | rt_kprintf("Usage:\r\n"); 519 | rt_kprintf("telnet_client_timeout - get telnet client timeout\r\n"); 520 | rt_kprintf("telnet_client_timeout timeout - set telnet client timeout\r\n"); 521 | } 522 | 523 | return RT_EOK; 524 | } 525 | MSH_CMD_EXPORT_ALIAS(telnet_client_timeout, telnet_ctm, telnet client timeout); 526 | #endif /* FINSH_USING_MSH */ 527 | #endif /* RT_USING_FINSH */ 528 | 529 | #endif /* PKG_USING_AGILE_TELNET */ 530 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | (This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.) 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | {description} 474 | Copyright (C) {year} {fullname} 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | {signature of Ty Coon}, 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | --------------------------------------------------------------------------------