mmc.c revision 27c357db04350b75b0fceaae8bfb9ce99c50866b
180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli/* 280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * This program is free software; you can redistribute it and/or 380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * modify it under the terms of the GNU General Public 480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * License v2 as published by the Free Software Foundation. 580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * 680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * This program is distributed in the hope that it will be useful, 780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * but WITHOUT ANY WARRANTY; without even the implied warranty of 880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * General Public License for more details. 1080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * 1180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * You should have received a copy of the GNU General Public 1280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * License along with this program; if not, write to the 1380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * Free Software Foundation, Inc., 59 Temple Place - Suite 330, 1480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * Boston, MA 021110-1307, USA. 1580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * 1680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * (This code is based on btrfs-progs/btrfs.c.) 1780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli */ 1880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 1980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli#define _GNU_SOURCE 2080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli#include <stdio.h> 2180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli#include <stdlib.h> 2280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli#include <string.h> 2380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 2445541d55fa50e385894d22960f2526b6c7f68d52Chris Ball#include "mmc_cmds.h" 2545541d55fa50e385894d22960f2526b6c7f68d52Chris Ball 2680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli#define MMC_VERSION "0.1" 2780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 2880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli#define BASIC_HELP 0 2980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli#define ADVANCED_HELP 1 3080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 3180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncellitypedef int (*CommandFunction)(int argc, char **argv); 3280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 3380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncellistruct Command { 3480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli CommandFunction func; /* function which implements the command */ 3580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int nargs; /* if == 999, any number of arguments 3680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if >= 0, number of arguments, 3780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if < 0, _minimum_ number of arguments */ 3880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *verb; /* verb */ 3980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *help; /* help lines; from the 2nd line onward they 4080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli are automatically indented */ 4180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *adv_help; /* advanced help message; from the 2nd line 4280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli onward they are automatically indented */ 4380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 4480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli /* the following fields are run-time filled by the program */ 4580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char **cmds; /* array of subcommands */ 4680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int ncmds; /* number of subcommand */ 4780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli}; 4880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 4980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncellistatic struct Command commands[] = { 5080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli /* 5180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * avoid short commands different for the case only 5280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli */ 5345541d55fa50e385894d22960f2526b6c7f68d52Chris Ball { do_read_extcsd, -1, 5445541d55fa50e385894d22960f2526b6c7f68d52Chris Ball "extcsd read", "<device>\n" 5545541d55fa50e385894d22960f2526b6c7f68d52Chris Ball "Print extcsd data from <device>.", 5645541d55fa50e385894d22960f2526b6c7f68d52Chris Ball NULL 5745541d55fa50e385894d22960f2526b6c7f68d52Chris Ball }, 58b9c7a17fce190f085bb4eb6e6535a22e2c69de68Chris Ball { do_writeprotect_get, -1, 59b9c7a17fce190f085bb4eb6e6535a22e2c69de68Chris Ball "writeprotect get", "<device>\n" 60b9c7a17fce190f085bb4eb6e6535a22e2c69de68Chris Ball "Determine the eMMC writeprotect status of <device>.", 61b9c7a17fce190f085bb4eb6e6535a22e2c69de68Chris Ball NULL 62b9c7a17fce190f085bb4eb6e6535a22e2c69de68Chris Ball }, 63b9c7a17fce190f085bb4eb6e6535a22e2c69de68Chris Ball { do_writeprotect_set, -1, 64b9c7a17fce190f085bb4eb6e6535a22e2c69de68Chris Ball "writeprotect set", "<device>\n" 656599780fda6ef3caf5927deb3036f1b646605008Chris Ball "Set the eMMC writeprotect status of <device>.\nThis sets the eMMC to be write-protected until next boot.", 6645541d55fa50e385894d22960f2526b6c7f68d52Chris Ball NULL 6745541d55fa50e385894d22960f2526b6c7f68d52Chris Ball }, 68b7e2599c67408c38e57e91d2426c077a4541dc8cSaugata Das { do_disable_512B_emulation, -1, 69b7e2599c67408c38e57e91d2426c077a4541dc8cSaugata Das "disable 512B emulation", "<device>\n" 706599780fda6ef3caf5927deb3036f1b646605008Chris Ball "Set the eMMC data sector size to 4KB by disabling emulation on\n<device>.", 71b7e2599c67408c38e57e91d2426c077a4541dc8cSaugata Das NULL 72b7e2599c67408c38e57e91d2426c077a4541dc8cSaugata Das }, 7327c357db04350b75b0fceaae8bfb9ce99c50866bBen Gardiner { do_status_get, -1, 7427c357db04350b75b0fceaae8bfb9ce99c50866bBen Gardiner "status get", "<device>\n" 7527c357db04350b75b0fceaae8bfb9ce99c50866bBen Gardiner "Print the response to STATUS_SEND (CMD13).", 7627c357db04350b75b0fceaae8bfb9ce99c50866bBen Gardiner NULL 7727c357db04350b75b0fceaae8bfb9ce99c50866bBen Gardiner }, 787bd1320b2cb38f040ab5cf017d17e283496690bfGiuseppe CAVALLARO { do_write_boot_en, -3, 797bd1320b2cb38f040ab5cf017d17e283496690bfGiuseppe CAVALLARO "bootpart enable", "<boot_partition> " "<send_ack> " "<device>\n" 807bd1320b2cb38f040ab5cf017d17e283496690bfGiuseppe CAVALLARO "Enable the boot partition for the <device>.\nTo receive acknowledgment of boot from the card set <send_ack>\nto 1, else set it to 0.", 817bd1320b2cb38f040ab5cf017d17e283496690bfGiuseppe CAVALLARO NULL 827bd1320b2cb38f040ab5cf017d17e283496690bfGiuseppe CAVALLARO }, 838649651b743a5d7c290ea0f8058794f8d127736eJaehoon Chung { do_write_bkops_en, -1, 848649651b743a5d7c290ea0f8058794f8d127736eJaehoon Chung "bkops enable", "<device>\n" 858649651b743a5d7c290ea0f8058794f8d127736eJaehoon Chung "Enable the eMMC BKOPS feature on <device>.\nNOTE! This is a one-time programmable (unreversible) change.", 868649651b743a5d7c290ea0f8058794f8d127736eJaehoon Chung NULL 878649651b743a5d7c290ea0f8058794f8d127736eJaehoon Chung }, 88f74dfe23cd00894aa9f235374468e05acb793e17Chris Ball { do_hwreset_en, -1, 89f74dfe23cd00894aa9f235374468e05acb793e17Chris Ball "hwreset enable", "<device>\n" 90f74dfe23cd00894aa9f235374468e05acb793e17Chris Ball "Permanently enable the eMMC H/W Reset feature on <device>.\nNOTE! This is a one-time programmable (unreversible) change.", 91f74dfe23cd00894aa9f235374468e05acb793e17Chris Ball NULL 92f74dfe23cd00894aa9f235374468e05acb793e17Chris Ball }, 93f74dfe23cd00894aa9f235374468e05acb793e17Chris Ball { do_hwreset_dis, -1, 94f74dfe23cd00894aa9f235374468e05acb793e17Chris Ball "hwreset disable", "<device>\n" 95f74dfe23cd00894aa9f235374468e05acb793e17Chris Ball "Permanently disable the eMMC H/W Reset feature on <device>.\nNOTE! This is a one-time programmable (unreversible) change.", 96f74dfe23cd00894aa9f235374468e05acb793e17Chris Ball NULL 97f74dfe23cd00894aa9f235374468e05acb793e17Chris Ball }, 9821bb473fc58366b872efe31e1da7831cad4b92faYaniv Gardi { do_sanitize, -1, 9921bb473fc58366b872efe31e1da7831cad4b92faYaniv Gardi "sanitize", "<device>\n" 10021bb473fc58366b872efe31e1da7831cad4b92faYaniv Gardi "Send Sanitize command to the <device>.\nThis will delete the unmapped memory region of the device.", 10121bb473fc58366b872efe31e1da7831cad4b92faYaniv Gardi NULL 10221bb473fc58366b872efe31e1da7831cad4b92faYaniv Gardi }, 10380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli { 0, 0, 0, 0 } 10480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli}; 10580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 10680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncellistatic char *get_prgname(char *programname) 10780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli{ 10880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *np; 10980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli np = strrchr(programname,'/'); 11080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(!np) 11180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli np = programname; 11280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli else 11380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli np++; 11480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 11580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return np; 11680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli} 11780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 11880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncellistatic void print_help(char *programname, struct Command *cmd, int helptype) 11980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli{ 12080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *pc; 12180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 12280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli printf("\t%s %s ", programname, cmd->verb ); 12380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 12480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if (helptype == ADVANCED_HELP && cmd->adv_help) 12580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for(pc = cmd->adv_help; *pc; pc++){ 12680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli putchar(*pc); 12780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(*pc == '\n') 12880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli printf("\t\t"); 12980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 13080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli else 13180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for(pc = cmd->help; *pc; pc++){ 13280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli putchar(*pc); 13380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(*pc == '\n') 13480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli printf("\t\t"); 13580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 13680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 13780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli putchar('\n'); 13880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli} 13980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 14080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncellistatic void help(char *np) 14180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli{ 14280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli struct Command *cp; 14380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 14480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli printf("Usage:\n"); 14580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for( cp = commands; cp->verb; cp++ ) 14680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli print_help(np, cp, BASIC_HELP); 14780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 14880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli printf("\n\t%s help|--help|-h\n\t\tShow the help.\n",np); 14980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli printf("\n\t%s <cmd> --help\n\t\tShow detailed help for a command or subset of commands.\n",np); 15080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli printf("\n%s\n", MMC_VERSION); 15180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli} 15280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 15380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncellistatic int split_command(char *cmd, char ***commands) 15480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli{ 15580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int c, l; 15680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *p, *s; 15780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 15880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for( *commands = 0, l = c = 0, p = s = cmd ; ; p++, l++ ){ 15980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if ( *p && *p != ' ' ) 16080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli continue; 16180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 16280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli /* c + 2 so that we have room for the null */ 16380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli (*commands) = realloc( (*commands), sizeof(char *)*(c + 2)); 16480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli (*commands)[c] = strndup(s, l); 16580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli c++; 16680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli l = 0; 16780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli s = p+1; 16880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( !*p ) break; 16980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 17080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 17180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli (*commands)[c] = 0; 17280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return c; 17380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli} 17480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 17580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli/* 17680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli This function checks if the passed command is ambiguous 17780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli*/ 17880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncellistatic int check_ambiguity(struct Command *cmd, char **argv){ 17980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int i; 18080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli struct Command *cp; 18180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli /* check for ambiguity */ 18280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for( i = 0 ; i < cmd->ncmds ; i++ ){ 18380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int match; 18480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for( match = 0, cp = commands; cp->verb; cp++ ){ 18580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int j, skip; 18680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *s1, *s2; 18780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 18880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( cp->ncmds < i ) 18980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli continue; 19080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 19180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for( skip = 0, j = 0 ; j < i ; j++ ) 19280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( strcmp(cmd->cmds[j], cp->cmds[j])){ 19380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli skip=1; 19480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli break; 19580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 19680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(skip) 19780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli continue; 19880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 19980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( !strcmp(cmd->cmds[i], cp->cmds[i])) 20080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli continue; 20180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for(s2 = cp->cmds[i], s1 = argv[i+1]; 20280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli *s1 == *s2 && *s1; s1++, s2++ ) ; 20380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( !*s1 ) 20480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli match++; 20580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 20680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(match){ 20780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int j; 20880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli fprintf(stderr, "ERROR: in command '"); 20980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for( j = 0 ; j <= i ; j++ ) 21080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli fprintf(stderr, "%s%s",j?" ":"", argv[j+1]); 21180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli fprintf(stderr, "', '%s' is ambiguous\n",argv[j]); 21280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return -2; 21380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 21480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 21580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return 0; 21680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli} 21780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 21880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli/* 21980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * This function, compacts the program name and the command in the first 22080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli * element of the '*av' array 22180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli */ 22280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncellistatic int prepare_args(int *ac, char ***av, char *prgname, struct Command *cmd ){ 22380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 22480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char **ret; 22580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int i; 22680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *newname; 22780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 22880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli ret = (char **)malloc(sizeof(char*)*(*ac+1)); 22980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli newname = (char*)malloc(strlen(prgname)+strlen(cmd->verb)+2); 23080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( !ret || !newname ){ 23180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli free(ret); 23280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli free(newname); 23380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return -1; 23480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 23580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 23680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli ret[0] = newname; 23780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for(i=0; i < *ac ; i++ ) 23880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli ret[i+1] = (*av)[i]; 23980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 24080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli strcpy(newname, prgname); 24180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli strcat(newname, " "); 24280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli strcat(newname, cmd->verb); 24380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 24480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli (*ac)++; 24580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli *av = ret; 24680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 24780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return 0; 24880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 24980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli} 25080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 25180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli/* 25280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli This function performs the following jobs: 25380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli - show the help if '--help' or 'help' or '-h' are passed 25480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli - verify that a command is not ambiguous, otherwise show which 25580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli part of the command is ambiguous 25680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli - if after a (even partial) command there is '--help' show detailed help 25780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for all the matching commands 25880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli - if the command doesn't match show an error 25980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli - finally, if a command matches, they return which command matched and 26080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli the arguments 26180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 26280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli The function return 0 in case of help is requested; <0 in case 26380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli of uncorrect command; >0 in case of matching commands 26480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli argc, argv are the arg-counter and arg-vector (input) 26580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli *nargs_ is the number of the arguments after the command (output) 26680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli **cmd_ is the invoked command (output) 26780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli ***args_ are the arguments after the command 26880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 26980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli*/ 27080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncellistatic int parse_args(int argc, char **argv, 27180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli CommandFunction *func_, 27280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int *nargs_, char **cmd_, char ***args_ ) 27380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli{ 27480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli struct Command *cp; 27580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli struct Command *matchcmd=0; 27680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *prgname = get_prgname(argv[0]); 27780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int i=0, helprequested=0; 27880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 27980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( argc < 2 || !strcmp(argv[1], "help") || 28080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli !strcmp(argv[1], "-h") || !strcmp(argv[1], "--help")){ 28180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli help(prgname); 28280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return 0; 28380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 28480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 28580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for( cp = commands; cp->verb; cp++ ) 28680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( !cp->ncmds) 28780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli cp->ncmds = split_command(cp->verb, &(cp->cmds)); 28880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 28980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for( cp = commands; cp->verb; cp++ ){ 29080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int match; 29180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 29280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( argc-1 < cp->ncmds ) 29380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli continue; 29480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for( match = 1, i = 0 ; i < cp->ncmds ; i++ ){ 29580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *s1, *s2; 29680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli s1 = cp->cmds[i]; 29780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli s2 = argv[i+1]; 29880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 29980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli for(s2 = cp->cmds[i], s1 = argv[i+1]; 30080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli *s1 == *s2 && *s1; 30180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli s1++, s2++ ) ; 30280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( *s1 ){ 30380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli match=0; 30480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli break; 30580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 30680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 30780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 30880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli /* If you understand why this code works ... 30980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli you are a genious !! */ 31080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(argc>i+1 && !strcmp(argv[i+1],"--help")){ 31180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(!helprequested) 31280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli printf("Usage:\n"); 31380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli print_help(prgname, cp, ADVANCED_HELP); 31480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli helprequested=1; 31580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli continue; 31680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 31780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 31880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(!match) 31980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli continue; 32080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 32180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli matchcmd = cp; 32280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli *nargs_ = argc-matchcmd->ncmds-1; 32380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli *cmd_ = matchcmd->verb; 32480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli *args_ = argv+matchcmd->ncmds+1; 32580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli *func_ = cp->func; 32680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 32780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli break; 32880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 32980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 33080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(helprequested){ 33180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli printf("\n%s\n", MMC_VERSION); 33280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return 0; 33380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 33480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 33580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(!matchcmd){ 33680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli fprintf( stderr, "ERROR: unknown command '%s'\n",argv[1]); 33780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli help(prgname); 33880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return -1; 33980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 34080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 34180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(check_ambiguity(matchcmd, argv)) 34280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return -2; 34380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 34480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli /* check the number of argument */ 34580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if (matchcmd->nargs < 0 && matchcmd->nargs < -*nargs_ ){ 34680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli fprintf(stderr, "ERROR: '%s' requires minimum %d arg(s)\n", 34780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli matchcmd->verb, -matchcmd->nargs); 34880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return -2; 34980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 35080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if(matchcmd->nargs >= 0 && matchcmd->nargs != *nargs_ && matchcmd->nargs != 999){ 35180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli fprintf(stderr, "ERROR: '%s' requires %d arg(s)\n", 35280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli matchcmd->verb, matchcmd->nargs); 35380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return -2; 35480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 35580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 35680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if (prepare_args( nargs_, args_, prgname, matchcmd )){ 35780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli fprintf(stderr, "ERROR: not enough memory\\n"); 35880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return -20; 35980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 36080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 36180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 36280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli return 1; 36380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli} 36480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelliint main(int ac, char **av ) 36580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli{ 36680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli char *cmd=0, **args=0; 36780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli int nargs=0, r; 36880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli CommandFunction func=0; 36980d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 37080d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli r = parse_args(ac, av, &func, &nargs, &cmd, &args); 37180d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli if( r <= 0 ){ 37280d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli /* error or no command to parse*/ 37380d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli exit(-r); 37480d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli } 37580d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 37680d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli exit(func(nargs, args)); 37780d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli} 37880d2660fa95615f3bc77a9b258414f2c533175cGoffredo Baroncelli 379