Keil Logo

Technical Support

On-Line Manuals

RL-ARM User's Guide (MDK v4)

RL-RTX RL-FlashFS RL-TCPnet RL-CAN RL-USB Example Programs Library Reference Data Types BIT BOOL CAN_ERROR CAN_msg CDC_LINE_CODING DCACHE FAT_VI FATINFO FCACHE FILE FINFO CID_REG FATVAR Media_INFO OS_ID RL_TIME S8 S16 S32 S64 U8 U16 U32 U64 Include Files can_cfg.h file_config.h net_config.h rtl.h rtx_can.h rtx_config.h stdio.h Reference _alloc_box _calloc_box _declare_box _declare_box8 _free_box _init_box _init_box8 accept ADC_IF_GetRequest ADC_IF_SetRequest arp_cache_ip arp_cache_mac arp_get_info bind CAN_init CAN_receive CAN_request CAN_rx_object CAN_send CAN_set CAN_start CAN_tx_object cgi_func cgi_process_data cgi_process_var cgx_content_type closesocket cls.config cls.get_last_error cls.init cls.unconfig cls.uninit com_getchar com_putchar com_tx_active connect dhcp_cbfunc dhcp_disable efs.EraseChip efs.EraseSector efs.Init efs.ProgramPage efs.ReadData efs.UnInit fanalyse fat.DeviceCtrl fat.Init fat.ReadInfo fat.ReadSect fat.UnInit fat.WriteSect fattrib fcheck fclose fdefrag fdelete feof ferror ffind fflush fformat ffree fgetc fgets finit FIQ_Handler fopen fprintf fputc fputs fread frename fs_get_date fs_get_time fscanf fseek ftell ftp_accept_host ftp_check_account ftp_evt_notify ftp_fclose ftp_fdelete ftp_ffind ftp_file_access ftp_fopen ftp_fread ftp_frename ftp_fwrite ftp_get_user_id ftpc_cbfunc ftpc_connect ftpc_fclose ftpc_fopen ftpc_fread ftpc_fwrite funinit fvol fwrite get_host_by_name gethostbyname getpeername getsockname HID_GetReport HID_SetReport http_accept_host http_check_account http_date http_fclose http_fgets http_file_access http_finfo http_fopen http_fread http_get_content_type http_get_info http_get_lang http_get_session http_get_user_id http_get_var icmp_ping igmp_join igmp_leave init_ethernet init_serial init_TcpNet int_disable_eth int_enable_eth interrupt_ethernet ioc_getcb ioc_init ioc_read_info ioc_read_sect ioc_uninit ioc_write_sect ioctlsocket isr_evt_set isr_mbx_check isr_mbx_receive isr_mbx_send isr_sem_send isr_tsk_get listen main_TcpNet mci.BusMode mci.BusSpeed mci.BusWidth mci.CheckMedia mci.Command mci.Delay mci.Init mci.ReadBlock mci.SetDma mci.UnInit mci.WriteBlock modem_dial modem_hangup modem_init modem_listen modem_online modem_process modem_run MSC_Inquiry MSC_MemoryRead MSC_MemoryVerify MSC_MemoryWrite nand.BlockErase nand.Init nand.PageRead nand.PageWrite nand.UnInit os_dly_wait os_evt_clr os_evt_get os_evt_set os_evt_wait_and os_evt_wait_or os_itv_set os_itv_wait os_mbx_check os_mbx_declare os_mbx_init os_mbx_send os_mbx_wait os_mut_init os_mut_release os_mut_wait os_resume os_sem_init os_sem_send os_sem_wait os_suspend os_sys_init os_sys_init_prio os_sys_init_user OS_Tick_Handler os_tick_init os_tick_irqack os_time_get os_tmr_call os_tmr_create os_tmr_kill os_tsk_create os_tsk_create_ex os_tsk_create_user os_tsk_create_user_ex os_tsk_delete os_tsk_delete_self os_tsk_pass os_tsk_prio os_tsk_prio_self os_tsk_self poll_ethernet ppp_close ppp_connect ppp_is_up ppp_listen recv recvfrom rewind send send_frame sendto slip_close slip_connect slip_is_up slip_listen smtp_accept_auth smtp_cbfunc smtp_connect snmp_set_community snmp_trap sntp_get_time socket spi.BusSpeed spi.CheckMedia spi.Init spi.RecBuf spi.Send spi.SendBuf spi.SetSS spi.UnInit tcp_abort tcp_check_send tcp_close tcp_connect tcp_get_buf tcp_get_socket tcp_get_state tcp_listen tcp_max_dsize tcp_release_socket tcp_reset_window tcp_send tftp_accept_host tftp_fclose tftp_fopen tftp_fread tftp_fwrite tftpc_fclose tftpc_fopen tftpc_fread tftpc_fwrite tftpc_get tftpc_put timer_tick tnet_accept_host tnet_cbfunc tnet_ccmp tnet_check_account tnet_get_info tnet_get_user_id tnet_msg_poll tnet_process_cmd tnet_set_delay tsk_lock tsk_unlock udp_close udp_get_buf udp_get_socket udp_mcast_ttl udp_open udp_release_socket udp_send ungetc USB_Core USB_Device USB_EndPoint0 USB_EndPointNumber USB_IRQHandler USB_ISR USB_ReadEP USB_TaskInit USB_WriteEP usbd_adc_init USBD_CDC_ACM_DataAvailable USBD_CDC_ACM_DataRead USBD_CDC_ACM_DataSend USBD_CDC_ACM_GetChar USBD_CDC_ACM_Notify USBD_CDC_ACM_PortGetLineCoding USBD_CDC_ACM_PortInitialize USBD_CDC_ACM_PortReset USBD_CDC_ACM_PortSetControlLineState USBD_CDC_ACM_PortSetLineCoding USBD_CDC_ACM_PortUninitialize USBD_CDC_ACM_PutChar usbd_cdc_init usbd_cdc_ser_availchar usbd_cdc_ser_closeport usbd_cdc_ser_initport usbd_cdc_ser_linestate usbd_cdc_ser_openport usbd_cdc_ser_read usbd_cdc_ser_write usbd_cls_dev_req usbd_cls_ep_req usbd_cls_if_req usbd_cls_init usbd_cls_sof usbd_configured usbd_connect usbd_hid_get_protocol usbd_hid_get_report usbd_hid_get_report_trigger usbd_hid_init usbd_hid_set_protocol usbd_hid_set_report usbd_init usbd_msc_init usbd_msc_read_sect usbd_msc_start_stop usbd_msc_write_sect usbd_reset_core usbd_vcom_chkserstate usbd_vcom_serial2usb usbd_vcom_usb2serial usbh_ehci_hw_delay_ms usbh_ehci_hw_get_capabilities usbh_ehci_hw_init usbh_ehci_hw_irq_en usbh_ehci_hw_pins_config usbh_ehci_hw_port_power usbh_ehci_hw_reg_rd usbh_ehci_hw_reg_wr usbh_engine usbh_engine_all usbh_get_error_string usbh_get_last_error usbh_hid_data_in usbh_hid_data_in_callback usbh_hid_data_out usbh_hid_get_last_error usbh_hid_kbd_getkey usbh_hid_mouse_getdata usbh_hid_parse_report_desc usbh_hid_status usbh_hw_delay_ms usbh_hw_ep_add usbh_hw_ep_config usbh_hw_ep_remove usbh_hw_get_capabilities usbh_hw_get_connect usbh_hw_get_speed usbh_hw_init usbh_hw_pins_config usbh_hw_port_power usbh_hw_port_reset usbh_hw_urb_cancel usbh_hw_urb_submit usbh_init usbh_init_all usbh_mem_alloc usbh_mem_free usbh_mem_init usbh_msc_get_last_error usbh_msc_read usbh_msc_read_config usbh_msc_status usbh_msc_write usbh_ohci_hw_delay_ms usbh_ohci_hw_get_capabilities usbh_ohci_hw_init usbh_ohci_hw_irq_en usbh_ohci_hw_pins_config usbh_ohci_hw_port_power usbh_ohci_hw_reg_rd usbh_ohci_hw_reg_wr usbh_transfer usbh_uninit usbh_uninit_all Library Files Appendix


#include <net_config.h>

U16 cgi_func (
    U8*  env,       /* Pointer to input string from a TCPnet script. */
    U8*  buf,       /* Location where to write the HTTP response string. */
    U16  buflen,    /* Number of bytes in the output buffer. */
    U32* pcgi );    /* Pointer to a storage variable. */

The cgi_func function is what the TCPnet script interpreter calls, when interpreting the TCPnet script, to output the dynamic part of the HTTP response. The script interpreter calls cgi_func for each line in the script that begins with the command c. You must customize the cgi_func function so that it can understand and use the input string from the TCPnet script.

The argument env is a pointer to the input string that cgi_func uses to create the dynamic response. It is the same string of bytes that is specified in the TCPnet script code using the c command.

The argument buf is a pointer to the output buffer where the cgi_func function must write the HTTP response.

The argument buflen specifies the length of the output buffer in bytes.

The argument pcgi is a pointer to a variable that never gets altered by the HTTP Server. Hence, you can use it to store parameters for successive calls of the cgi_func function. You might use this to store:

  • loop counters
  • number of sent bytes
  • pointer to a local status buffer.

The cgi_func function is in the HTTP_CGI.c module. The prototype is defined in net_config.h.


  • The contents written by the cgi_func function, into the output buffer, must be HTML code.
  • c is a command that is available in the TCPnet scripting language.
  • The length of the output buffer, buflen, might vary because buffer length is determined by the TCP socket Maximum Segment Size (MSS) negotiation. The buffer length is normally around 1400 bytes for local LAN. But this can be reduced to 500 bytes or even less.
  • The length of the output buffer, buflen also varies because the HTTP Server tries to optimize number of generated TCP packets. It calls this function again to use the complete buffer available. It stops when there is only 240 or less bytes freee in the buffer. Then the packet is generated and transmitted. If you want to force the HTTP Server to transmit the packet, return value from this function shall be or-ed with 0x4000.
  • If the cgi_func function writes more bytes than buflen into the output buffer, then a system crash resulting from corruption of memory link pointers is highly likely.
  • The input string env might contain single-character subcommands to tell the cgi_func function how to process the script line correctly. There is no rule for these subcommands, so you can create and use your own commands.
  • The argument pcgi is private to each HTTP Session. The HTTP Server clears the data in the pcgi pointer, to 0, before the cgi_func function is called for the first time in each session.
  • The cgi_func function must update the contents in pcgi for each call. You can use the 4 bytes in pcgi to store data in any format.
Return Value

The cgi_func function returns the number of bytes written to the output buffer and writes the repeat flag value in the most significant bit of the return value.

If the return value's most significant bit is set to 1 (return value or-ed with 0x8000), the TCPnet script interpreter calls the cgi_func function again with the same values for the arguments env, buflen, and pcgi, which holds the same content as previously set. The argument buf is adjusted according to the number of bytes that were written to the output buffer.

If the return value's second most significant bit is set to 1 (return value or-ed with 0x4000), the packet optimization is canceled and the current packet is transmitted immediatelly.

See Also

cgi_process_data, cgi_process_var, http_get_lang, http_get_user_id

U16 cgi_func (U8 *env, U8 *buf, U16 buflen, U32 *pcgi) {
  U16 len = 0;

  switch (env[0]) {
    /* Analyze the environment string. It is the script 'c' line starting */
    /* at position 2. What you write to the script file is returned here. */
    case 'a' :
      /* Network parameters - file 'network.cgi' */

    case 'b':
      /* LED control - file 'led.cgi' */

    case 'c':
      /* TCP status - file 'tcp.cgi' */

    case 'd':
      /* System password - file 'system.cgi' */
      switch (env[2]) {
        case '1':
          len = sprintf(buf,&env[4],http_EnAuth ? "Enabled" : "Disabled");
        case '2':
          len = sprintf(buf,&env[4],http_auth_passw);
  return (len);
  Arm logo
Important information

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies.

Change Settings

Privacy Policy Update

Arm’s Privacy Policy has been updated. By continuing to use our site, you consent to Arm’s Privacy Policy. Please review our Privacy Policy to learn more about our collection, use and transfers
of your data.